API Reference
API Reference

Test Directory Member Extension

Test directory member extension at a specific timestamp and language.

GET/api/v1/directory_members/{member_id}/test

Authentication

Syllable-API-Keyrequired

Send Syllable-API-Key in the header.

Need a credential? Create or manage an API token in the Syllable Console.

Parameters

Path parameters

member_id integer path required

Query parameters

timestamp string query required

Timestamp for test in ISO 8601 format (e.g., 2025-12-04T14:29:39)

language_code enum<string> | null query optional

Optional language code for test

Allowed values ["yue-HK","en-US","ko-KR","zh-CN","fa-IR","es-US","th-TH","vi-VN","bs-BA","sw-KE","ru-RU","hi-IN","gu-IN","ar-XA","fr-FR","ja-JP","ne-NP"]

Responses

200Successful Response

application/json

response DirectoryMemberTestResponse required
3 fields
extensionstring | nulloptional

Extension to which the user will be transferred if they call at the provided timestamp in the given language, or a status message if no rules match

statusstring | nulloptional

Status message if no rules match

sip_transfer_modestring | nulloptional

SIP transfer mode.

Response example
{
  "extension": "string",
  "status": "string",
  "sip_transfer_mode": "string"
}
422Validation Error

application/json

response HTTPValidationError required
1 field
detailValidationError[]optional
Item schema
itemsValidationErrorrequired
3 fields
locstring | integer[]required
Item schema
itemsstring | integerrequired
2 options
Option 1stringrequired
Option 2integerrequired
msgstringrequired
typestringrequired
Response example
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}