Service Agent

Get extension details

Retrieves detailed information about a specific extension of the authenticated agent's customer by its ID.

The password and direct_hash fields are returned only when the extension is assigned to the authenticated agent. For an extension assigned to someone else they are returned as empty strings.

An extension that does not exist, that has been deleted, or that belongs to another customer is reported identically as 404 EXTENSION_NOT_FOUND.

get/service_agents/extensions/{id}

Request

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

Path parameters

idstring required

The ID of the extension.

Response

The details of the extension.

idstring uuid

The unique identifier of the extension. Returned from the POST /extensions or GET /extensions response.

customer_idstring uuid

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

namestring

Display name of the extension.

detailstring

Detailed description of the extension.

extensionstring

The SIP extension number.

domain_namestring

The full SIP domain (realm) of the extension. e.g. ab12.reg.voipbin.net

usernamestring

Username, same as the Extension, used by Kamailio's INVITE validation

passwordstring

The SIP password for authentication.

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

The creation timestamp.

tm_updatestring date-time

The last update timestamp.

tm_deletestring date-time

The deletion timestamp.

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  "name": "Reception Desk",
  "detail": "Main reception extension for building A",
  "extension": "1001",
  "domain_name": "ab12.reg.voipbin.net",
  "username": "1001",
  "password": "s3cur3P@ss",
  "direct_hash": "direct.a1b2c3d4e5f6",
  "tm_create": "2026-01-15T09:30:00.000000Z",
  "tm_update": "2026-01-16T14:20:00.000000Z",
  "tm_delete": "2026-01-17T18:45:00.000000Z"
}

Changes

No recorded changes to this operation across all 111 revisions of this API.