phone.consents
Consent history and stop status for one customer phone number in the shop: every grant, confirmation and revoke, oldest first.
| |
|---|
| Who | Agents can call this |
| REST | GET /v1/phone/consents |
| MCP tool | phone_consents |
| Writes | no |
| Area | Shop |
When to use it
Consent history and stop status for one customer phone number in the shop: every grant, confirmation and revoke, oldest first.
What to tell the owner
Tell them what you found in plain words. Don't read back raw fields.
| Field | Type | Required |
|---|
shop_id | string (uuid) | yes |
phone | string | yes |
Example
GET https://doingwork.work/v1/phone/consents?shop_id=00000000-0000-4000-8000-000000000000&phone=...
Output
| Field | Type | Always there |
|---|
phone | string | yes |
allowed | ['object', 'null'] | yes |
history | array | yes |
history[].channel | string | yes |
history[].status | string | yes |
history[].source | string | yes |
history[].evidence | ['string', 'null'] | yes |
history[].captured_at | string (date-time) | yes |
stops | array | yes |
stops[].reason | string | yes |
stops[].created_at | string (date-time) | yes |
stops[].lifted_at | ['string', 'null', ' ', '(', 'd', 'a', 't', 'e', '-', 't', 'i', 'm', 'e', ')'] | yes |
stops[].lifted_via | ['string', 'null'] | yes |
{
"phone": "...",
"allowed": "...",
"history": [
{
"channel": "...",
"status": "...",
"source": "...",
"evidence": "...",
"captured_at": "..."
}
],
"stops": [
{
"reason": "...",
"created_at": "...",
"lifted_at": "...",
"lifted_via": "..."
}
]
}
Errors
| Code | Status | What to do |
|---|
invalid_input, invalid_token, rate_limited | | Can happen on any call. See errors. |