For AI agents: markdown of this page — /docs-content-en/entities/call-lists/statuses.md documentation index — /llms.txt

Participant statuses

GET /v1/call-lists/statuses

Returns the reference list of call-list participant statuses, used to turn a participant's status code into a human-readable name.

Examples

curl — personal key

Terminal 
curl "https://vibecode.bitrix24.com/v1/call-lists/statuses" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl "https://vibecode.bitrix24.com/v1/call-lists/statuses" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/call-lists/statuses', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
const statusNames = Object.fromEntries(data.map((s) => [s.statusId, s.name]))
console.log(statusNames.IN_WORK)

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/call-lists/statuses', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data } = await res.json()
const statusNames = Object.fromEntries(data.map((s) => [s.statusId, s.name]))

Response fields

Field Type Description
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata Typearray DescriptionParticipant statuses
Fielddata[].id Typenumber DescriptionInternal number of the reference record. Not used to match a participant — use statusId for that
Fielddata[].statusId Typestring DescriptionStatus code: IN_WORK, SUCCESS, WRONG_NUMBER, STOP_CALLING. Matches the participant's status field from GET /v1/call-lists/:id/items
Fielddata[].name Typestring DescriptionHuman-readable status name, for example "In progress". Do not use it to match a participant
Fielddata[].sort Typenumber DescriptionStatus order in the list, ascending

Response example

JSON 
{
  "success": true,
  "data": [
    {
      "id": 61,
      "name": "In progress",
      "sort": 10,
      "statusId": "IN_WORK"
    },
    {
      "id": 63,
      "name": "Successful",
      "sort": 20,
      "statusId": "SUCCESS"
    },
    {
      "id": 65,
      "name": "Wrong number",
      "sort": 30,
      "statusId": "WRONG_NUMBER"
    },
    {
      "id": 67,
      "name": "Do not call again",
      "sort": 40,
      "statusId": "STOP_CALLING"
    }
  ]
}

Error response example

400 — a query parameter is passed, but the method accepts none:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "This operation has no query parameters"
  }
}

Errors

HTTP Code Description
HTTP400 CodeINVALID_PARAMS DescriptionA query string parameter is passed. The method accepts none
HTTP422 CodeBITRIX_ERROR DescriptionBitrix24 rejected the request. The reason is in message
HTTP502 CodeBITRIX_RESPONSE_INVALID DescriptionBitrix24 returned a response that could not be parsed
HTTP403 CodeSCOPE_DENIED DescriptionThe key lacks the crm scope
HTTP401 CodeTOKEN_MISSING DescriptionThe key has no Bitrix24 tokens configured
HTTP401 CodeMISSING_API_KEY DescriptionThe X-Api-Key header is not passed

Full list of common API errors: Errors.

Known specifics

The reference list is shared by all call lists of the Bitrix24 account. One call returns status names for participants of any list.

See also