Phone & voice · Phone Numbers

Reply to the regulatory reviewer

Replies to the regulatory reviewer.

POSThttps://api.pozy.ai/v1/phone-numbers/{id}/remediate/reply
replyToPhoneNumberReviewer

Guides: KYC for regulated countries, Phone numbers

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Keys with the telephony resource group disabled get 403 resource_group_disabled. Authentication

Path parameters

NameTypeNotes
idrequiredstring

Request body

application/json, required

  • textstring

    Up to 2000 characters.

  • attachmentsarray of object

    Up to 5 items.

    • filenamestringrequired
    • base64stringrequired

Example

curl -X POST "https://api.pozy.ai/v1/phone-numbers/6bfebd43ddc270f6d2c56fc5/remediate/reply" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "text": "Hello from Pozy",
  "attachments": [
    {
      "filename": "photo.jpg",
      "base64": "string"
    }
  ]
}'

Response

200 on success

  • postedboolean
  • attachmentsinteger
200 response
{
  "posted": true,
  "attachments": 1
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400invalid_request_errorA parameter or body field is missing or invalid. param names it.
401authentication_errorThe API key is missing, revoked or expired.
403permission_errorThe key is read-only, scoped to other profiles, or has this resource group disabled.
404not_foundNothing with that id exists in your workspace.
429rate_limit_errorToo many requests this minute. Wait for Retry-After seconds.

Every code is listed in Errors.

More in Phone Numbers