Start Sms Trial Phone
Header Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/v1/sms/trial/phone" \ -H "Content-Type: application/json" \ -d '{ "phone": "string", "recipient_consent": true, "consent_version": "string" }'{ "configured": true, "available": true, "status": "none", "phone": "string", "pending_phone": "string", "code_expires_at": "2019-08-24T14:15:22Z", "texts_used": 0, "texts_limit": 0, "texts_left": 0}Route Number
Choose which agent answers this number. Setting ``voice_agent_id`` registers the number for inbound calls at the carrier and on Hail's LiveKit inbound trunk; ``null`` unregisters it, and calls ring out again. ``sms_agent_id`` needs the sms capability and sets the number up for SMS at the carrier if that has not happened yet. A field left out keeps its value.
Unsubscribe
One-click email opt-out (RFC 8058). ``GET`` is a person clicking the link in a sent email. ``POST`` is the mailbox provider's unsubscribe button (Gmail, Yahoo), which sends the body ``List-Unsubscribe=One-Click``. The body is optional. Public and unauthenticated — the signed token query param is the sole credential, proving the caller holds a link Hail sent to that address. On success, the address is added to the org's suppression list and all future outbound email to it is blocked. Returns an HTML page, not JSON.