Sandbox

1 endpoints in this family.

Get the sandbox

GET/api/v1/sandbox

The shared WhatsApp test number of Nodium, to try sending and receiving without a number of your own: send joinMessage to displayPhone from your phone (or open waLink), and your phone is linked to your account. Then send to it from channelId within its 24-hour window. available: false when the sandbox is closed on this server.

Response

The test number, your join code and your linked phones.

data.availableboolean
False when the sandbox is closed: every other field is then empty.
data.displayPhonestring
The shared test number, as displayed.
data.joinCodestring
Your account's code.
data.joinMessagestring
The message to send from your phone to link it.
data.waLinkstring
Opens WhatsApp with joinMessage already typed.
data.channelIdstring
The sandbox channel of "My company" once a phone is linked, to send from; null before.
data.linkedPhonesarray
The phones linked to your account, with their 24-hour window.
data.limitsobject
dailyMessages, sentToday, maxPhones.

Refusals

403all_clients_requiredThe key is pinned to a client.

curl https://nodium.io/api/v1/sandbox \ -H "Authorization: Bearer $NODIUM_KEY"

Response

200 OK

{  "data": {    "available": true,    "displayPhone": "…",    "joinCode": "…",    "joinMessage": "…",    "waLink": "…",    "channelId": "…",    "linkedPhones": [],    "limits": {}  }}