Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Generate SMS Opt-In QR Code

GraphQL endpoint: /company

Generate a QR code that users can scan to opt-in to SMS communications. The QR code encodes a pre-formatted SMS message that users can send to subscribe.

Required fields:

  • telephoneNumberId: The ID of the company's verified SMS opt-in telephone number

  • subscriptionTopicIds: List of subscription topic IDs the user will subscribe to

  • type: The type of QR code (SMS or MMS)

The telephone number must be:

  1. Owned by the company

  2. Marked as an SMS opt-in number (has type 'sms_opt_in')

  3. Verified

Returns the opt-in message text and a base64-encoded SVG QR code image.

Query

mutation (
    $telephoneNumberId: ID!
    $subscriptionTopicIds: [ID!]!
    $type: SmsOptInQrCodeType!
) {
  generateSmsOptInQrCode (
    telephoneNumberId: $telephoneNumberId
    subscriptionTopicIds: $subscriptionTopicIds
    type: $type
  ) {
    message
    qrCode
    qrCodeDownload
    telephoneNumber {
      id
    }
  }
}

Variables

Response

Previous009_sms_opt_in
Next010_users_and_search

Last updated