API referenceWhatsApp

POST /whatsapp/numbers/{id}/retry

Retry a failed number from the step that failed

POST
/whatsapp/numbers/{id}/retry

Authorization

BearerAuth
headerAuthorizationBearer <token>

API key sk_...

Path Parameters

id*string

Provisioned number id

Response Body

{number}

application/json
  1. response
number?
Example Request
curl -X POST 'https://example.com/api/v1/whatsapp/numbers/string/retry'
Example Response
{  "number": {    "id": "string",    "provider": "telnyx",    "phoneNumber": "string",    "countryCode": "string",    "verifiedName": "string",    "status": "purchasing",    "wabaId": "string",    "phoneNumberId": "string",    "accountId": "string",    "sourceAccountId": "string",    "codeMethod": "VOICE",    "codeRequestedAt": "2019-08-24T14:15:22Z",    "codeAttempts": 0,    "priceCents": 0,    "currency": "string",    "activatedAt": "2019-08-24T14:15:22Z",    "lastProductionMessageAt": "2019-08-24T14:15:22Z",    "releaseWarnedAt": "2019-08-24T14:15:22Z",    "releaseAt": "2019-08-24T14:15:22Z",    "releasedAt": "2019-08-24T14:15:22Z",    "error": "string",    "nextActionAt": "2019-08-24T14:15:22Z",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "lastCode": {      "code": "string",      "capturedAt": "string",      "expiresAt": "string"    }  }}

DELETE /whatsapp/numbers/{id} DELETE

Release the number now: deregistered (best effort), returned to the carrier, its account flagged needs_reconnect (phone_number.released). Idempotent

POST /whatsapp/connect POST

Connect a number with an existing token (system user or test token) instead of Embedded Signup: reads the number and the WABA with it, subscribes the app to the WABA and registers the number (failures are reported in onboarding, not as errors). The token is stored encrypted. Emits account.connected