Channels
Voice

Get one voice number

Changed on

Reads one of your voice numbers, active or inactive: its status, whether it is the default line for calls placed from your app, and its callback URL. The signing secret is not on this read.

The same shape GET /v3/channels/voice lists, and the same shape PATCH on this path accepts and returns, so what comes back can be sent back.

The number is the E.164 value in the path with the plus sign URL-encoded (%2B).

get/v3/channels/voice/{number}

Request

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

Path parameters

numberstring required

The number in E.164 format with the plus sign URL-encoded, e.g. %2B12125550100

Headers

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.

Response

The voice number

successboolean

Indicates whether the request was successful

Changes

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      endpoint added