SQ_GetAgentCustomStatusMapping

POST

https://api.voximplant.com/platform_api/SQ_GetAgentCustomStatusMapping

POST

/platform_api/SQ_GetAgentCustomStatusMapping

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

200Example 1

{
  "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.

Query parameters

application_idintegerOptional

Application ID

Response

Successful response

sq_status_namestringOptional

Status name

custom_status_namestringOptional

Custom status name

resultlist of objectsOptional