SEsentdm
Channels
Voice

Test a voice number's callback URL

Changed on

Sends a synthetic call.request question, flagged "test": true, to the number's callback URL, signed with that number's real secret, and reports what came back. Use it to build and debug your callback endpoint without placing calls: no call is placed, nothing is billed, and nothing is stored. One attempt with the same deadline as a live call, no retry. The outcome is ok when your endpoint answered 2xx with a valid answer; otherwise it is timeout, connection_failed, http_error or invalid_answer, with the reason and, for an invalid answer, the field at fault. The number is the E.164 value in the path with the plus sign URL-encoded (%2B).

With sandbox: true nothing is sent: the verdict comes back ok with 202 and no request or response in it.

post/v3/channels/voice/{number}/test

Request

  • Base URL
    https://api.sent.dm
  • URL
    https://api.sent.dm/v3/channels/voice/{number}/test
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Path parameters

numberstring required

The voice number from the route, in E.164 format with the plus sign URL-encoded (%2B), for example /v3/channels/voice/%2B12025550123/test. The test question goes to this number's callback URL and is signed with this number's secret.

Headers

Idempotency-Keystring

Unique key to ensure idempotent request processing. Must be 1-255 alphanumeric characters, hyphens, or underscores. Responses are cached for 24 hours per key per customer.

x-profile-idstring uuid

Profile UUID to scope the request to a child profile. Only organization API keys can use this header. The profile must belong to the calling organization.

Request body

sandboxboolean

Sandbox flag - when true, the operation is simulated without side effects Useful for testing integrations without actual execution

Response

The test ran. Read outcome to see whether your endpoint passed

successboolean

Indicates whether the request was successful

Changes