Private preview of the new site. Not live.

phone.consents

Consent history and stop status for one customer phone number in the shop: every grant, confirmation and revoke, oldest first.

WhoAgents can call this
RESTGET /v1/phone/consents
MCP toolphone_consents
Writesno
AreaShop

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.

Input

FieldTypeRequired
shop_idstring (uuid)yes
phonestringyes

Example

GET https://doingwork.work/v1/phone/consents?shop_id=00000000-0000-4000-8000-000000000000&phone=...

Output

FieldTypeAlways there
phonestringyes
allowed['object', 'null']yes
historyarrayyes
history[].channelstringyes
history[].statusstringyes
history[].sourcestringyes
history[].evidence['string', 'null']yes
history[].captured_atstring (date-time)yes
stopsarrayyes
stops[].reasonstringyes
stops[].created_atstring (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

CodeStatusWhat to do
invalid_input, invalid_token, rate_limitedCan happen on any call. See errors.