Service Agent

Update authenticated agent's addresses

Changed on

Updates the address details of the authenticated agent and returns the updated information. The list replaces the stored addresses. The tel and sip addresses can be freely added, changed and removed. The extension addresses can only be kept or removed. An extension address that is not already stored on the agent is rejected with 403 (EXTENSION_ADDRESS_ADMIN_ONLY) regardless of the caller's role, because the extension addresses are assigned by an administrator through PUT /agents/{id}/addresses or POST /agents. To keep a stored extension, send it back unchanged as returned by GET /service_agents/me. A tel address must contain at least one digit.

put/service_agents/me/addresses

Request

  • Base URL
    https://api.voipbin.net/v1.0
  • URL
    https://api.voipbin.net/v1.0/service_agents/me/addresses
  • Auth
    none declared

Request body

Example request

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

Response

The updated address information of the agent.

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