Add a sender name or a WhatsApp number

post/phone/senders

Add a sender name or a WhatsApp number. A name that a country wants registered waits until the registration is approved.

Before you call

Credential: Authorization: Bearer $KEY
Scope: voice:write
Graphql: Mutation.voicePhoneSenderAdd
Sdk: voice.phoneSender.add
Cli: voice phone sender add

Request bodyapplication/json, required

kindstringrequired
One of: alphanumeric, whatsapp.
valuestringrequired
At most 20 characters.
countrieslist of string

Responses

201application/json
Success
- idstringrequired
- kindstringrequired
  One of: number, alphanumeric, whatsapp.
- valuestringrequired
- countrieslist of stringrequired
- statusstringrequired
  One of: active, pending, rejected, needs_owner.
- notestringrequired
- oneWaybooleanrequired
- numberIdstring or nullrequired
- createdAtstringrequired
400application/json
The request was malformed
- errorstringrequired
- messagestring
401application/json
No valid credential
- errorstringrequired
- messagestring
403application/json
The credential lacks the scope, origin or address
- errorstringrequired
- messagestring
429application/json
Over the key's rate limit; see Retry-After
- errorstringrequired
- messagestring

Example request

curl -X POST 'https://api.rivier.ai/phone/senders' \
  -H 'Authorization: Bearer $KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "kind": "alphanumeric",
  "value": "string"
}'

$KEY stands for your own key. No key is shown or kept on this site.

This page as Markdown