SQ_GetAgentCustomStatusMapping | Voximplant Voice AI

curl -X POST https://api.voximplant.com/platform_api/SQ_GetAgentCustomStatusMapping \
     -H "Authorization: Bearer <token>"

{
  "result": [
    {
      "custom_status_name": "Not available",
      "sq_status_name": "OFFLINE"
    },
    {
      "sq_status_name": "ONLINE"
    },
    {
      "sq_status_name": "READY"
    },
    {
      "sq_status_name": "DIALING"
    },
    {
      "sq_status_name": "IN_SERVICE"
    },
    {
      "sq_status_name": "AFTER_SERVICE"
    },
    {
      "custom_status_name": "Out of place",
      "sq_status_name": "DND"
    },
    {
      "sq_status_name": "BANNED"
    },
    {
      "custom_status_name": "First custom status",
      "sq_status_name": "CUSTOM_1"
    },
    {
      "sq_status_name": "CUSTOM_2"
    },
    {
      "sq_status_name": "CUSTOM_3"
    },
    {
      "sq_status_name": "CUSTOM_4"
    },
    {
      "sq_status_name": "CUSTOM_5"
    },
    {
      "sq_status_name": "CUSTOM_6"
    },
    {
      "sq_status_name": "CUSTOM_7"
    },
    {
      "sq_status_name": "CUSTOM_8"
    },
    {
      "sq_status_name": "CUSTOM_9"
    },
    {
      "sq_status_name": "CUSTOM_10"
    }
  ]
}

Returns the mapping list of SQ statuses and custom statuses. SQ statuses are returned whether they have mappings to custom statuses.

Example request: Get the status mappings.

Authentication

AuthorizationBearer

Voximplant Management API uses signed JWT tokens generated from your service-account private key. Pass the token in the Authorization header as a Bearer value:

Authorization: Bearer $VOXIMPLANT_TOKEN

See Authorization for ready-to-copy snippets in bash, Python, Node.js and Go that turn your credentials.json into a token.

Voximplant Management API uses signed JWT tokens generated from your service-account private key. Pass the token in the `Authorization` header as a Bearer value: ``` Authorization: Bearer $VOXIMPLANT_TOKEN ``` See [Authorization](/api-reference/management-api/authorization) for ready-to-copy snippets in bash, Python, Node.js and Go that turn your `credentials.json` into a token.

Query parameters

application_idintegerOptional

Application ID

Response

Successful response

sq_status_namestring

Status name

custom_status_namestring

Custom status name

resultlist of objects

1	{
2	"result": [
3	{
4	"custom_status_name": "Not available",
5	"sq_status_name": "OFFLINE"
6	},
7	{
8	"sq_status_name": "ONLINE"
9	},
10	{
11	"sq_status_name": "READY"
12	},
13	{
14	"sq_status_name": "DIALING"
15	},
16	{
17	"sq_status_name": "IN_SERVICE"
18	},
19	{
20	"sq_status_name": "AFTER_SERVICE"
21	},
22	{
23	"custom_status_name": "Out of place",
24	"sq_status_name": "DND"
25	},
26	{
27	"sq_status_name": "BANNED"
28	},
29	{
30	"custom_status_name": "First custom status",
31	"sq_status_name": "CUSTOM_1"
32	},
33	{
34	"sq_status_name": "CUSTOM_2"
35	},
36	{
37	"sq_status_name": "CUSTOM_3"
38	},
39	{
40	"sq_status_name": "CUSTOM_4"
41	},
42	{
43	"sq_status_name": "CUSTOM_5"
44	},
45	{
46	"sq_status_name": "CUSTOM_6"
47	},
48	{
49	"sq_status_name": "CUSTOM_7"
50	},
51	{
52	"sq_status_name": "CUSTOM_8"
53	},
54	{
55	"sq_status_name": "CUSTOM_9"
56	},
57	{
58	"sq_status_name": "CUSTOM_10"
59	}
60	]
61	}