Agents

One-tap opt-in link

"Text SURVEY to +1…" asks someone to open an app, type an exact word and address it correctly. This does all three in a tap — the missing half of a keyword opt-in flow.

Built from the agent's rbm_service_id, which Google's API cannot return: copy it from the Console overview page into PATCH /v1/agents/{id}/launch-info first.

Not available on a sandbox key, for the same reason — the service ID only exists after the irreversible sync-google. Since a deep link is the only way a user can start a conversation, that one journey cannot be rehearsed in sandbox. Agent-initiated conversations, which is everything this API opens, are fully testable.

get/v1/agents/{id}/deep-link

Request

  • Base URL: https://api.cadencercs.com
  • URL: https://api.cadencercs.com/v1/agents/{id}/deep-link
  • Auth: HTTP bearer

Path parameters

idstring required

Agent id.

Query parameters

phonestring

Override the agent's default deep-link phone number.

bodystring

Pre-filled message body, e.g. the opt-in keyword.

Response

The link.

urlstring required
launchedboolean required
caveatstring

Present when the agent isn't launched — the link only works for allowlisted test devices.

Changes

No recorded changes to this operation across all 1 revision of this API.