Messaging · RCS
Invites an RCS test phone.
Request
Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Keys with the messages resource group disabled get 403 resource_group_disabled. Authentication
Path parameters
| Name | Type | Notes |
|---|---|---|
agentIdrequired | string |
Request body
application/json, required
phoneNumberstringrequired
Example
curl -X POST "https://api.pozy.ai/v1/rcs/agents/6b99fbd950277956c14bd44d/test-devices" \
-H "Authorization: Bearer $POZY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"phoneNumber": "+14155550123"
}'const res = await fetch("https://api.pozy.ai/v1/rcs/agents/6b99fbd950277956c14bd44d/test-devices", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.POZY_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
phoneNumber: "+14155550123"
}),
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);import os
import requests
resp = requests.post(
"https://api.pozy.ai/v1/rcs/agents/6b99fbd950277956c14bd44d/test-devices",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
json={
"phoneNumber": "+14155550123",
},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
201 on success
testDeviceobjecttestDeviceIdstringphoneNumberstringinviteStatusstringOne of
PENDING,ACCEPTED,DECLINED.
201 response
{
"testDevice": {
"testDeviceId": "653426651346b544a97028d1",
"phoneNumber": "+14155550123",
"inviteStatus": "PENDING"
}
}Errors
Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:
| 400 | invalid_request_error | A parameter or body field is missing or invalid. param names it. |
| 401 | authentication_error | The API key is missing, revoked or expired. |
| 403 | permission_error | The key is read-only, scoped to other profiles, or has this resource group disabled. |
| 404 | not_found | Nothing with that id exists in your workspace. |
| 429 | rate_limit_error | Too many requests this minute. Wait for Retry-After seconds. |
Every code is listed in Errors.