API reference

Carrier agent extensions

Manage agent extensions at the carrier level — provision, update status, list, and delete.

Agent extension resource

AgentExtensionjson

{
  "data": {
    "id": "AE…",
    "type": "agent_extension",
    "attributes": {
      "account_id": "AC…",
      "extension": "1001",
      "username": "agent-1001",
      "agent_name": "Adaeze",
      "status": "offline",
      "created_at": "…"
    }
  }
}

Create an extension

POST/carrier/v1/accounts/{account_id}/agent_extensions

Parameter	Type	Description
`data.type` required	`string`	`agent_extension`
`data.attributes.agent_name` required	`string`	Agent's name.
`data.attributes.extension` optional	`string`	Optional explicit extension number.

List extensions

GET/carrier/v1/accounts/{account_id}/agent_extensions

Return an account's extensions.

Fetch an extension

GET/carrier/v1/accounts/{account_id}/agent_extensions/{id}

Return a single extension.

Update an extension

PATCH/carrier/v1/accounts/{account_id}/agent_extensions/{id}

Update the agent name or status.

Parameter	Type	Description
`data.type` required	`string`	`agent_extension`
`data.id` required	`string`	The extension ID.
`data.attributes.agent_name` optional	`string`	Agent's name.
`data.attributes.status` optional	`string`	`online`, `offline`, `busy`, `away`, `dnd`.

Delete an extension

DELETE/carrier/v1/accounts/{account_id}/agent_extensions/{id}

Permanently delete the extension. The agent can no longer register or receive calls.

For credentials and browser registration, see the Twilio-style agent extensions API and the WebRTC softphone guide.