Field Name | Description |
projectId | Sinch uses projects to group contacts and apps together to manage and connect a unique set of keys and secret IDs for all your Sinch API products. To identify a project, it is given a unique alphanumeric identifier that ties it to your account. Your project ID can be found in the Customer Dashboard. |
brandId | The brand is the company or entity represented in the campaign. The brand ID is an alphanumeric identifier that always begins with a "B". When registering a brand in The Campaign Registry (TCR), TCR returns a brand ID value, example: BESINCH. For more info, see Creating a new 10DLC Brand. |
useCase | Select a use case that is the primary use case that is most applicable to the service that messages are providing to subscribers. Standard use cases are immediately available for all qualified registered brands, whereas special use cases require vetting or pre/post approval by mobile network operators (MNOs). For more information on standard use case versus special use case campaigns, see 10DLC Use Cases - Standard Use Cases vs Special Use Cases. |
campaignName | This is an optional name to help track and view your campaign within Sinch's platform. Use a name that is easily recognizable, this will help you identify your campaign later within the Sinch customer dashboard. This name is not part of the campaign registration in TCR. |
description | Describe in detail the service the message program is providing to the end user and the purpose of the brand’s messages (i.e. appointment reminders, OTP alerts, etc.). The description should match the selected use case and identify who is sending the messages, who is receiving the messages, and why messages are being sent. (min 40 characters) A standard description may look like this: This message program will be used to provide {purpose of brand’s messages}. |
terms | Provide a link to your message program terms and conditions or provide your terms and conditions body copy. Ensure that all applicable messaging terms and conditions (e.g., how to opt-out, customer care contact information, and any applicable privacy policy) are covered. |
privacyPolicy | Provide a link to your privacy policy, or provide your privacy policy body copy. It should be clear from your privacy policy that the end user’s personal info, including mobile phone number, will not be shared or sold to third parties for marketing purposes. |
optInDocumentation | Provide a URL to the online opt-in process. If opt-in is not online or not publicly accessible, provide a URL with hosted screenshots or images of the opt-in process. If you cannot provide a URL, provide your opt-in body copy. |
sample1 | Provide sample production message content. Include the Brand name and opt out instructions (e.g. Reply STOP to stop) in every message. If you have selected Mixed use case, please provide examples of each sub use case selected (min 20 characters, max 1024 characters) A standard sample message may look like: {Brand name}: We are contacting you today to let you know your order is ready for pickup. Reply STOP to stop. |
sample2 | A standard sample message may look like: {Brand name}: Your confirmation code is SINCH1234. Please enter it on the authentication website. Reply STOP to stop. |
sample3 | A standard sample message may look like: {Brand name}: Shop at www.example.com for all your retail needs! From clothing to home goods, we've got you covered. Visit us today and save! Reply STOP to stop. |
sample4 | If needed, add another sample message. |
stopMessage | Message sent in response to a STOP keyword. It must confirm that the end user has unsubscribed from the message program and will not receive any further messages. Include the brand name. You can also include customer care contact information (e.g. support email or phone number). (min 20 characters, max 255 characters) A standard sample Stop message may look like: You have been unsubscribed and will not receive any more messages from {Brand name}. For more information call {phone number} or email {email address}." |
optInMessage | Initial message that is sent confirming the end user's subscription. Include the brand name, opt-out instructions (reply STOP to stop), customer care instructions (reply HELP for help), message frequency (#msgs/mo, msg frequency varies, recurring messages, etc.) and the "message and data rates may apply" disclosure (Msg & Data rates may apply). (min 20 characters, max 255 characters) A standard opt-in message may look like: You have opted in to receive messages from {Brand name}! Msg freq varies. Msg & data rates may apply. Reply HELP for help. Reply STOP to stop. |
helpMessage | Message sent in response to HELP. Include the brand name and additional customer care contact information (e.g. support email or phone number) (min 20 characters, max 255 characters) A standard Help message may look like: {Brand name}: For help call {phone number} or email {email address} Reply STOP to stop. |
subUseCases |
If you have selected a Mixed use case, select all sub use cases that apply to your message program. Choose between 2 and 5 sub use cases for this campaign. This field is not required. The input(s) should be one of the accepted values below: SECURITY_ALERT |
autoRenewal | Will your campaign automatically renew? If yes, a monthly recurring fee will be charged to the account. If no, only the initial setup fee will be charged, and the campaign will expire after three months unless it is reviewed manually. The default setting is true, campaigns will be auto-renewed. |
embeddedLink | Will your message content include a URL? Note that public URL shorteners are not allowed. |
embeddedPhone | Will your message content include embedded phone numbers? |
affiliateMarketing | Will your campaign follow CTIA messaging principles and best practices and will not be used for Affiliate Marketing? This should default to true. |
numberPool | Will your campaign support a number pool (more than 50 numbers)? If yes, your use case should clearly support the need for a number pool. For more info see: When should I use a number pool for my 10DLC campaign. |
ageGated | Will your traffic include any content related to age-restricted goods or services? If yes, you must implement an age gate verification process. |
directLending | Are you a financial institution engaged in direct, first-party lending to your customers? If yes, note that your campaign description should clearly indicate direct lending, even if your use case is not related to your lending services (e.g. OTP). |
subscriberOptIn | Will your campaign collect and process end user opt-ins? This is mandatory for all use cases, except for Machine-to-Machine. |
subscriberOptOut | Message sent in response to a STOP keyword. It must confirm that the end user has unsubscribed from the message program and will not receive any further messages. Include the brand name. You can also include customer care contact information (e.g. support email or phone number). (min 20 characters, max 255 characters) Sample opt-out message: You have been unsubscribed and will not receive any more messages from {Brand name}. For more information call {phone number} or email {email address}. |
subscriberHelp | Message sent in response to HELP. Include the brand name and additional customer care contact information (e.g. support email, phone number or support website) (min 20 characters, max 255 characters) Sample Help message: {Brand name}: For help call {phone number} or email {email address} |
optinKeywords | If subscribers can opt-in via a keyword, enter keyword(s) here. (alphanumeric comma separated values, no blank spaces) |
optoutKeywords | Subscriber opt-out keywords. Default values are STOP, QUIT, END, CANCEL and UNSUBSCRIBE. If you accept additional opt-out keywords, you can enter them here. (alphanumeric comma separated values, no blank spaces) |
helpKeywords | Subscriber help keywords. Default value is HELP. If you accept additional help keywords, you can enter them here. (alphanumeric comma separated values, no blank spaces) |
messageFlow | Instructions: Describe how end users opt-in to receive messages. A compliant opt-in is critical to the approval of your campaign. Include all opt-in mechanisms (e.g. keyword/text-to-join, online form, point-of-sale (POS) system, verbal consent, interactive voice response (IVR) system, paper form) and a clear program description. The Call-to-Action should include opt-out instructions (reply STOP to stop), customer care instructions (reply HELP for help), message frequency (#msgs/mo, msg frequency varies, recurring messages, etc.) and message and data rates disclosure (Msg & Data rates may apply). (min 40 characters, max 2048 characters) Sample message flow: Users will opt-in to receive messages from {Brand name} via {opt-in mechanism} |