Agent

Update an agent's addresses

Changed on

Update an agent's addresses and return updated details. The list replaces the stored addresses. The extension target is the extension id (UUID) and it is stored in the canonical form (lowercase, hyphenated). A tel address must contain at least one digit. An extension can only be assigned by a customer admin or manager, through this endpoint or when creating the agent with POST /agents.

put/agents/{id}/addresses

Request

  • Base URL
    https://api.voipbin.net/v1.0
  • URL
    https://api.voipbin.net/v1.0/agents/{id}/addresses
  • Auth
    none declared

Path parameters

idstring required

The ID of the agent.

Request body

Example request

{
  "addresses": [
    {
      "type": "tel",
      "target": "+14155551234",
      "target_name": "John Smith",
      "name": "Main Office",
      "detail": "Primary contact number"
    }
  ]
}

Response

Successful response.

idstring uuid

The unique identifier of the agent.

customer_idstring uuid

The unique identifier of the customer who owns this agent. Returned from the GET /customers response.

usernamestring

Agent's login username, typically an email address.

namestring

Display name of the agent.

detailstring

Additional detail or notes about the agent.

ring_method'ringall' | 'linear'

Method used to ring the agent for incoming calls.

status'' | 'available' | 'away' | 'busy' | 'offline'

Current availability status of the agent.

permission0 | 65535 | 1 | 15 | 16 | 32 | 64 | 240

Permission type

tag_idsstring[]

List of tag IDs assigned to this agent. Returned from the POST /tags or GET /tags response.

direct_hashstring

The direct hash for direct access via SIP URI sip:<direct_hash>@sip.voipbin.net (the "direct." prefix is already included in the value, e.g. "direct.a1b2c3d4e5f6"). Returned from the resource's direct_hash field.

tm_createstring date-time

Timestamp when the agent was created.

tm_updatestring date-time

Timestamp when the agent was last updated.

tm_deletestring date-time

Timestamp when the agent was deleted.

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  "username": "agent@example.com",
  "name": "John Smith",
  "detail": "Senior support agent",
  "ring_method": "ringall",
  "status": "available",
  "permission": 64,
  "tag_ids": [
    "b1a2c3d4-e5f6-7890-abcd-ef1234567890"
  ],
  "addresses": [
    {
      "type": "tel",
      "target": "+14155551234",
      "target_name": "John Smith",
      "name": "Main Office",
      "detail": "Primary contact number"
    }
  ],
  "direct_hash": "direct.a1b2c3d4e5f6",
  "tm_create": "2026-01-15T09:30:00.000000Z",
  "tm_update": "2026-01-16T14:20:00.000000Z",
  "tm_delete": "2026-01-17T10:00:00.000000Z"
}

Changes

  • 4a9f0f245dffRevision changes
    • info

      removed the ringing enum value from the response property for the response status

  • d5569b315411Revision changes
    • warning

      added the new web_session enum value to the // response property for the response status

    • info

      added the new web_session enum value to the request property //