Sign in
latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-054102371.0 MB

79e779080bcc

Agent

Regenerate direct hash for agent

Regenerates the direct hash for the specified agent. If no direct hash exists, one is created. Returns the updated agent with the new direct_hash.

post/agents/{id}/direct-hash-regenerate

Path parameters

idstring uuid required
Example:550e8400-e29b-41d4-a716-446655440000

The unique identifier of the agent. Returned from the GET /agents response.

Response

Direct hash regenerated successfully.

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' | 'ringing'

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"
}