Whatsapp Phone Numbers

Get Connection ID for a WhatsApp Calling BYON number

Changed on

Retrieve the connection ID currently stored for a WhatsApp Calling BYON (Bring Your Own Number) phone number: the connection that inbound WhatsApp calls to the number are delivered to.

Use it to check the result of PATCH /whatsapp/phone_numbers/{id}/calling_routing. A read made immediately after an update can still return the previous value.

Sub-users need read permission on connections.

get/whatsapp/phone_numbers/{id}/calling_routing

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/whatsapp/phone_numbers/{id}/calling_routing
  • Auth: HTTP bearer

Path parameters

idstring required

The BYON phone number in E.164 format. The leading + is optional.

Response

The stored routing connection. connection_id is null when no connection is routed, and also when the stored target is not a connection in the account, including a connection too new to have propagated yet.

Example response

{
  "data": {
    "record_type": "whatsapp_calling_routing",
    "phone_number": "+13125550100",
    "connection_id": "1234567890"
  }
}

Changes