Send CTA URL Button
Send an interactive message with a single Call-To-Action URL button. (Only if the dialogue has an Open Session). Only one destination parameter is needed - chatId, phone, or bsuid. In BSUID-centric routing, chatId can be [email protected], bsuid@lid, [email protected], or username@username. The phone field accepts a phone number or BSUID; bsuid can be passed separately.
Required: body, displayText (button label), url (must be https://). Optional: header (same object shape as /sendButton), footer, quotedMsgId.
Outside the 24-hour customer service window use a template instead.
JWT tokentoken<token>- body
body*stringMain message text
displayText*stringCTA button label
url*stringButton URL (must use https://)
footer?stringOptional footer text
header?|||Optional header: text, document, video, or image object. Each variant requires type plus the matching media/text field.
quotedMsgId?stringQuoted message ID (Cloud API)
chatId?stringRequired if phone and bsuid are not set
Chat ID from the message list. Examples: [email protected], RU.1504711984690866@lid, username@username, or [email protected] (group). Used instead of the phone parameter.
phone?stringRequired if chatId and bsuid are not set
Recipient identifier. Accepts a phone number starting with the country code, or a BSUID such as RU.1504711984690866.
Use chatId for full chat IDs: [email protected], bsuid@lid, username@username, or [email protected].
bsuid?stringOptional alternative to phone/chatId
Recipient BSUID without the @lid suffix. Example: RU.1504711984690866.
Server response example
application/json- response
sent?booleanid?stringunique message id
message?stringPosting status message
description?stringResult description
curl -X POST 'https://api.1msg.io/123/sendCtaUrl' \ -H 'Content-Type: application/json' \ -d '{ "body": "Open our site", "displayText": "Visit", "url": "https://example.com", "phone": "12020721369"}'{ "sent": true, "id": "gBGGeRhGZTEfAgkJCh2wAz4ZH-8", "message": "Sent to [email protected]", "description": "Message has been sent to the provider"}