openapi: 3.2.0
info:
title: Sinch RCS Senders API
version: '1.0'
description: 'Operations tagged RCS Senders across 2 of this provider''s published API definitions: sinch-provisioning-api-openapi.yaml, original-sinch-provisioning-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://provisioning.api.sinch.com
description: Production server
tags:
- name: RCS Senders
description: The RCS sender endpoint offers a way for you to manage your RCS senders that can be used with the Conversation API.
paths:
/v1/projects/{projectId}/rcs/senders:
get:
description: Returns a paginated list of senders for the specified project. If no page token is supplied then the first `50` will be returned.
operationId: RcsSendersController_listSenders_v1
parameters:
- name: projectId
required: true
in: path
description: The unique ID of the project. You can find this on the Sinch Dashboard.
schema:
type: string
- name: pageToken
required: false
in: query
schema:
type: string
description: The page token if retrieving the next page from a previous query.
- name: pageSize
required: false
in: query
schema:
type: number
minimum: 1
maximum: 100
description: The page size requested.
- name: filterConversationApiAppId
required: false
in: query
description: Optional query for sender by Conversation API app id.
schema:
type: string
- name: filterSenderIds
required: false
in: query
description: Optional query for sender by sender ids.
schema:
type: string
- name: filterSenderName
required: false
in: query
description: Optional query for sender by name. Use the `search` parameter instead
deprecated: true
schema:
type: string
- name: filterStates
required: false
in: query
description: Optionally query for sender by states.
x-enumDescriptions:
DRAFT: The sender configuration is saved as a draft.
IN_PROGRESS: The sender registration or setup is currently in progress.
IN_TEST: The sender is currently undergoing testing.
LAUNCHED: The sender has been successfully launched.
LAUNCHING: The sender launch sequence is currently executing.
PREPARING_LAUNCH: The sender configuration is being prepared for launch.
UNLAUNCHED: The sender has been unlaunched and is disabled.
UNKNOWN: The current state of the sender cannot be determined.
schema:
type: array
items:
$ref: '#/components/schemas/RcsSenderStatesEnum'
- name: search
required: false
in: query
description: Search term to filter senders (partial match, case-insensitive).
schema:
type: string
- name: sortColumn
required: false
in: query
description: Optional query for sender sort column.
x-enumDescriptions:
CREATED: Orders the results collection based on the original resource creation timestamp.
MODIFIED: Orders the results collection based on the latest resource modification timestamp.
NAME: Orders the results collection alphabetically by the identity identifier string.
STATE: Orders the results collection sequentially by the current lifecycle state code.
schema:
$ref: '#/components/schemas/RcsSenderSortColumnsEnum'
- name: sortDirection
required: false
in: query
description: Optional query for sender sort direction.
x-enumDescriptions:
ASC: Ascending order. Oldest or lowest values first.
DESC: Descending order. Newest or highest values first.
schema:
$ref: '#/components/schemas/RcsSortDirectionsEnum'
responses:
'200':
description: List of senders
content:
application/json:
schema:
$ref: '#/components/schemas/RcsSenderListDto'
examples:
newResponse:
summary: List response
description: "\n Response with senders.\n "
value:
totalSize: 2
pageSize: 50
senders:
- id: cf11794a-6a5e-4a12-b103-da79bd378bf1
state: IN_TEST
testNumberStates:
- number: '+46123123111'
state: UNVERIFIED
submitted: '2023-01-19t13:11:08.204Z'
- number: '+46123123222'
state: VERIFIED
submitted: '2023-01-19t13:11:08.204Z'
- number: '+46123123333'
state: DECLINED
submitted: '2023-01-19t13:11:08.204Z'
countryStatus:
- country: FR
status: NOT_LAUNCHED
operators:
- name: Coriolis Telecom
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Lycamobile
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Bouygues
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Free
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: NRJ Mobile
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: SFR
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Orange
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- country: GB
status: NOT_LAUNCHED
operators:
- name: EE
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Three
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Sky
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: O2
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Vodafone
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- country: SE
status: NOT_LAUNCHED
operators:
- name: Tele2
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Telenor
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Telia
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Three
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
details:
brand:
emails:
- label: label
address: test@test.com
- label: label-1
address: test-1@test.com
- label: label-2
address: test-2@test.com
phones:
- label: label
number: '+48777777777'
- label: label-1
number: '48888888888'
- label: label-2
number: '+48999999999'
websites:
- label: label
url: https://example.com
- label: label-1
url: https://example-1.com
- label: label-2
url: https://example-2.com
color: '#000000'
description: Test description
bannerUrl: https://example-banner-url.com
logoUrl: https://example-logo-url.com
privacyPolicyUrl: https://example-private-policy-url.com
termsOfServiceUrl: https://example-terms-of-service-url.com
name: Test name
testNumbers:
- '+48777777777'
countries:
- FR
- GB
- SE
questionnaire:
general:
questions:
optInDescription:
question: How do users agree to receive messages from your business through the agent?
suggestedAnswers:
- By subscribing to our loyalty program
- By making a purchase in-store or online
- By subscribing to a newsletter
- By creating an account on our website or app
triggerDescription:
question: When does your business send messages to users through the agent?
suggestedAnswers:
- User actions (e.g. after making a purchase)
interactionsDescription:
question: How will users interact with your business through the agent?
suggestedAnswers:
- Online Payment
- Password reset
- OTP/2FA for account login
optOutDescription:
question: What message does your business send when a user opts out?
suggestedAnswers:
- Thank you for opting out
- Thank you for unsubscribing
- We have registered your opt out request
videoUris:
question: ''
suggestedAnswers: []
screenshotUris:
question: ''
suggestedAnswers: []
answers:
optInDescription: By subscribing to a newsletter
triggerDescription: User actions (e.g. after making a purchase)
interactionsDescription: Billing or payment reminders,aef Order updates,aef Upon package delivery
interactionsDescriptionMetadata:
ignore: ',aef'
optOutDescription: We have registered your opt out request
videoUris:
- https://example-video-url.com
screenshotUris:
- https://example-screenshot-url.com
verification:
questions:
name:
question: What is the name of your verification contact?
suggestedAnswers: []
email:
question: What is the email of your verification contact?
suggestedAnswers: []
title:
question: What is the title of your verification contact?
suggestedAnswers: []
website:
question: What is the website of your verification contact?
suggestedAnswers: []
phone:
question: What is the phone number of your verification contact?
suggestedAnswers: []
partner:
companyName:
question: 'For ASP resellers: what is the name of the brand partner company?'
suggestedAnswers: []
contactName:
question: 'For ASP resellers: what is the name of the brand partner contact person?'
suggestedAnswers: []
contactEmailAddress:
question: 'For ASP resellers: what is the email of the brand partner contact person?'
suggestedAnswers: []
answers:
name: Exam Ple
email: email@example.com
title: Head Example
website: https://example.com
phone: '+48777777777'
partner:
companyName: Partner company
contactName: Partner contact name
contactEmailAddress: partner.contact@partner-company.com
gb:
questions:
brandIndustry:
question: What sector or industry does your business operate in?
suggestedAnswers:
- Automotive
- Beauty, spa and salon
- Clothing
- Education
- Entertainment
- Event planning and service
- Finance and banking
- Food and groceries
- Public service
- Hotel and lodging
- Medical and health
- Charity
- Professional services
- Shopping and retail
- Travel and transportation
- Restaurant
companyLegalName:
question: What is the registered legal name of your company?
suggestedAnswers: []
companyRegistrationNumber:
question: What is the registration number of your company?
suggestedAnswers: []
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
messagesVolume:
question: What is the total volume of messages expected to be sent by your agent?
suggestedAnswers:
- 0 - 10K messages
- 10K - 100K messages
- 100K - 1M messages
- 1M+ messages
messagesFrequency:
question: How often do you expect to send messages?
suggestedAnswers:
- Once per day
- Once per week
- Once per month
- Once per 3 months
- Once per 6 months
campaignLength:
question: What will be the length of the RCS campaign?
suggestedAnswers:
- 1 day or less
- 2 to 7 days
- 8 to 21 days
- 1 month
- 3 months
- 6 months
- Continuous / ongoing
answers:
brandIndustry: Automotive
companyLegalName: Example company legal name
companyRegistrationNumber: 123-123456789
fullCompanyAddress: Skeppsbron 1 Malmö, 123 12, Sweden
messagesVolume: 10K - 100K messages
messagesFrequency: Once per month
fr:
questions:
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
siren:
question: What is your Company directory identification system number (SIREN)?
suggestedAnswers: []
answers:
fullCompanyAddress: Skeppsbron 1-split-211 20-split-Malmö
fullCompanyAddressMetadata:
ignore: -split-
siren: '123456789'
us:
questions:
ownershipType:
question: What is the ownership type of your company?
suggestedAnswers:
- PRIVATE
- PUBLIC
companyLegalName:
question: What is the registered legal name of your company?
suggestedAnswers: []
companyPhoneNumber:
question: What is the primary phone number of your company?
suggestedAnswers: []
companyEmailAddress:
question: What is the primary email address of your company?
suggestedAnswers: []
brandName:
question: What is your brand name or Doing Business As (DBA)?
suggestedAnswers: []
brandIndustry:
question: What sector or industry does your business operate in?
suggestedAnswers:
- AGRICULTURE
- COMMUNICATION
- CONSTRUCTION
- EDUCATION
- ENERGY
- ENTERTAINMENT
- FINANCIAL
- GAMBLING
- GOVERNMENT
- HEALTHCARE
- HOSPITALITY
- HUMAN_RESOURCES
- INSURANCE
- LEGAL
- MANUFACTURING
- NON_GOVERNMENTAL_ORGANIZATION
- POLITICAL
- POSTAL
- PROFESSIONAL
- REAL_ESTATE
- RETAIL
- TECHNOLOGY
- TRANSPORTATION
legalForm:
question: What is the legal form of your company?
suggestedAnswers:
- CORPORATION
- LIMITED_LIABILITY_COMPANY
- PARTNERSHIP
- S_CORPORATION
taxIdCountry:
question: In which country is your company's tax ID registered?
suggestedAnswers: []
taxId:
question: 'For non-US companies: what is the tax ID of your company?'
suggestedAnswers: []
addressLine:
question: What is the primary street address of your company?
suggestedAnswers: []
addressCity:
question: In which city is your company located?
suggestedAnswers: []
addressCountry:
question: In which country is your company located?
suggestedAnswers: []
addressState:
question: In which state is your company located?
suggestedAnswers: []
addressPostalCode:
question: What is the postal code for your company address?
suggestedAnswers: []
websiteUrl:
question: What is the primary website URL for your company?
suggestedAnswers: []
contactFirstName:
question: What is the first name of the responsible contact person for your company?
suggestedAnswers: []
contactSurname:
question: What is the surname of the responsible contact person for your company?
suggestedAnswers: []
stockExchange:
question: What is the primary home country stock exchange abbreviation?
suggestedAnswers: []
stockSymbol:
question: What is the primary home country stock symbol associated with the stock exchange?
suggestedAnswers: []
sampleMessages:
question: Please provide sample messages for each use case or message type sent by your brand.
suggestedAnswers: []
messagesVolume:
question: What is the expected message volume?
suggestedAnswers: []
embeddedLink:
question: Does your brand send messages that contain embedded links to external websites?
suggestedAnswers: []
embeddedPhone:
question: Does your brand send messages that contain embedded phone numbers for direct calling?
suggestedAnswers: []
ageGatedContent:
question: Does your brand send messages that contain age-gated content or require age verification?
suggestedAnswers: []
directLending:
question: Does your brand send messages that involve direct lending or financial services?
suggestedAnswers: []
optInConfirmationMessage:
question: Does your brand send opt-in confirmation messages to users who have subscribed to receive messages?
suggestedAnswers: []
helpMessage:
question: Does your brand send help messages that provide assistance or support information to users?
suggestedAnswers: []
callToActionMessage:
question: Does your brand send call-to-action messages that encourage users to take specific actions?
suggestedAnswers: []
answers:
ownershipType: PUBLIC
companyLegalName: Example company legal name
companyPhoneNumber: '+48777777777'
companyEmailAddress: email@example.com
brandName: Example brand name
brandIndustry: AGRICULTURE
legalForm: CORPORATION
taxIdCountry: US
taxId: 12-3456789
addressLine: 123 Main St
addressCity: Anytown
addressCountry: US
addressState: CA
addressPostalCode: '12345'
websiteUrl: https://example.com
contactFirstName: John
contactSurname: Doe
stockExchange: NASDAQ
stockSymbol: EXMPL
sampleMessages:
- Sample message 1 for the US questionnaire.
- Sample message 2 for the US questionnaire.
messagesVolume: 10000
embeddedLink: true
embeddedPhone: true
ageGatedContent: false
directLending: false
optInConfirmationMessage: Thank you for opting in!
helpMessage: For help, contact support.
callToActionMessage: Click here to claim your special offer and explore our latest updates now.
region: EU
billingCategory: CONVERSATIONAL
useCase: OTP
hostingRegion: EUROPE
authName: yurwN6123asd
authToken: ejiiqJtDyurwN6jLze8v
conversationApiApp: 4CF9CE97504C4A468F4610919D17ECC1
conversationApiAppDetails:
id: 4CF9CE97504C4A468F4610919D17ECC1
projectId: ea026751-3edf-40a9-ad93-1b382bd60a78
region: EU
channelStatus: ACTIVE
created: '2023-01-19t13:11:08.204Z'
modified: '2023-01-19t13:11:08.204Z'
launched: '2023-01-19t13:11:08.204Z'
supplierDetails:
google:
agentId: agentId
brandId: brandId
- id: cf11794a-6a5e-4a12-b103-da79bd378bf1
state: PREPARING_LAUNCH
testNumberStates:
- number: '+46123123111'
state: UNVERIFIED
submitted: '2023-01-19t13:11:08.204Z'
- number: '+46123123222'
state: VERIFIED
submitted: '2023-01-19t13:11:08.204Z'
- number: '+46123123333'
state: DECLINED
submitted: '2023-01-19t13:11:08.204Z'
countryStatus:
- country: FR
status: PENDING
operators:
- name: Coriolis Telecom
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Lycamobile
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Bouygues
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Free
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: NRJ Mobile
status: REJECTED
remark: Sender was rejected due to operator policy.
modified: '2023-01-19t13:11:08.204Z'
- name: SFR
status: SUSPENDED
modified: '2023-01-19t13:11:08.204Z'
- name: Orange
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- country: GB
status: PENDING
operators:
- name: EE
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Three
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Sky
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: O2
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Vodafone
status: SUSPENDED
modified: '2023-01-19t13:11:08.204Z'
- country: SE
status: PENDING
operators:
- name: Tele2
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Telenor
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Telia
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Three
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
details:
brand:
emails:
- label: label
address: test@test.com
- label: label-1
address: test-1@test.com
- label: label-2
address: test-2@test.com
phones:
- label: label
number: '+48777777777'
- label: label-1
number: '48888888888'
- label: label-2
number: '+48999999999'
websites:
- label: label
url: https://example.com
- label: label-1
url: https://example-1.com
- label: label-2
url: https://example-2.com
color: '#000000'
description: Test description
bannerUrl: https://example-banner-url.com
logoUrl: https://example-logo-url.com
privacyPolicyUrl: https://example-private-policy-url.com
termsOfServiceUrl: https://example-terms-of-service-url.com
name: Test name
testNumbers:
- '+48777777777'
countries:
- FR
- GB
- SE
questionnaire:
general:
questions:
optInDescription:
question: How do users agree to receive messages from your business through the agent?
suggestedAnswers:
- By subscribing to our loyalty program
- By making a purchase in-store or online
- By subscribing to a newsletter
- By creating an account on our website or app
triggerDescription:
question: When does your business send messages to users through the agent?
suggestedAnswers:
- User actions (e.g. after making a purchase)
interactionsDescription:
question: How will users interact with your business through the agent?
suggestedAnswers:
- Online Payment
- Password reset
- OTP/2FA for account login
optOutDescription:
question: What message does your business send when a user opts out?
suggestedAnswers:
- Thank you for opting out
- Thank you for unsubscribing
- We have registered your opt out request
videoUris:
question: ''
suggestedAnswers: []
screenshotUris:
question: ''
suggestedAnswers: []
answers:
optInDescription: By subscribing to a newsletter
triggerDescription: User actions (e.g. after making a purchase)
interactionsDescription: Billing or payment reminders,aef Order updates,aef Upon package delivery
interactionsDescriptionMetadata:
ignore: ',aef'
optOutDescription: We have registered your opt out request
videoUris:
- https://example-video-url.com
screenshotUris:
- https://example-screenshot-url.com
verification:
questions:
name:
question: What is the name of your verification contact?
suggestedAnswers: []
email:
question: What is the email of your verification contact?
suggestedAnswers: []
title:
question: What is the title of your verification contact?
suggestedAnswers: []
website:
question: What is the website of your verification contact?
suggestedAnswers: []
phone:
question: What is the phone number of your verification contact?
suggestedAnswers: []
partner:
companyName:
question: 'For ASP resellers: what is the name of the brand partner company?'
suggestedAnswers: []
contactName:
question: 'For ASP resellers: what is the name of the brand partner contact person?'
suggestedAnswers: []
contactEmailAddress:
question: 'For ASP resellers: what is the email of the brand partner contact person?'
suggestedAnswers: []
answers:
name: Exam Ple
email: email@example.com
title: Head Example
website: https://example.com
phone: '+48777777777'
partner:
companyName: Partner company
contactName: Partner contact name
contactEmailAddress: partner.contact@partner-company.com
gb:
questions:
brandIndustry:
question: What sector or industry does your business operate in?
suggestedAnswers:
- Automotive
- Beauty, spa and salon
- Clothing
- Education
- Entertainment
- Event planning and service
- Finance and banking
- Food and groceries
- Public service
- Hotel and lodging
- Medical and health
- Charity
- Professional services
- Shopping and retail
- Travel and transportation
- Restaurant
companyLegalName:
question: What is the registered legal name of your company?
suggestedAnswers: []
companyRegistrationNumber:
question: What is the registration number of your company?
suggestedAnswers: []
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
messagesVolume:
question: What is the total volume of messages expected to be sent by your agent?
suggestedAnswers:
- 0 - 10K messages
- 10K - 100K messages
- 100K - 1M messages
- 1M+ messages
messagesFrequency:
question: How often do you expect to send messages?
suggestedAnswers:
- Once per day
- Once per week
- Once per month
- Once per 3 months
- Once per 6 months
campaignLength:
question: What will be the length of the RCS campaign?
suggestedAnswers:
- 1 day or less
- 2 to 7 days
- 8 to 21 days
- 1 month
- 3 months
- 6 months
- Continuous / ongoing
answers:
brandIndustry: Automotive
companyLegalName: Example company legal name
companyRegistrationNumber: 123-123456789
fullCompanyAddress: Skeppsbron 1 Malmö, 123 12, Sweden
messagesVolume: 10K - 100K messages
messagesFrequency: Once per month
fr:
questions:
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
siren:
question: What is your Company directory identification system number (SIREN)?
suggestedAnswers: []
answers:
fullCompanyAddress: Skeppsbron 1-split-211 20-split-Malmö
fullCompanyAddressMetadata:
ignore: -split-
siren: '123456789'
us:
questions:
ownershipType:
question: What is the ownership type of your company?
suggestedAnswers:
- PRIVATE
- PUBLIC
companyLegalName:
question: What is the registered legal name of your company?
suggestedAnswers: []
companyPhoneNumber:
question: What is the primary phone number of your company?
suggestedAnswers: []
companyEmailAddress:
question: What is the primary email address of your company?
suggestedAnswers: []
brandName:
question: What is your brand name or Doing Business As (DBA)?
suggestedAnswers: []
brandIndustry:
question: What sector or industry does your business operate in?
suggestedAnswers:
- AGRICULTURE
- COMMUNICATION
- CONSTRUCTION
- EDUCATION
- ENERGY
- ENTERTAINMENT
- FINANCIAL
- GAMBLING
- GOVERNMENT
- HEALTHCARE
- HOSPITALITY
- HUMAN_RESOURCES
- INSURANCE
- LEGAL
- MANUFACTURING
- NON_GOVERNMENTAL_ORGANIZATION
- POLITICAL
- POSTAL
- PROFESSIONAL
- REAL_ESTATE
- RETAIL
- TECHNOLOGY
- TRANSPORTATION
legalForm:
question: What is the legal form of your company?
suggestedAnswers:
- CORPORATION
- LIMITED_LIABILITY_COMPANY
- PARTNERSHIP
- S_CORPORATION
taxIdCountry:
question: In which country is your company's tax ID registered?
suggestedAnswers: []
taxId:
question: 'For non-US companies: what is the tax ID of your company?'
suggestedAnswers: []
addressLine:
question: What is the primary street address of your company?
suggestedAnswers: []
addressCity:
question: In which city is your company located?
suggestedAnswers: []
addressCountry:
question: In which country is your company located?
suggestedAnswers: []
addressState:
question: In which state is your company located?
suggestedAnswers: []
addressPostalCode:
question: What is the postal code for your company address?
suggestedAnswers: []
websiteUrl:
question: What is the primary website URL for your company?
suggestedAnswers: []
contactFirstName:
question: What is the first name of the responsible contact person for your company?
suggestedAnswers: []
contactSurname:
question: What is the surname of the responsible contact person for your company?
suggestedAnswers: []
stockExchange:
question: What is the primary home country stock exchange abbreviation?
suggestedAnswers: []
stockSymbol:
question: What is the primary home country stock symbol associated with the stock exchange?
suggestedAnswers: []
sampleMessages:
question: Please provide sample messages for each use case or message type sent by your brand.
suggestedAnswers: []
messagesVolume:
question: What is the expected message volume?
suggestedAnswers: []
embeddedLink:
question: Does your brand send messages that contain embedded links to external websites?
suggestedAnswers: []
embeddedPhone:
question: Does your brand send messages that contain embedded phone numbers for direct calling?
suggestedAnswers: []
ageGatedContent:
question: Does your brand send messages that contain age-gated content or require age verification?
suggestedAnswers: []
directLending:
question: Does your brand send messages that involve direct lending or financial services?
suggestedAnswers: []
optInConfirmationMessage:
question: Does your brand send opt-in confirmation messages to users who have subscribed to receive messages?
suggestedAnswers: []
helpMessage:
question: Does your brand send help messages that provide assistance or support information to users?
suggestedAnswers: []
callToActionMessage:
question: Does your brand send call-to-action messages that encourage users to take specific actions?
suggestedAnswers: []
answers:
ownershipType: PUBLIC
companyLegalName: Example company legal name
companyPhoneNumber: '+48777777777'
companyEmailAddress: email@example.com
brandName: Example brand name
brandIndustry: AGRICULTURE
legalForm: CORPORATION
taxIdCountry: US
taxId: 12-3456789
addressLine: 123 Main St
addressCity: Anytown
addressCountry: US
addressState: CA
addressPostalCode: '12345'
websiteUrl: https://example.com
contactFirstName: John
contactSurname: Doe
stockExchange: NASDAQ
stockSymbol: EXMPL
sampleMessages:
- Sample message 1 for the US questionnaire.
- Sample message 2 for the US questionnaire.
messagesVolume: 10000
embeddedLink: true
embeddedPhone: true
ageGatedContent: false
directLending: false
optInConfirmationMessage: Thank you for opting in!
helpMessage: For help, contact support.
callToActionMessage: Click here to claim your special offer and explore our latest updates now.
region: EU
billingCategory: CONVERSATIONAL
useCase: OTP
hostingRegion: EUROPE
authName: yurwN6123asd
authToken: ejiiqJtDyurwN6jLze8v
conversationApiApp: 4CF9CE97504C4A468F4610919D17ECC1
conversationApiAppDetails:
id: 4CF9CE97504C4A468F4610919D17ECC1
projectId: ea026751-3edf-40a9-ad93-1b382bd60a78
region: EU
channelStatus: ACTIVE
created: '2023-01-19t13:11:08.204Z'
modified: '2023-01-19t13:11:08.204Z'
launched: '2023-01-19t13:11:08.204Z'
supplierDetails:
google:
agentId: agentId
brandId: brandId
response:
summary: '[Deprecated] List response'
description: "\n Response with senders.\n "
value:
totalSize: 2
pageSize: 50
senders:
- id: cf11794a-6a5e-4a12-b103-da79bd378bf1
state: IN_TEST
testNumberStates:
- number: '+46123123111'
state: UNVERIFIED
submitted: '2023-01-19t13:11:08.204Z'
- number: '+46123123222'
state: VERIFIED
submitted: '2023-01-19t13:11:08.204Z'
- number: '+46123123333'
state: DECLINED
submitted: '2023-01-19t13:11:08.204Z'
countryStatus:
- country: FR
status: NOT_LAUNCHED
operators:
- name: Coriolis Telecom
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Lycamobile
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Bouygues
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Free
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: NRJ Mobile
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: SFR
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Orange
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- country: GB
status: NOT_LAUNCHED
operators:
- name: EE
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Three
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Sky
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: O2
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Vodafone
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- country: SE
status: NOT_LAUNCHED
operators:
- name: Tele2
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Telenor
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Telia
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Three
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
details:
brand:
emails:
- label: label
address: test@test.com
- label: label-1
address: test-1@test.com
- label: label-2
address: test-2@test.com
phones:
- label: label
number: '+48777777777'
- label: label-1
number: '48888888888'
- label: label-2
number: '+48999999999'
websites:
- label: label
url: https://example.com
- label: label-1
url: https://example-1.com
- label: label-2
url: https://example-2.com
color: '#000000'
description: Test description
bannerUrl: https://example-banner-url.com
logoUrl: https://example-logo-url.com
privacyPolicyUrl: https://example-private-policy-url.com
termsOfServiceUrl: https://example-terms-of-service-url.com
name: Test name
testNumbers:
- '+48777777777'
countries:
- FR
- GB
- SE
questionnaire:
general:
questions:
optInDescription:
question: How do users agree to receive messages from your business through the agent?
suggestedAnswers:
- By subscribing to our loyalty program
- By making a purchase in-store or online
- By subscribing to a newsletter
- By creating an account on our website or app
triggerDescription:
question: When does your business send messages to users through the agent?
suggestedAnswers:
- User actions (e.g. after making a purchase)
interactionsDescription:
question: How will users interact with your business through the agent?
suggestedAnswers:
- Online Payment
- Password reset
- OTP/2FA for account login
optOutDescription:
question: What message does your business send when a user opts out?
suggestedAnswers:
- Thank you for opting out
- Thank you for unsubscribing
- We have registered your opt out request
videoUris:
question: ''
suggestedAnswers: []
screenshotUris:
question: ''
suggestedAnswers: []
answers:
optInDescription: By subscribing to a newsletter
triggerDescription: User actions (e.g. after making a purchase)
interactionsDescription: Billing or payment reminders,aef Order updates,aef Upon package delivery
interactionsDescriptionMetadata:
ignore: ',aef'
optOutDescription: We have registered your opt out request
videoUris:
- https://example-video-url.com
screenshotUris:
- https://example-screenshot-url.com
verification:
questions:
name:
question: What is the name of your verification contact?
suggestedAnswers: []
email:
question: What is the email of your verification contact?
suggestedAnswers: []
title:
question: What is the title of your verification contact?
suggestedAnswers: []
website:
question: What is the website of your verification contact?
suggestedAnswers: []
phone:
question: What is the phone number of your verification contact?
suggestedAnswers: []
partner:
companyName:
question: 'For ASP resellers: what is the name of the brand partner company?'
suggestedAnswers: []
contactName:
question: 'For ASP resellers: what is the name of the brand partner contact person?'
suggestedAnswers: []
contactEmailAddress:
question: 'For ASP resellers: what is the email of the brand partner contact person?'
suggestedAnswers: []
answers:
name: Exam Ple
email: email@example.com
title: Head Example
website: https://example.com
phone: '+48777777777'
partner:
companyName: Partner company
contactName: Partner contact name
contactEmailAddress: partner.contact@partner-company.com
gb:
questions:
brandIndustry:
question: What sector or industry does your business operate in?
suggestedAnswers:
- Automotive
- Beauty, spa and salon
- Clothing
- Education
- Entertainment
- Event planning and service
- Finance and banking
- Food and groceries
- Public service
- Hotel and lodging
- Medical and health
- Charity
- Professional services
- Shopping and retail
- Travel and transportation
- Restaurant
companyLegalName:
question: What is the registered legal name of your company?
suggestedAnswers: []
companyRegistrationNumber:
question: What is the registration number of your company?
suggestedAnswers: []
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
messagesVolume:
question: What is the total volume of messages expected to be sent by your agent?
suggestedAnswers:
- 0 - 10K messages
- 10K - 100K messages
- 100K - 1M messages
- 1M+ messages
messagesFrequency:
question: How often do you expect to send messages?
suggestedAnswers:
- Once per day
- Once per week
- Once per month
- Once per 3 months
- Once per 6 months
campaignLength:
question: What will be the length of the RCS campaign?
suggestedAnswers:
- 1 day or less
- 2 to 7 days
- 8 to 21 days
- 1 month
- 3 months
- 6 months
- Continuous / ongoing
answers:
brandIndustry: Automotive
companyLegalName: Example company legal name
companyRegistrationNumber: 123-123456789
fullCompanyAddress: Skeppsbron 1 Malmö, 123 12, Sweden
messagesVolume: 10K - 100K messages
messagesFrequency: Once per month
fr:
questions:
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
siren:
question: What is your Company directory identification system number (SIREN)?
suggestedAnswers: []
answers:
fullCompanyAddress: Skeppsbron 1-split-211 20-split-Malmö
fullCompanyAddressMetadata:
ignore: -split-
siren: '123456789'
us:
questions:
companyLegalName:
question: What is the registered legal name of your company?
suggestedAnswers: []
ein:
question: What is the Employer Identification Number (EIN) of your company?
suggestedAnswers: []
brandIndustry:
question: What sector or industry does your business operate in?
suggestedAnswers:
- Automotive
- Beauty, spa and salon
- Clothing
- Education
- Entertainment
- Event planning and service
- Finance and banking
- Food and groceries
- Public service
- Hotel and lodging
- Medical and health
- Charity
- Professional services
- Shopping and retail
- Travel and transportation
- Restaurant
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
smsCampaign:
question: US SMS campaign used as fallback.
suggestedAnswers: []
messagesVolume:
question: What is the total volume of messages expected to be sent by your agent?
suggestedAnswers:
- 0 - 10K messages
- 10K - 100K messages
- 100K - 1M messages
- 1M+ messages
answers:
companyLegalName: Example company legal name
ein: 12-3456789
brandIndustry: Automotive
fullCompanyAddress: Skeppsbron 1-split-211 20-split-Malmö
fullCompanyAddressMetadata:
ignore: -split-
smsCampaign: We have registered your opt out request
messagesVolume: 10K - 100K messages
region: EU
billingCategory: CONVERSATIONAL
useCase: OTP
hostingRegion: EUROPE
authName: yurwN6123asd
authToken: ejiiqJtDyurwN6jLze8v
conversationApiApp: 4CF9CE97504C4A468F4610919D17ECC1
conversationApiAppDetails:
id: 4CF9CE97504C4A468F4610919D17ECC1
projectId: ea026751-3edf-40a9-ad93-1b382bd60a78
region: EU
channelStatus: ACTIVE
created: '2023-01-19t13:11:08.204Z'
modified: '2023-01-19t13:11:08.204Z'
launched: '2023-01-19t13:11:08.204Z'
supplierDetails:
google:
agentId: agentId
brandId: brandId
- id: cf11794a-6a5e-4a12-b103-da79bd378bf1
state: PREPARING_LAUNCH
testNumberStates:
- number: '+46123123111'
state: UNVERIFIED
submitted: '2023-01-19t13:11:08.204Z'
- number: '+46123123222'
state: VERIFIED
submitted: '2023-01-19t13:11:08.204Z'
- number: '+46123123333'
state: DECLINED
submitted: '2023-01-19t13:11:08.204Z'
countryStatus:
- country: FR
status: PENDING
operators:
- name: Coriolis Telecom
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Lycamobile
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Bouygues
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Free
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: NRJ Mobile
status: REJECTED
remark: Sender was rejected due to operator policy.
modified: '2023-01-19t13:11:08.204Z'
- name: SFR
status: SUSPENDED
modified: '2023-01-19t13:11:08.204Z'
- name: Orange
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- country: GB
status: PENDING
operators:
- name: EE
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Three
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Sky
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: O2
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Vodafone
status: SUSPENDED
modified: '2023-01-19t13:11:08.204Z'
- country: SE
status: PENDING
operators:
- name: Tele2
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Telenor
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Telia
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Three
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
details:
brand:
emails:
- label: label
address: test@test.com
- label: label-1
address: test-1@test.com
- label: label-2
address: test-2@test.com
phones:
- label: label
number: '+48777777777'
- label: label-1
number: '48888888888'
- label: label-2
number: '+48999999999'
websites:
- label: label
url: https://example.com
- label: label-1
url: https://example-1.com
- label: label-2
url: https://example-2.com
color: '#000000'
description: Test description
bannerUrl: https://example-banner-url.com
logoUrl: https://example-logo-url.com
privacyPolicyUrl: https://example-private-policy-url.com
termsOfServiceUrl: https://example-terms-of-service-url.com
name: Test name
testNumbers:
- '+48777777777'
countries:
- FR
- GB
- SE
questionnaire:
general:
questions:
optInDescription:
question: How do users agree to receive messages from your business through the agent?
suggestedAnswers:
- By subscribing to our loyalty program
- By making a purchase in-store or online
- By subscribing to a newsletter
- By creating an account on our website or app
triggerDescription:
question: When does your business send messages to users through the agent?
suggestedAnswers:
- User actions (e.g. after making a purchase)
interactionsDescription:
question: How will users interact with your business through the agent?
suggestedAnswers:
- Online Payment
- Password reset
- OTP/2FA for account login
optOutDescription:
question: What message does your business send when a user opts out?
suggestedAnswers:
- Thank you for opting out
- Thank you for unsubscribing
- We have registered your opt out request
videoUris:
question: ''
suggestedAnswers: []
screenshotUris:
question: ''
suggestedAnswers: []
answers:
optInDescription: By subscribing to a newsletter
triggerDescription: User actions (e.g. after making a purchase)
interactionsDescription: Billing or payment reminders,aef Order updates,aef Upon package delivery
interactionsDescriptionMetadata:
ignore: ',aef'
optOutDescription: We have registered your opt out request
videoUris:
- https://example-video-url.com
screenshotUris:
- https://example-screenshot-url.com
verification:
questions:
name:
question: What is the name of your verification contact?
suggestedAnswers: []
email:
question: What is the email of your verification contact?
suggestedAnswers: []
title:
question: What is the title of your verification contact?
suggestedAnswers: []
website:
question: What is the website of your verification contact?
suggestedAnswers: []
phone:
question: What is the phone number of your verification contact?
suggestedAnswers: []
partner:
companyName:
question: 'For ASP resellers: what is the name of the brand partner company?'
suggestedAnswers: []
contactName:
question: 'For ASP resellers: what is the name of the brand partner contact person?'
suggestedAnswers: []
contactEmailAddress:
question: 'For ASP resellers: what is the email of the brand partner contact person?'
suggestedAnswers: []
answers:
name: Exam Ple
email: email@example.com
title: Head Example
website: https://example.com
phone: '+48777777777'
partner:
companyName: Partner company
contactName: Partner contact name
contactEmailAddress: partner.contact@partner-company.com
gb:
questions:
brandIndustry:
question: What sector or industry does your business operate in?
suggestedAnswers:
- Automotive
- Beauty, spa and salon
- Clothing
- Education
- Entertainment
- Event planning and service
- Finance and banking
- Food and groceries
- Public service
- Hotel and lodging
- Medical and health
- Charity
- Professional services
- Shopping and retail
- Travel and transportation
- Restaurant
companyLegalName:
question: What is the registered legal name of your company?
suggestedAnswers: []
companyRegistrationNumber:
question: What is the registration number of your company?
suggestedAnswers: []
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
messagesVolume:
question: What is the total volume of messages expected to be sent by your agent?
suggestedAnswers:
- 0 - 10K messages
- 10K - 100K messages
- 100K - 1M messages
- 1M+ messages
messagesFrequency:
question: How often do you expect to send messages?
suggestedAnswers:
- Once per day
- Once per week
- Once per month
- Once per 3 months
- Once per 6 months
campaignLength:
question: What will be the length of the RCS campaign?
suggestedAnswers:
- 1 day or less
- 2 to 7 days
- 8 to 21 days
- 1 month
- 3 months
- 6 months
- Continuous / ongoing
answers:
brandIndustry: Automotive
companyLegalName: Example company legal name
companyRegistrationNumber: 123-123456789
fullCompanyAddress: Skeppsbron 1 Malmö, 123 12, Sweden
messagesVolume: 10K - 100K messages
messagesFrequency: Once per month
fr:
questions:
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
siren:
question: What is your Company directory identification system number (SIREN)?
suggestedAnswers: []
answers:
fullCompanyAddress: Skeppsbron 1-split-211 20-split-Malmö
fullCompanyAddressMetadata:
ignore: -split-
siren: '123456789'
us:
questions:
companyLegalName:
question: What is the registered legal name of your company?
suggestedAnswers: []
ein:
question: What is the Employer Identification Number (EIN) of your company?
suggestedAnswers: []
brandIndustry:
question: What sector or industry does your business operate in?
suggestedAnswers:
- Automotive
- Beauty, spa and salon
- Clothing
- Education
- Entertainment
- Event planning and service
- Finance and banking
- Food and groceries
- Public service
- Hotel and lodging
- Medical and health
- Charity
- Professional services
- Shopping and retail
- Travel and transportation
- Restaurant
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
smsCampaign:
question: US SMS campaign used as fallback.
suggestedAnswers: []
messagesVolume:
question: What is the total volume of messages expected to be sent by your agent?
suggestedAnswers:
- 0 - 10K messages
- 10K - 100K messages
- 100K - 1M messages
- 1M+ messages
answers:
companyLegalName: Example company legal name
ein: 12-3456789
brandIndustry: Automotive
fullCompanyAddress: Skeppsbron 1-split-211 20-split-Malmö
fullCompanyAddressMetadata:
ignore: -split-
smsCampaign: We have registered your opt out request
messagesVolume: 10K - 100K messages
region: EU
billingCategory: CONVERSATIONAL
useCase: OTP
hostingRegion: EUROPE
authName: yurwN6123asd
authToken: ejiiqJtDyurwN6jLze8v
conversationApiApp: 4CF9CE97504C4A468F4610919D17ECC1
conversationApiAppDetails:
id: 4CF9CE97504C4A468F4610919D17ECC1
projectId: ea026751-3edf-40a9-ad93-1b382bd60a78
region: EU
channelStatus: ACTIVE
created: '2023-01-19t13:11:08.204Z'
modified: '2023-01-19t13:11:08.204Z'
launched: '2023-01-19t13:11:08.204Z'
supplierDetails:
google:
agentId: agentId
brandId: brandId
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
invalid_page_token-0:
summary: InvalidPageTokenError
value:
errorCode: invalid_page_token
message: Invalid page token.
resolution: The page token to use is provided in the previous query response, for new queries simply leave this field undefined.
invalid_page_size-1:
summary: InvalidPageSizeError
value:
errorCode: invalid_page_size
message: Page size must be numeric.
resolution: Use a integer value for pageSize parameter.
invalid_filter_states-2:
summary: InvalidFilterStatesError
value:
errorCode: invalid_filter_states
message: Invalid filterStates.
resolution: Verify that the filterStates used are supported by the Provisioning API.
additionalInformation:
supportedCodes: DRAFT, IN_PROGRESS, IN_TEST, LAUNCHED, LAUNCHING, PREPARING_LAUNCH, UNLAUNCHED, UNKNOWN
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
unauthorized_error-0:
summary: UnauthorizedErrorError
value:
errorCode: unauthorized_error
message: Unauthorized error.
resolution: Verify that projectId is correct.
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
rbm_has_not_been_used-0:
summary: RbmHasNotBeenUsedError
value:
errorCode: rbm_has_not_been_used
message: RBM has not been used.
resolution: Please wait and try again or reach out to support at si-richmessaging@sinch.com
'429':
description: TooManyRequests
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
rbm_too_many_requests-0:
summary: RbmTooManyRequestsError
value:
errorCode: rbm_too_many_requests
message: RCS Business Messaging too many requests.
resolution: Please wait and try again.
'500':
description: InternalServerError
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
internal_error-0:
summary: InternalErrorError
value:
errorCode: internal_error
message: Internal server error.
resolution: Please wait and try again, if the error persist please contact support.
summary: List all senders in project
tags:
- RCS Senders
x-badges:
- name: GA
position: after
color: green
security:
- BasicAuth: []
BearerAuth: []
OAuth2Production: []
post:
callbacks:
StatusUpdate:
'{$request.body#webhooks.target}':
post:
summary: Sender status updated
description: "\n Received when a Sender status is updated.\n "
parameters:
- in: header
name: x-sinch-webhook-signature
schema:
type: string
format: SHA256-hash
example: Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8=
- in: header
name: x-sinch-webhook-signature-algorithm
schema:
type: string
const: HmacSHA256
x-enumDescriptions:
HmacSHA256: The HMAC SHA-256 signature algorithm used to validate webhook authenticity.
uniqueItems: false
example: HmacSHA256
- in: header
name: x-sinch-webhook-signature-nonce
schema:
type: string
example: 01EAW2BNWCG9DC13RS582V0ZQ3
- in: header
name: x-sinch-webhook-signature-timestamp
schema:
type: string
format: timestamp
example: '1592227387'
requestBody:
content:
application/json:
schema:
type: object
properties:
type:
description: Type of event, in this case `RCS_SENDER_STATUS_UPDATED`.
type: string
payload:
description: Sender at time of callback.
allOf:
- $ref: '#/components/schemas/RcsSenderDto'
previousState:
description: The previous state of the sender.
type: string
enum:
- DRAFT
- IN_PROGRESS
- IN_TEST
- LAUNCHED
- LAUNCHING
- PREPARING_LAUNCH
- UNLAUNCHED
- UNKNOWN
x-enumDescriptions:
DRAFT: The sender configuration is saved as a draft.
IN_PROGRESS: The sender registration or setup is currently in progress.
IN_TEST: The sender is currently undergoing testing.
LAUNCHED: The sender has been successfully launched.
LAUNCHING: The sender launch sequence is currently executing.
PREPARING_LAUNCH: The sender configuration is being prepared for launch.
UNLAUNCHED: The sender has been unlaunched and is disabled.
UNKNOWN: The current state of the sender cannot be determined.
currentState:
description: The current state of the sender.
type: string
enum:
- DRAFT
- IN_PROGRESS
- IN_TEST
- LAUNCHED
- LAUNCHING
- PREPARING_LAUNCH
- UNLAUNCHED
- UNKNOWN
x-enumDescriptions:
DRAFT: The sender configuration is saved as a draft.
IN_PROGRESS: The sender registration or setup is currently in progress.
IN_TEST: The sender is currently undergoing testing.
LAUNCHED: The sender has been successfully launched.
LAUNCHING: The sender launch sequence is currently executing.
PREPARING_LAUNCH: The sender configuration is being prepared for launch.
UNLAUNCHED: The sender has been unlaunched and is disabled.
UNKNOWN: The current state of the sender cannot be determined.
comment:
description: Comment for sender.
type: string
required:
- type
- payload
- previousState
- currentState
example:
type: RCS_SENDER_STATUS_UPDATED
payload:
id: cf11794a-6a5e-4a12-b103-da79bd378bf1
state: IN_TEST
testNumberStates:
- number: '+46123123111'
state: UNVERIFIED
submitted: '2023-01-19t13:11:08.204Z'
- number: '+46123123222'
state: VERIFIED
submitted: '2023-01-19t13:11:08.204Z'
- number: '+46123123333'
state: DECLINED
submitted: '2023-01-19t13:11:08.204Z'
countryStatus:
- country: FR
status: NOT_LAUNCHED
operators:
- name: Coriolis Telecom
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Lycamobile
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Bouygues
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Free
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: NRJ Mobile
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: SFR
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Orange
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- country: GB
status: NOT_LAUNCHED
operators:
- name: EE
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Three
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Sky
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: O2
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Vodafone
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- country: SE
status: NOT_LAUNCHED
operators:
- name: Tele2
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Telenor
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Telia
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Three
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
details:
brand:
emails:
- label: label
address: test@test.com
- label: label-1
address: test-1@test.com
- label: label-2
address: test-2@test.com
phones:
- label: label
number: '+48777777777'
- label: label-1
number: '48888888888'
- label: label-2
number: '+48999999999'
websites:
- label: label
url: https://example.com
- label: label-1
url: https://example-1.com
- label: label-2
url: https://example-2.com
color: '#000000'
description: Test description
bannerUrl: https://example-banner-url.com
logoUrl: https://example-logo-url.com
privacyPolicyUrl: https://example-private-policy-url.com
termsOfServiceUrl: https://example-terms-of-service-url.com
name: Test name
testNumbers:
- '+48777777777'
countries:
- FR
- GB
- SE
questionnaire:
general:
questions:
optInDescription:
question: How do users agree to receive messages from your business through the agent?
suggestedAnswers:
- By subscribing to our loyalty program
- By making a purchase in-store or online
- By subscribing to a newsletter
- By creating an account on our website or app
triggerDescription:
question: When does your business send messages to users through the agent?
suggestedAnswers:
- User actions (e.g. after making a purchase)
interactionsDescription:
question: How will users interact with your business through the agent?
suggestedAnswers:
- Online Payment
- Password reset
- OTP/2FA for account login
optOutDescription:
question: What message does your business send when a user opts out?
suggestedAnswers:
- Thank you for opting out
- Thank you for unsubscribing
- We have registered your opt out request
videoUris:
question: ''
suggestedAnswers: []
screenshotUris:
question: ''
suggestedAnswers: []
answers:
optInDescription: By subscribing to a newsletter
triggerDescription: User actions (e.g. after making a purchase)
interactionsDescription: Billing or payment reminders,aef Order updates,aef Upon package delivery
interactionsDescriptionMetadata:
ignore: ',aef'
optOutDescription: We have registered your opt out request
videoUris:
- https://example-video-url.com
screenshotUris:
- https://example-screenshot-url.com
verification:
questions:
name:
question: What is the name of your verification contact?
suggestedAnswers: []
email:
question: What is the email of your verification contact?
suggestedAnswers: []
title:
question: What is the title of your verification contact?
suggestedAnswers: []
website:
question: What is the website of your verification contact?
suggestedAnswers: []
phone:
question: What is the phone number of your verification contact?
suggestedAnswers: []
partner:
companyName:
question: 'For ASP resellers: what is the name of the brand partner company?'
suggestedAnswers: []
contactName:
question: 'For ASP resellers: what is the name of the brand partner contact person?'
suggestedAnswers: []
contactEmailAddress:
question: 'For ASP resellers: what is the email of the brand partner contact person?'
suggestedAnswers: []
answers:
name: Exam Ple
email: email@example.com
title: Head Example
website: https://example.com
phone: '+48777777777'
partner:
companyName: Partner company
contactName: Partner contact name
contactEmailAddress: partner.contact@partner-company.com
gb:
questions:
brandIndustry:
question: What sector or industry does your business operate in?
suggestedAnswers:
- Automotive
- Beauty, spa and salon
- Clothing
- Education
- Entertainment
- Event planning and service
- Finance and banking
- Food and groceries
- Public service
- Hotel and lodging
- Medical and health
- Charity
- Professional services
- Shopping and retail
- Travel and transportation
- Restaurant
companyLegalName:
question: What is the registered legal name of your company?
suggestedAnswers: []
companyRegistrationNumber:
question: What is the registration number of your company?
suggestedAnswers: []
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
messagesVolume:
question: What is the total volume of messages expected to be sent by your agent?
suggestedAnswers:
- 0 - 10K messages
- 10K - 100K messages
- 100K - 1M messages
- 1M+ messages
messagesFrequency:
question: How often do you expect to send messages?
suggestedAnswers:
- Once per day
- Once per week
- Once per month
- Once per 3 months
- Once per 6 months
campaignLength:
question: What will be the length of the RCS campaign?
suggestedAnswers:
- 1 day or less
- 2 to 7 days
- 8 to 21 days
- 1 month
- 3 months
- 6 months
- Continuous / ongoing
answers:
brandIndustry: Automotive
companyLegalName: Example company legal name
companyRegistrationNumber: 123-123456789
fullCompanyAddress: Skeppsbron 1 Malmö, 123 12, Sweden
messagesVolume: 10K - 100K messages
messagesFrequency: Once per month
fr:
questions:
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
siren:
question: What is your Company directory identification system number (SIREN)?
suggestedAnswers: []
answers:
fullCompanyAddress: Skeppsbron 1-split-211 20-split-Malmö
fullCompanyAddressMetadata:
ignore: -split-
siren: '123456789'
us:
questions:
companyLegalName:
question: What is the registered legal name of your company?
suggestedAnswers: []
ein:
question: What is the Employer Identification Number (EIN) of your company?
suggestedAnswers: []
brandIndustry:
question: What sector or industry does your business operate in?
suggestedAnswers:
- Automotive
- Beauty, spa and salon
- Clothing
- Education
- Entertainment
- Event planning and service
- Finance and banking
- Food and groceries
- Public service
- Hotel and lodging
- Medical and health
- Charity
- Professional services
- Shopping and retail
- Travel and transportation
- Restaurant
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
smsCampaign:
question: US SMS campaign used as fallback.
suggestedAnswers: []
messagesVolume:
question: What is the total volume of messages expected to be sent by your agent?
suggestedAnswers:
- 0 - 10K messages
- 10K - 100K messages
- 100K - 1M messages
- 1M+ messages
answers:
companyLegalName: Example company legal name
ein: 12-3456789
brandIndustry: Automotive
fullCompanyAddress: Skeppsbron 1-split-211 20-split-Malmö
fullCompanyAddressMetadata:
ignore: -split-
smsCampaign: We have registered your opt out request
messagesVolume: 10K - 100K messages
region: EU
billingCategory: CONVERSATIONAL
useCase: OTP
hostingRegion: EUROPE
authName: yurwN6123asd
authToken: ejiiqJtDyurwN6jLze8v
conversationApiApp: 4CF9CE97504C4A468F4610919D17ECC1
conversationApiAppDetails:
id: 4CF9CE97504C4A468F4610919D17ECC1
projectId: ea026751-3edf-40a9-ad93-1b382bd60a78
region: EU
channelStatus: ACTIVE
created: '2023-01-19t13:11:08.204Z'
modified: '2023-01-19t13:11:08.204Z'
launched: '2023-01-19t13:11:08.204Z'
supplierDetails:
google:
agentId: agentId
brandId: brandId
previousState: IN_PROGRESS
currentState: IN_TEST
responses:
'200':
description: Response to callback will be ignored. The call will retry if unsuccessful.
OperatorStatusUpdate:
'{$request.body#webhooks.target}':
post:
summary: Sender operator status updated
description: "\n Received when sender operator status is updated.\n "
parameters:
- in: header
name: x-sinch-webhook-signature
schema:
type: string
format: SHA256-hash
example: Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8=
- in: header
name: x-sinch-webhook-signature-algorithm
schema:
type: string
const: HmacSHA256
x-enumDescriptions:
HmacSHA256: The HMAC SHA-256 signature algorithm used to validate webhook authenticity.
uniqueItems: false
example: HmacSHA256
- in: header
name: x-sinch-webhook-signature-nonce
schema:
type: string
example: 01EAW2BNWCG9DC13RS582V0ZQ3
- in: header
name: x-sinch-webhook-signature-timestamp
schema:
type: string
format: timestamp
example: '1592227387'
requestBody:
content:
application/json:
schema:
type: object
properties:
type:
description: Type of event, in this case `RCS_SENDER_OPERATOR_STATUS_UPDATED`.
type: string
payload:
description: Sender at time of callback.
allOf:
- $ref: '#/components/schemas/RcsSenderDto'
operator:
description: Operator.
type: string
enum:
- 1und1
- '3'
- 9 Mobile
- A1
- Africell
- Airtel
- Altan
- AT&T
- Bell
- Bouygues
- BSNL
- C-Spire
- Cell C
- Claro
- Coriolis Telecom
- Cosmote
- Deutsche Telekom
- Dialog Axiata PLC
- Digi
- DISH Wireless
- DNA
- Eastlink
- EE
- Elisa
- Entel
- Ethio Telecom
- Fizz
- Free
- Freedom
- Glo
- Google Fi
- Hrvatski Telecom
- Hutchison 3G
- Iliad
- Indosat Ooredoo Hutchison
- JIO
- KDDI
- Kpn
- Kyivstar
- Lebara Mobile
- Legos
- lifecell
- Lycamobile
- M1
- Magenta
- MEO
- MobiFone
- Movistar
- MTN
- NOS
- NRJ Mobile
- NTTDocomo
- O2
- Odido
- Ooredoo
- Orange
- Personal
- Proximus
- Reliance JIO
- Robi Axiata
- Rogers
- Sasktel
- SFR
- Simba
- Singtel
- Sky
- Smart
- Smartfren
- Softbank
- Spectrum
- Starhub
- Swisscom
- T-Mobile
- Telcel
- Tele2
- Telefonica
- Telekom
- Telenet
- Telenor
- Telia
- Telkom
- Telkomsel
- Telus
- Three
- TIM
- TracFone
- US Cellular
- Verizon
- Videotron
- Vivo
- Vodacom
- Vodafone
- Vodafone Idea
- WindTre
- Xfinity
- XL
- Yoigo
- Unrecognized
x-enumDescriptions:
'3': The 3 (Three) mobile network operator.
1und1: The 1und1 mobile network operator.
9 Mobile: The 9Mobile network operator.
A1: The A1 Telekom Austria mobile network operator.
Africell: The Africell mobile network operator.
Airtel: The Airtel mobile network operator.
Altan: The Altan Redes mobile network operator.
AT&T: The AT&T mobile network operator.
Bell: The Bell Canada mobile network operator.
Bouygues: The Bouygues Telecom mobile network operator.
BSNL: The BSNL (Bharat Sanchar Nigam Limited) mobile network operator.
C-Spire: The C-Spire mobile network operator.
Cell C: The Cell C mobile network operator.
Claro: The Claro mobile network operator.
Coriolis Telecom: The Coriolis Telecom mobile network operator.
Cosmote: The Cosmote mobile network operator.
Deutsche Telekom: The Deutsche Telekom mobile network operator.
Dialog Axiata PLC: The Dialog Axiata PLC mobile network operator.
Digi: The Digi mobile network operator.
DISH Wireless: The DISH Wireless mobile network operator.
DNA: The DNA mobile network operator.
Eastlink: The Eastlink mobile network operator.
EE: The EE (Everything Everywhere) mobile network operator.
Elisa: The Elisa mobile network operator.
Entel: The Entel mobile network operator.
Ethio Telecom: The Ethio Telecom mobile network operator.
Fizz: The Fizz mobile network operator.
Free: The Free Mobile network operator.
Freedom: The Freedom Mobile network operator.
Glo: The Glo (Globacom) mobile network operator.
Google Fi: The Google Fi virtual mobile network operator.
Hrvatski Telecom: The Hrvatski Telekom mobile network operator.
Hutchison 3G: The Hutchison 3G mobile network operator.
Iliad: The Iliad mobile network operator.
Indosat Ooredoo Hutchison: The Indosat Ooredoo Hutchison mobile network operator.
JIO: The Jio (Reliance Jio) mobile network operator.
KDDI: The KDDI mobile network operator.
Kpn: The KPN mobile network operator.
Kyivstar: The Kyivstar mobile network operator.
Lebara Mobile: The Lebara Mobile virtual network operator.
Legos: The Legos mobile network operator.
lifecell: The lifecell mobile network operator.
Lycamobile: The Lycamobile virtual network operator.
M1: The M1 mobile network operator.
Magenta: The Magenta Telekom mobile network operator.
MEO: The MEO mobile network operator.
MobiFone: The MobiFone mobile network operator.
Movistar: The Movistar mobile network operator.
MTN: The MTN Group mobile network operator.
NOS: The NOS mobile network operator.
NRJ Mobile: The NRJ Mobile virtual network operator.
NTTDocomo: The NTT Docomo mobile network operator.
O2: The O2 mobile network operator.
Odido: The Odido mobile network operator.
Ooredoo: The Ooredoo mobile network operator.
Orange: The Orange mobile network operator.
Personal: The Personal mobile network operator.
Proximus: The Proximus mobile network operator.
Reliance JIO: The Reliance Jio mobile network operator.
Robi Axiata: The Robi Axiata mobile network operator.
Rogers: The Rogers Communications mobile network operator.
Sasktel: The SaskTel mobile network operator.
SFR: The SFR mobile network operator.
Simba: The Simba Telecom mobile network operator.
Singtel: The Singtel mobile network operator.
Sky: The Sky Mobile virtual network operator.
Smart: The Smart Communications mobile network operator.
Smartfren: The Smartfren mobile network operator.
Softbank: The SoftBank mobile network operator.
Spectrum: The Spectrum Mobile virtual network operator.
Starhub: The StarHub mobile network operator.
Swisscom: The Swisscom mobile network operator.
T-Mobile: The T-Mobile mobile network operator.
Telcel: The Telcel mobile network operator.
Tele2: The Tele2 mobile network operator.
Telefonica: The Telefónica mobile network operator.
Telekom: The Telekom mobile network operator.
Telenet: The Telenet mobile network operator.
Telenor: The Telenor mobile network operator.
Telia: The Telia mobile network operator.
Telkom: The Telkom mobile network operator.
Telkomsel: The Telkomsel mobile network operator.
Telus: The Telus mobile network operator.
Three: The Three mobile network operator.
TIM: The TIM (Telecom Italia Mobile) network operator.
TracFone: The TracFone virtual mobile network operator.
US Cellular: The UScellular mobile network operator.
Verizon: The Verizon Wireless mobile network operator.
Videotron: The Videotron mobile network operator.
Vivo: The Vivo mobile network operator.
Vodacom: The Vodacom mobile network operator.
Vodafone: The Vodafone mobile network operator.
Vodafone Idea: The Vodafone Idea mobile network operator.
WindTre: The Wind Tre mobile network operator.
Xfinity: The Xfinity Mobile virtual network operator.
XL: The XL Axiata mobile network operator.
Yoigo: The Yoigo mobile network operator.
Unrecognized: The value returned by an upstream system is not recognized by this API version.
operatorCountry:
description: Two-letter country code in ISO 3166 standard.
type: string
enum:
- AD
- AE
- AF
- AG
- AI
- AL
- AM
- AO
- AQ
- AR
- AS
- AT
- AU
- AW
- AZ
- BA
- BB
- BD
- BE
- BF
- BG
- BH
- BI
- BJ
- BM
- BN
- BO
- BQ
- BR
- BS
- BT
- BW
- BY
- BZ
- CA
- CD
- CF
- CG
- CH
- CI
- CK
- CL
- CM
- CN
- CO
- CR
- CU
- CV
- CW
- CY
- CZ
- DE
- DJ
- DK
- DM
- DO
- DZ
- EC
- EE
- EG
- ER
- ES
- ET
- FI
- FJ
- FK
- FM
- FO
- FR
- GA
- GB
- GD
- GE
- GF
- GG
- GH
- GI
- GL
- GM
- GN
- GP
- GQ
- GR
- GT
- GU
- GW
- GY
- HK
- HN
- HR
- HT
- HU
- ID
- IE
- IL
- IM
- IN
- IO
- IQ
- IR
- IS
- IT
- JE
- JM
- JO
- JP
- KE
- KG
- KH
- KI
- KM
- KN
- KP
- KR
- KW
- KY
- KZ
- LA
- LB
- LC
- LI
- LK
- LR
- LS
- LT
- LU
- LV
- LY
- MA
- MC
- MD
- ME
- MG
- MH
- MK
- ML
- MM
- MN
- MO
- MP
- MQ
- MR
- MS
- MT
- MU
- MV
- MW
- MX
- MY
- MZ
- NA
- NC
- NE
- NF
- NG
- NI
- NL
- 'NO'
- NP
- NR
- NU
- NZ
- OM
- PA
- PE
- PF
- PG
- PH
- PK
- PL
- PM
- PR
- PS
- PT
- PW
- PY
- QA
- RE
- RO
- RS
- RU
- RW
- SA
- SB
- SC
- SD
- SE
- SG
- SH
- SI
- SK
- SL
- SM
- SN
- SO
- SR
- SS
- ST
- SV
- SX
- SY
- SZ
- TC
- TD
- TG
- TH
- TJ
- TK
- TL
- TM
- TN
- TO
- TR
- TT
- TV
- TW
- TZ
- UA
- UG
- UM
- US
- UY
- UZ
- VC
- VE
- VG
- VI
- VN
- VU
- WF
- WS
- XK
- YE
- YT
- ZA
- ZM
- ZW
- UNRECOGNIZED
x-enumDescriptions:
AD: The country code for Andorra.
AE: The country code for the United Arab Emirates.
AF: The country code for Afghanistan.
AG: The country code for Antigua and Barbuda.
AI: The country code for Anguilla.
AL: The country code for Albania.
AM: The country code for Armenia.
AO: The country code for Angola.
AQ: The country code for Antarctica.
AR: The country code for Argentina.
AS: The country code for American Samoa.
AT: The country code for Austria.
AU: The country code for Australia.
AW: The country code for Aruba.
AZ: The country code for Azerbaijan.
BA: The country code for Bosnia and Herzegovina.
BB: The country code for Barbados.
BD: The country code for Bangladesh.
BE: The country code for Belgium.
BF: The country code for Burkina Faso.
BG: The country code for Bulgaria.
BH: The country code for Bahrain.
BI: The country code for Burundi.
BJ: The country code for Benin.
BM: The country code for Bermuda.
BN: The country code for Brunei.
BO: The country code for Bolivia.
BQ: The country code for Bonaire.
BR: The country code for Brazil.
BS: The country code for the Bahamas.
BT: The country code for Bhutan.
BW: The country code for Botswana.
BY: The country code for Belarus.
BZ: The country code for Belize.
CA: The country code for Canada.
CD: The country code for the Democratic Republic of the Congo.
CF: The country code for the Central African Republic.
CG: The country code for the Republic of the Congo.
CH: The country code for Switzerland.
CI: The country code for the Ivory Coast.
CK: The country code for the Cook Islands.
CL: The country code for Chile.
CM: The country code for Cameroon.
CN: The country code for China.
CO: The country code for Colombia.
CR: The country code for Costa Rica.
CU: The country code for Cuba.
CV: The country code for Cape Verde.
CW: The country code for Curaçao.
CY: The country code for Cyprus.
CZ: The country code for the Czech Republic.
DE: The country code for Germany.
DJ: The country code for Djibouti.
DK: The country code for Denmark.
DM: The country code for Dominica.
DO: The country code for the Dominican Republic.
DZ: The country code for Algeria.
EC: The country code for Ecuador.
EE: The country code for Estonia.
EG: The country code for Egypt.
ER: The country code for Eritrea.
ES: The country code for Spain.
ET: The country code for Ethiopia.
FI: The country code for Finland.
FJ: The country code for Fiji.
FK: The country code for the Falkland Islands.
FM: The country code for Micronesia.
FO: The country code for the Faroe Islands.
FR: The country code for France.
GA: The country code for Gabon.
GB: The country code for the United Kingdom of Great Britain.
GD: The country code for Grenada.
GE: The country code for Georgia.
GF: The country code for French Guiana.
GG: The country code for Guernsey.
GH: The country code for Ghana.
GI: The country code for Gibraltar.
GL: The country code for Greenland.
GM: The country code for the Gambia.
GN: The country code for Guinea.
GP: The country code for Guadeloupe.
GQ: The country code for Equatorial Guinea.
GR: The country code for Greece.
GT: The country code for Guatemala.
GU: The country code for Guam.
GW: The country code for Guinea-Bissau.
GY: The country code for Guyana.
HK: The country code for Hong Kong.
HN: The country code for Honduras.
HR: The country code for Croatia.
HT: The country code for Haiti.
HU: The country code for Hungary.
ID: The country code for Indonesia.
IE: The country code for Ireland.
IL: The country code for Israel.
IM: The country code for the Isle of Man.
IN: The country code for India.
IO: The country code for the British Indian Ocean Territory.
IQ: The country code for Iraq.
IR: The country code for Iran.
IS: The country code for Iceland.
IT: The country code for Italy.
JE: The country code for Jersey.
JM: The country code for Jamaica.
JO: The country code for Jordan.
JP: The country code for Japan.
KE: The country code for Kenya.
KG: The country code for Kyrgyzstan.
KH: The country code for Cambodia.
KI: The country code for Kiribati.
KM: The country code for Comoros.
KN: The country code for Saint Kitts and Nevis.
KP: The country code for North Korea.
KR: The country code for South Korea.
KW: The country code for Kuwait.
KY: The country code for the Cayman Islands.
KZ: The country code for Kazakhstan.
LA: The country code for Laos.
LB: The country code for Lebanon.
LC: The country code for Saint Lucia.
LI: The country code for Liechtenstein.
LK: The country code for Sri Lanka.
LR: The country code for Liberia.
LS: The country code for Lesotho.
LT: The country code for Lithuania.
LU: The country code for Luxembourg.
LV: The country code for Latvia.
LY: The country code for Libya.
MA: The country code for Morocco.
MC: The country code for Monaco.
MD: The country code for Moldova.
ME: The country code for Montenegro.
MG: The country code for Madagascar.
MH: The country code for the Marshall Islands.
MK: The country code for North Macedonia.
ML: The country code for Mali.
MM: The country code for Myanmar.
MN: The country code for Mongolia.
MO: The country code for Macao.
MP: The country code for the Northern Mariana Islands.
MQ: The country code for Martinique.
MR: The country code for Mauritania.
MS: The country code for Montserrat.
MT: The country code for Malta.
MU: The country code for Mauritius.
MV: The country code for the Maldives.
MW: The country code for Malawi.
MX: The country code for Mexico.
MY: The country code for Malaysia.
MZ: The country code for Mozambique.
NA: The country code for Namibia.
NC: The country code for New Caledonia.
NE: The country code for Niger.
NF: The country code for Norfolk Island.
NG: The country code for Nigeria.
NI: The country code for Nicaragua.
NL: The country code for the Netherlands.
'NO': The country code for Norway.
NP: The country code for Nepal.
NR: The country code for Nauru.
NU: The country code for Niue.
NZ: The country code for New Zealand.
OM: The country code for Oman.
PA: The country code for Panama.
PE: The country code for Peru.
PF: The country code for French Polynesia.
PG: The country code for Papua New Guinea.
PH: The country code for the Philippines.
PK: The country code for Pakistan.
PL: The country code for Poland.
PM: The country code for Saint Pierre and Miquelon.
PR: The country code for Puerto Rico.
PS: The country code for Palestine.
PT: The country code for Portugal.
PW: The country code for Palau.
PY: The country code for Paraguay.
QA: The country code for Qatar.
RE: The country code for Réunion.
RO: The country code for Romania.
RS: The country code for Serbia.
RU: The country code for Russia.
RW: The country code for Rwanda.
SA: The country code for Saudi Arabia.
SB: The country code for the Solomon Islands.
SC: The country code for Seychelles.
SD: The country code for Sudan.
SE: The country code for Sweden.
SG: The country code for Singapore.
SH: The country code for Saint Helena.
SI: The country code for Slovenia.
SK: The country code for Slovakia.
SL: The country code for Sierra Leone.
SM: The country code for San Marino.
SN: The country code for Senegal.
SO: The country code for Somalia.
SR: The country code for Suriname.
SS: The country code for South Sudan.
ST: The country code for São Tomé and Príncipe.
SV: The country code for El Salvador.
SX: The country code for Sint Maarten.
SY: The country code for Syria.
SZ: The country code for Eswatini.
TC: The country code for the Turks and Caicos Islands.
TD: The country code for Chad.
TG: The country code for Togo.
TH: The country code for Thailand.
TJ: The country code for Tajikistan.
TK: The country code for Tokelau.
TL: The country code for East Timor.
TM: The country code for Turkmenistan.
TN: The country code for Tunisia.
TO: The country code for Tonga.
TR: The country code for Turkey.
TT: The country code for Trinidad and Tobago.
TV: The country code for Tuvalu.
TW: The country code for Taiwan.
TZ: The country code for Tanzania.
UA: The country code for Ukraine.
UG: The country code for Uganda.
UM: The country code for the United States Minor Outlying Islands.
US: The country code for the United States of America.
UY: The country code for Uruguay.
UZ: The country code for Uzbekistan.
VC: The country code for Saint Vincent and the Grenadines.
VE: The country code for Venezuela.
VG: The country code for the British Virgin Islands.
VI: The country code for the United States Virgin Islands.
VN: The country code for Vietnam.
VU: The country code for Vanuatu.
WF: The country code for Wallis and Futuna.
WS: The country code for Samoa.
XK: The country code for Kosovo.
YE: The country code for Yemen.
YT: The country code for Mayotte.
ZA: The country code for South Africa.
ZM: The country code for Zambia.
ZW: The country code for Zimbabwe.
UNRECOGNIZED: The value returned by an upstream system is not recognized by this API version.
operatorPreviousStatus:
description: Previous country status.
type: string
enum:
- LAUNCHED
- NOT_LAUNCHED
- PENDING
- PENDING_UNLAUNCHED
- REJECTED
- SUSPENDED
- UNLAUNCHED
- INVALID_IN_GOOGLE_MY_BUSINESS
- UNRECOGNIZED
x-enumDescriptions:
LAUNCHED: The operator configuration is fully deployed, active, and operational.
NOT_LAUNCHED: The operator profile has been registered but is not yet initialized or active.
PENDING: The operator configuration is awaiting backend provisioning or verification approval.
PENDING_UNLAUNCHED: The operator configuration remains unlaunched while awaiting progressive rollback or suspension steps.
REJECTED: The operator deployment request was reviewed and rejected due to compliance or provisioning issues.
SUSPENDED: The operator has been temporarily disabled and is currently restricted from operational routing.
UNLAUNCHED: The operator configuration has been explicitly deactivated and retired from service.
INVALID_IN_GOOGLE_MY_BUSINESS: The configuration parameters fail verification criteria within the Google Business Messages framework.
UNRECOGNIZED: The value returned by an upstream system is not recognized by this API version.
operatorCurrentStatus:
type: string
description: Country status.
enum:
- LAUNCHED
- NOT_LAUNCHED
- PENDING
- PENDING_UNLAUNCHED
- REJECTED
- SUSPENDED
- UNLAUNCHED
- INVALID_IN_GOOGLE_MY_BUSINESS
- UNRECOGNIZED
x-enumDescriptions:
LAUNCHED: The operator configuration is fully deployed, active, and operational.
NOT_LAUNCHED: The operator profile has been registered but is not yet initialized or active.
PENDING: The operator configuration is awaiting backend provisioning or verification approval.
PENDING_UNLAUNCHED: The operator configuration remains unlaunched while awaiting progressive rollback or suspension steps.
REJECTED: The operator deployment request was reviewed and rejected due to compliance or provisioning issues.
SUSPENDED: The operator has been temporarily disabled and is currently restricted from operational routing.
UNLAUNCHED: The operator configuration has been explicitly deactivated and retired from service.
INVALID_IN_GOOGLE_MY_BUSINESS: The configuration parameters fail verification criteria within the Google Business Messages framework.
UNRECOGNIZED: The value returned by an upstream system is not recognized by this API version.
comment:
description: Comment for sender.
type: string
required:
- type
- payload
- operator
- operatorCountry
- operatorPreviousStatus
- operatorCurrentStatus
example:
type: RCS_SENDER_OPERATOR_STATUS_UPDATED
payload:
id: cf11794a-6a5e-4a12-b103-da79bd378bf1
state: LAUNCHED
testNumberStates:
- number: '+46123123111'
state: UNVERIFIED
submitted: '2023-01-19t13:11:08.204Z'
- number: '+46123123222'
state: VERIFIED
submitted: '2023-01-19t13:11:08.204Z'
- number: '+46123123333'
state: DECLINED
submitted: '2023-01-19t13:11:08.204Z'
countryStatus:
- country: SE
status: LAUNCHED
operators:
- name: Tele2
status: LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Telenor
status: LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Telia
status: REJECTED
modified: '2023-01-19t13:11:08.204Z'
- name: Three
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
details:
brand:
emails:
- label: label
address: test@test.com
- label: label-1
address: test-1@test.com
- label: label-2
address: test-2@test.com
phones:
- label: label
number: '+48777777777'
- label: label-1
number: '48888888888'
- label: label-2
number: '+48999999999'
websites:
- label: label
url: https://example.com
- label: label-1
url: https://example-1.com
- label: label-2
url: https://example-2.com
color: '#000000'
description: Test description
bannerUrl: https://example-banner-url.com
logoUrl: https://example-logo-url.com
privacyPolicyUrl: https://example-private-policy-url.com
termsOfServiceUrl: https://example-terms-of-service-url.com
name: Test name
testNumbers:
- '+48777777777'
countries:
- FR
- GB
- SE
questionnaire:
general:
questions:
optInDescription:
question: How do users agree to receive messages from your business through the agent?
suggestedAnswers:
- By subscribing to our loyalty program
- By making a purchase in-store or online
- By subscribing to a newsletter
- By creating an account on our website or app
triggerDescription:
question: When does your business send messages to users through the agent?
suggestedAnswers:
- User actions (e.g. after making a purchase)
interactionsDescription:
question: How will users interact with your business through the agent?
suggestedAnswers:
- Online Payment
- Password reset
- OTP/2FA for account login
optOutDescription:
question: What message does your business send when a user opts out?
suggestedAnswers:
- Thank you for opting out
- Thank you for unsubscribing
- We have registered your opt out request
videoUris:
question: ''
suggestedAnswers: []
screenshotUris:
question: ''
suggestedAnswers: []
answers:
optInDescription: By subscribing to a newsletter
triggerDescription: User actions (e.g. after making a purchase)
interactionsDescription: Billing or payment reminders,aef Order updates,aef Upon package delivery
interactionsDescriptionMetadata:
ignore: ',aef'
optOutDescription: We have registered your opt out request
videoUris:
- https://example-video-url.com
screenshotUris:
- https://example-screenshot-url.com
verification:
questions:
name:
question: What is the name of your verification contact?
suggestedAnswers: []
email:
question: What is the email of your verification contact?
suggestedAnswers: []
title:
question: What is the title of your verification contact?
suggestedAnswers: []
website:
question: What is the website of your verification contact?
suggestedAnswers: []
phone:
question: What is the phone number of your verification contact?
suggestedAnswers: []
partner:
companyName:
question: 'For ASP resellers: what is the name of the brand partner company?'
suggestedAnswers: []
contactName:
question: 'For ASP resellers: what is the name of the brand partner contact person?'
suggestedAnswers: []
contactEmailAddress:
question: 'For ASP resellers: what is the email of the brand partner contact person?'
suggestedAnswers: []
answers:
name: Exam Ple
email: email@example.com
title: Head Example
website: https://example.com
phone: '+48777777777'
partner:
companyName: Partner company
contactName: Partner contact name
contactEmailAddress: partner.contact@partner-company.com
gb:
questions:
brandIndustry:
question: What sector or industry does your business operate in?
suggestedAnswers:
- Automotive
- Beauty, spa and salon
- Clothing
- Education
- Entertainment
- Event planning and service
- Finance and banking
- Food and groceries
- Public service
- Hotel and lodging
- Medical and health
- Charity
- Professional services
- Shopping and retail
- Travel and transportation
- Restaurant
companyLegalName:
question: What is the registered legal name of your company?
suggestedAnswers: []
companyRegistrationNumber:
question: What is the registration number of your company?
suggestedAnswers: []
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
messagesVolume:
question: What is the total volume of messages expected to be sent by your agent?
suggestedAnswers:
- 0 - 10K messages
- 10K - 100K messages
- 100K - 1M messages
- 1M+ messages
messagesFrequency:
question: How often do you expect to send messages?
suggestedAnswers:
- Once per day
- Once per week
- Once per month
- Once per 3 months
- Once per 6 months
campaignLength:
question: What will be the length of the RCS campaign?
suggestedAnswers:
- 1 day or less
- 2 to 7 days
- 8 to 21 days
- 1 month
- 3 months
- 6 months
- Continuous / ongoing
answers:
brandIndustry: Automotive
companyLegalName: Example company legal name
companyRegistrationNumber: 123-123456789
fullCompanyAddress: Skeppsbron 1 Malmö, 123 12, Sweden
messagesVolume: 10K - 100K messages
messagesFrequency: Once per month
fr:
questions:
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
siren:
question: What is your Company directory identification system number (SIREN)?
suggestedAnswers: []
answers:
fullCompanyAddress: Skeppsbron 1-split-211 20-split-Malmö
fullCompanyAddressMetadata:
ignore: -split-
siren: '123456789'
us:
questions:
companyLegalName:
question: What is the registered legal name of your company?
suggestedAnswers: []
ein:
question: What is the Employer Identification Number (EIN) of your company?
suggestedAnswers: []
brandIndustry:
question: What sector or industry does your business operate in?
suggestedAnswers:
- Automotive
- Beauty, spa and salon
- Clothing
- Education
- Entertainment
- Event planning and service
- Finance and banking
- Food and groceries
- Public service
- Hotel and lodging
- Medical and health
- Charity
- Professional services
- Shopping and retail
- Travel and transportation
- Restaurant
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
smsCampaign:
question: US SMS campaign used as fallback.
suggestedAnswers: []
messagesVolume:
question: What is the total volume of messages expected to be sent by your agent?
suggestedAnswers:
- 0 - 10K messages
- 10K - 100K messages
- 100K - 1M messages
- 1M+ messages
answers:
companyLegalName: Example company legal name
ein: 12-3456789
brandIndustry: Automotive
fullCompanyAddress: Skeppsbron 1-split-211 20-split-Malmö
fullCompanyAddressMetadata:
ignore: -split-
smsCampaign: We have registered your opt out request
messagesVolume: 10K - 100K messages
region: EU
billingCategory: CONVERSATIONAL
useCase: OTP
hostingRegion: EUROPE
authName: yurwN6123asd
authToken: ejiiqJtDyurwN6jLze8v
conversationApiApp: 4CF9CE97504C4A468F4610919D17ECC1
conversationApiAppDetails:
id: 4CF9CE97504C4A468F4610919D17ECC1
projectId: ea026751-3edf-40a9-ad93-1b382bd60a78
region: EU
channelStatus: ACTIVE
created: '2023-01-19t13:11:08.204Z'
modified: '2023-01-19t13:11:08.204Z'
launched: '2023-01-19t13:11:08.204Z'
supplierDetails:
google:
agentId: agentId
brandId: brandId
operator: Free
operatorCountry: FR
operatorPreviousStatus: PENDING
operatorCurrentStatus: LAUNCHED
responses:
'200':
description: Response to callback will be ignored. The call will retry if unsuccessful.
Comment:
'{$request.body#webhooks.target}':
post:
summary: Comment on sender
description: "\n Received when a comment has been added to the sender.\n "
parameters:
- in: header
name: x-sinch-webhook-signature
schema:
type: string
format: SHA256-hash
example: Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8=
- in: header
name: x-sinch-webhook-signature-algorithm
schema:
type: string
const: HmacSHA256
x-enumDescriptions:
HmacSHA256: The HMAC SHA-256 signature algorithm used to validate webhook authenticity.
uniqueItems: false
example: HmacSHA256
- in: header
name: x-sinch-webhook-signature-nonce
schema:
type: string
example: 01EAW2BNWCG9DC13RS582V0ZQ3
- in: header
name: x-sinch-webhook-signature-timestamp
schema:
type: string
format: timestamp
example: '1592227387'
requestBody:
content:
application/json:
schema:
type: object
properties:
type:
description: Type of event, in this case `RCS_SENDER_COMMENT_ADDED`.
type: string
payload:
description: Sender at time of callback.
allOf:
- $ref: '#/components/schemas/RcsSenderDto'
comment:
description: Comment for sender.
type: string
required:
- type
- payload
example:
type: RCS_SENDER_COMMENT_ADDED
payload:
id: cf11794a-6a5e-4a12-b103-da79bd378bf1
state: IN_PROGRESS
testNumberStates:
- number: '+46123123111'
state: UNVERIFIED
submitted: '2023-01-19t13:11:08.204Z'
- number: '+46123123222'
state: VERIFIED
submitted: '2023-01-19t13:11:08.204Z'
- number: '+46123123333'
state: DECLINED
submitted: '2023-01-19t13:11:08.204Z'
countryStatus:
- country: FR
status: NOT_LAUNCHED
operators:
- name: Coriolis Telecom
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Lycamobile
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Bouygues
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Free
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: NRJ Mobile
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: SFR
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Orange
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- country: GB
status: NOT_LAUNCHED
operators:
- name: EE
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Three
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Sky
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: O2
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Vodafone
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- country: SE
status: NOT_LAUNCHED
operators:
- name: Tele2
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Telenor
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Telia
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Three
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
details:
brand:
emails:
- label: label
address: test@test.com
- label: label-1
address: test-1@test.com
- label: label-2
address: test-2@test.com
phones:
- label: label
number: '+48777777777'
- label: label-1
number: '48888888888'
- label: label-2
number: '+48999999999'
websites:
- label: label
url: https://example.com
- label: label-1
url: https://example-1.com
- label: label-2
url: https://example-2.com
color: '#000000'
description: Test description
bannerUrl: https://example-banner-url.com
logoUrl: https://example-logo-url.com
privacyPolicyUrl: https://example-private-policy-url.com
termsOfServiceUrl: https://example-terms-of-service-url.com
name: Test name
testNumbers:
- '+48777777777'
countries:
- FR
- GB
- SE
questionnaire:
general:
questions:
optInDescription:
question: How do users agree to receive messages from your business through the agent?
suggestedAnswers:
- By subscribing to our loyalty program
- By making a purchase in-store or online
- By subscribing to a newsletter
- By creating an account on our website or app
triggerDescription:
question: When does your business send messages to users through the agent?
suggestedAnswers:
- User actions (e.g. after making a purchase)
interactionsDescription:
question: How will users interact with your business through the agent?
suggestedAnswers:
- Online Payment
- Password reset
- OTP/2FA for account login
optOutDescription:
question: What message does your business send when a user opts out?
suggestedAnswers:
- Thank you for opting out
- Thank you for unsubscribing
- We have registered your opt out request
videoUris:
question: ''
suggestedAnswers: []
screenshotUris:
question: ''
suggestedAnswers: []
answers:
optInDescription: By subscribing to a newsletter
triggerDescription: User actions (e.g. after making a purchase)
interactionsDescription: Billing or payment reminders,aef Order updates,aef Upon package delivery
interactionsDescriptionMetadata:
ignore: ',aef'
optOutDescription: We have registered your opt out request
videoUris:
- https://example-video-url.com
screenshotUris:
- https://example-screenshot-url.com
verification:
questions:
name:
question: What is the name of your verification contact?
suggestedAnswers: []
email:
question: What is the email of your verification contact?
suggestedAnswers: []
title:
question: What is the title of your verification contact?
suggestedAnswers: []
website:
question: What is the website of your verification contact?
suggestedAnswers: []
phone:
question: What is the phone number of your verification contact?
suggestedAnswers: []
partner:
companyName:
question: 'For ASP resellers: what is the name of the brand partner company?'
suggestedAnswers: []
contactName:
question: 'For ASP resellers: what is the name of the brand partner contact person?'
suggestedAnswers: []
contactEmailAddress:
question: 'For ASP resellers: what is the email of the brand partner contact person?'
suggestedAnswers: []
answers:
name: Exam Ple
email: email@example.com
title: Head Example
website: https://example.com
phone: '+48777777777'
partner:
companyName: Partner company
contactName: Partner contact name
contactEmailAddress: partner.contact@partner-company.com
gb:
questions:
brandIndustry:
question: What sector or industry does your business operate in?
suggestedAnswers:
- Automotive
- Beauty, spa and salon
- Clothing
- Education
- Entertainment
- Event planning and service
- Finance and banking
- Food and groceries
- Public service
- Hotel and lodging
- Medical and health
- Charity
- Professional services
- Shopping and retail
- Travel and transportation
- Restaurant
companyLegalName:
question: What is the registered legal name of your company?
suggestedAnswers: []
companyRegistrationNumber:
question: What is the registration number of your company?
suggestedAnswers: []
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
messagesVolume:
question: What is the total volume of messages expected to be sent by your agent?
suggestedAnswers:
- 0 - 10K messages
- 10K - 100K messages
- 100K - 1M messages
- 1M+ messages
messagesFrequency:
question: How often do you expect to send messages?
suggestedAnswers:
- Once per day
- Once per week
- Once per month
- Once per 3 months
- Once per 6 months
campaignLength:
question: What will be the length of the RCS campaign?
suggestedAnswers:
- 1 day or less
- 2 to 7 days
- 8 to 21 days
- 1 month
- 3 months
- 6 months
- Continuous / ongoing
answers:
brandIndustry: Automotive
companyLegalName: Example company legal name
companyRegistrationNumber: 123-123456789
fullCompanyAddress: Skeppsbron 1 Malmö, 123 12, Sweden
messagesVolume: 10K - 100K messages
messagesFrequency: Once per month
fr:
questions:
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
siren:
question: What is your Company directory identification system number (SIREN)?
suggestedAnswers: []
answers:
fullCompanyAddress: Skeppsbron 1-split-211 20-split-Malmö
fullCompanyAddressMetadata:
ignore: -split-
siren: '123456789'
us:
questions:
companyLegalName:
question: What is the registered legal name of your company?
suggestedAnswers: []
ein:
question: What is the Employer Identification Number (EIN) of your company?
suggestedAnswers: []
brandIndustry:
question: What sector or industry does your business operate in?
suggestedAnswers:
- Automotive
- Beauty, spa and salon
- Clothing
- Education
- Entertainment
- Event planning and service
- Finance and banking
- Food and groceries
- Public service
- Hotel and lodging
- Medical and health
- Charity
- Professional services
- Shopping and retail
- Travel and transportation
- Restaurant
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
smsCampaign:
question: US SMS campaign used as fallback.
suggestedAnswers: []
messagesVolume:
question: What is the total volume of messages expected to be sent by your agent?
suggestedAnswers:
- 0 - 10K messages
- 10K - 100K messages
- 100K - 1M messages
- 1M+ messages
answers:
companyLegalName: Example company legal name
ein: 12-3456789
brandIndustry: Automotive
fullCompanyAddress: Skeppsbron 1-split-211 20-split-Malmö
fullCompanyAddressMetadata:
ignore: -split-
smsCampaign: We have registered your opt out request
messagesVolume: 10K - 100K messages
region: EU
billingCategory: CONVERSATIONAL
useCase: OTP
hostingRegion: EUROPE
authName: yurwN6123asd
authToken: ejiiqJtDyurwN6jLze8v
conversationApiApp: 4CF9CE97504C4A468F4610919D17ECC1
conversationApiAppDetails:
id: 4CF9CE97504C4A468F4610919D17ECC1
projectId: ea026751-3edf-40a9-ad93-1b382bd60a78
region: EU
channelStatus: ACTIVE
created: '2023-01-19t13:11:08.204Z'
modified: '2023-01-19t13:11:08.204Z'
launched: '2023-01-19t13:11:08.204Z'
supplierDetails:
google:
agentId: agentId
brandId: brandId
comment: Example comment
responses:
'200':
description: Response to callback will be ignored. The call will retry if unsuccessful.
BrandOrderStatusUpdate:
'{$request.body#webhooks.target}':
post:
summary: Brand registration process status updated
description: "\n Received when the registration process status is updated for a brand associated with the sender.\n "
parameters:
- in: header
name: x-sinch-webhook-signature
schema:
type: string
format: SHA256-hash
example: Jc88RMjzkxPoy/fCPiL+iy7osojuUgawpjl1g6H38O8=
- in: header
name: x-sinch-webhook-signature-algorithm
schema:
type: string
const: HmacSHA256
x-enumDescriptions:
HmacSHA256: The HMAC SHA-256 signature algorithm used to validate webhook authenticity.
uniqueItems: false
example: HmacSHA256
- in: header
name: x-sinch-webhook-signature-nonce
schema:
type: string
example: 01EAW2BNWCG9DC13RS582V0ZQ3
- in: header
name: x-sinch-webhook-signature-timestamp
schema:
type: string
format: timestamp
example: '1592227387'
requestBody:
content:
application/json:
schema:
type: object
properties:
type:
description: Type of event, in this case `RCS_BRAND_REGISTRATION_PROCESS_STATUS_UPDATED`.
type: string
payload:
description: Sender at time of callback.
allOf:
- $ref: '#/components/schemas/RcsSenderDto'
status:
description: The current status of the brand registration process.
type: string
enum:
Archived: ARCHIVED
Completed: COMPLETED
Incomplete: INCOMPLETE
ManualReview: MANUAL_REVIEW
New: NEW
Pending: PENDING
PendingReview: PENDING_REVIEW
Rejected: REJECTED
Unrecognized: UNRECOGNIZED
Unspecified: UNSPECIFIED
x-enumDescriptions:
ARCHIVED: The brand registration process has been archived.
COMPLETED: The brand registration process has finished successfully.
INCOMPLETE: The brand registration process is missing required information.
MANUAL_REVIEW: The brand registration process requires manual review.
NEW: The brand registration process is created but has not yet started.
PENDING: The brand registration process is waiting for the next action.
PENDING_REVIEW: The brand registration process is currently under review.
REJECTED: The brand registration process has been reviewed and rejected.
UNRECOGNIZED: The value returned by an upstream system is not recognized by this API version.
UNSPECIFIED: The brand registration process status is not specified.
comment:
description: Comment for sender.
type: string
required:
- type
- payload
- status
example:
type: RCS_BRAND_REGISTRATION_PROCESS_STATUS_UPDATED
payload:
id: cf11794a-6a5e-4a12-b103-da79bd378bf1
state: IN_TEST
testNumberStates:
- number: '+46123123111'
state: UNVERIFIED
submitted: '2023-01-19t13:11:08.204Z'
- number: '+46123123222'
state: VERIFIED
submitted: '2023-01-19t13:11:08.204Z'
- number: '+46123123333'
state: DECLINED
submitted: '2023-01-19t13:11:08.204Z'
countryStatus:
- country: FR
status: NOT_LAUNCHED
operators:
- name: Coriolis Telecom
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Lycamobile
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Bouygues
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Free
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: NRJ Mobile
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: SFR
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Orange
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- country: GB
status: NOT_LAUNCHED
operators:
- name: EE
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Three
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Sky
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: O2
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Vodafone
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- country: SE
status: NOT_LAUNCHED
operators:
- name: Tele2
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Telenor
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Telia
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Three
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
details:
brand:
emails:
- label: label
address: test@test.com
- label: label-1
address: test-1@test.com
- label: label-2
address: test-2@test.com
phones:
- label: label
number: '+48777777777'
- label: label-1
number: '48888888888'
- label: label-2
number: '+48999999999'
websites:
- label: label
url: https://example.com
- label: label-1
url: https://example-1.com
- label: label-2
url: https://example-2.com
color: '#000000'
description: Test description
bannerUrl: https://example-banner-url.com
logoUrl: https://example-logo-url.com
privacyPolicyUrl: https://example-private-policy-url.com
termsOfServiceUrl: https://example-terms-of-service-url.com
name: Test name
testNumbers:
- '+48777777777'
countries:
- FR
- GB
- SE
questionnaire:
general:
questions:
optInDescription:
question: How do users agree to receive messages from your business through the agent?
suggestedAnswers:
- By subscribing to our loyalty program
- By making a purchase in-store or online
- By subscribing to a newsletter
- By creating an account on our website or app
triggerDescription:
question: When does your business send messages to users through the agent?
suggestedAnswers:
- User actions (e.g. after making a purchase)
interactionsDescription:
question: How will users interact with your business through the agent?
suggestedAnswers:
- Online Payment
- Password reset
- OTP/2FA for account login
optOutDescription:
question: What message does your business send when a user opts out?
suggestedAnswers:
- Thank you for opting out
- Thank you for unsubscribing
- We have registered your opt out request
videoUris:
question: ''
suggestedAnswers: []
screenshotUris:
question: ''
suggestedAnswers: []
answers:
optInDescription: By subscribing to a newsletter
triggerDescription: User actions (e.g. after making a purchase)
interactionsDescription: Billing or payment reminders,aef Order updates,aef Upon package delivery
interactionsDescriptionMetadata:
ignore: ',aef'
optOutDescription: We have registered your opt out request
videoUris:
- https://example-video-url.com
screenshotUris:
- https://example-screenshot-url.com
verification:
questions:
name:
question: What is the name of your verification contact?
suggestedAnswers: []
email:
question: What is the email of your verification contact?
suggestedAnswers: []
title:
question: What is the title of your verification contact?
suggestedAnswers: []
website:
question: What is the website of your verification contact?
suggestedAnswers: []
phone:
question: What is the phone number of your verification contact?
suggestedAnswers: []
partner:
companyName:
question: 'For ASP resellers: what is the name of the brand partner company?'
suggestedAnswers: []
contactName:
question: 'For ASP resellers: what is the name of the brand partner contact person?'
suggestedAnswers: []
contactEmailAddress:
question: 'For ASP resellers: what is the email of the brand partner contact person?'
suggestedAnswers: []
answers:
name: Exam Ple
email: email@example.com
title: Head Example
website: https://example.com
phone: '+48777777777'
partner:
companyName: Partner company
contactName: Partner contact name
contactEmailAddress: partner.contact@partner-company.com
gb:
questions:
brandIndustry:
question: What sector or industry does your business operate in?
suggestedAnswers:
- Automotive
- Beauty, spa and salon
- Clothing
- Education
- Entertainment
- Event planning and service
- Finance and banking
- Food and groceries
- Public service
- Hotel and lodging
- Medical and health
- Charity
- Professional services
- Shopping and retail
- Travel and transportation
- Restaurant
companyLegalName:
question: What is the registered legal name of your company?
suggestedAnswers: []
companyRegistrationNumber:
question: What is the registration number of your company?
suggestedAnswers: []
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
messagesVolume:
question: What is the total volume of messages expected to be sent by your agent?
suggestedAnswers:
- 0 - 10K messages
- 10K - 100K messages
- 100K - 1M messages
- 1M+ messages
messagesFrequency:
question: How often do you expect to send messages?
suggestedAnswers:
- Once per day
- Once per week
- Once per month
- Once per 3 months
- Once per 6 months
campaignLength:
question: What will be the length of the RCS campaign?
suggestedAnswers:
- 1 day or less
- 2 to 7 days
- 8 to 21 days
- 1 month
- 3 months
- 6 months
- Continuous / ongoing
answers:
brandIndustry: Automotive
companyLegalName: Example company legal name
companyRegistrationNumber: 123-123456789
fullCompanyAddress: Skeppsbron 1 Malmö, 123 12, Sweden
messagesVolume: 10K - 100K messages
messagesFrequency: Once per month
fr:
questions:
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
siren:
question: What is your Company directory identification system number (SIREN)?
suggestedAnswers: []
answers:
fullCompanyAddress: Skeppsbron 1-split-211 20-split-Malmö
fullCompanyAddressMetadata:
ignore: -split-
siren: '123456789'
us:
questions:
companyLegalName:
question: What is the registered legal name of your company?
suggestedAnswers: []
ein:
question: What is the Employer Identification Number (EIN) of your company?
suggestedAnswers: []
brandIndustry:
question: What sector or industry does your business operate in?
suggestedAnswers:
- Automotive
- Beauty, spa and salon
- Clothing
- Education
- Entertainment
- Event planning and service
- Finance and banking
- Food and groceries
- Public service
- Hotel and lodging
- Medical and health
- Charity
- Professional services
- Shopping and retail
- Travel and transportation
- Restaurant
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
smsCampaign:
question: US SMS campaign used as fallback.
suggestedAnswers: []
messagesVolume:
question: What is the total volume of messages expected to be sent by your agent?
suggestedAnswers:
- 0 - 10K messages
- 10K - 100K messages
- 100K - 1M messages
- 1M+ messages
answers:
companyLegalName: Example company legal name
ein: 12-3456789
brandIndustry: Automotive
fullCompanyAddress: Skeppsbron 1-split-211 20-split-Malmö
fullCompanyAddressMetadata:
ignore: -split-
smsCampaign: We have registered your opt out request
messagesVolume: 10K - 100K messages
region: EU
billingCategory: CONVERSATIONAL
useCase: OTP
hostingRegion: EUROPE
authName: yurwN6123asd
authToken: ejiiqJtDyurwN6jLze8v
conversationApiApp: 4CF9CE97504C4A468F4610919D17ECC1
conversationApiAppDetails:
id: 4CF9CE97504C4A468F4610919D17ECC1
projectId: ea026751-3edf-40a9-ad93-1b382bd60a78
region: EU
channelStatus: ACTIVE
created: '2023-01-19t13:11:08.204Z'
modified: '2023-01-19t13:11:08.204Z'
launched: '2023-01-19t13:11:08.204Z'
supplierDetails:
google:
agentId: agentId
brandId: brandId
status: COMPLETED
comment: Brand registration approved
responses:
'200':
description: Response to callback will be ignored. The call will retry if unsuccessful.
description: Returns a sender for a project.
operationId: RcsSendersController_createSender_v1
parameters:
- name: projectId
required: true
in: path
description: The unique ID of the project. You can find this on the Sinch Dashboard.
schema:
type: string
requestBody:
required: true
description: Sender data
content:
application/json:
schema:
$ref: '#/components/schemas/RcsSenderInputDto'
examples:
minimal:
summary: Minimal body request for sender
description: "\n Minimal example that only includes the required fields. Other fields can be\n provided later via an update to complete the sender before launch.\n "
value:
region: EU
billingCategory: CONVERSATIONAL
useCase: OTP
usQuestionnairePublicCorporationUsTaxIdCountry:
summary: 'US questionnaire: PUBLIC + CORPORATION (US taxIdCountry)'
description: "\n Launch-compatible payload using only the US questionnaire.\n This variant uses ownershipType=PUBLIC, legalForm=CORPORATION, taxIdCountry=US,\n includes addressState, and includes stockExchange and stockSymbol because\n they are required for PUBLIC and required by this example.\n "
value:
region: EU
billingCategory: CONVERSATIONAL
useCase: OTP
details:
brand:
emails:
- label: label
address: test@test.com
- label: label-1
address: test-1@test.com
- label: label-2
address: test-2@test.com
phones:
- label: label
number: '+48777777777'
- label: label-1
number: '48888888888'
- label: label-2
number: '+48999999999'
websites:
- label: label
url: https://example.com
- label: label-1
url: https://example-1.com
- label: label-2
url: https://example-2.com
color: '#000000'
description: Test description
bannerUrl: https://example-banner-url.com
logoUrl: https://example-logo-url.com
privacyPolicyUrl: https://example-private-policy-url.com
termsOfServiceUrl: https://example-terms-of-service-url.com
name: Test name
testNumbers:
- '+48777777777'
countries:
- US
questionnaire:
general:
answers:
optInDescription: By subscribing to a newsletter
triggerDescription: User actions (e.g. after making a purchase)
interactionsDescription: Billing or payment reminders,aef Order updates,aef Upon package delivery
interactionsDescriptionMetadata:
ignore: ',aef'
optOutDescription: We have registered your opt out request
videoUris:
- https://example-video-url.com
screenshotUris:
- https://example-screenshot-url.com
verification:
answers:
name: Exam Ple
email: email@example.com
title: Head Example
website: https://example.com
phone: '+48777777777'
partner:
companyName: Partner company
contactName: Partner contact name
contactEmailAddress: partner.contact@partner-company.com
us:
answers:
ownershipType: PUBLIC
companyLegalName: Example company legal name
companyPhoneNumber: '+48777777777'
companyEmailAddress: email@example.com
brandName: Example brand name
brandIndustry: AGRICULTURE
legalForm: CORPORATION
taxIdCountry: US
taxId: 12-3456789
addressLine: 123 Main St
addressCity: Anytown
addressCountry: US
addressState: CA
addressPostalCode: '12345'
websiteUrl: https://example.com
contactFirstName: John
contactSurname: Doe
stockExchange: NASDAQ
stockSymbol: EXMPL
sampleMessages:
- Sample message 1 for the US questionnaire.
- Sample message 2 for the US questionnaire.
messagesVolume: 10000
embeddedLink: true
embeddedPhone: true
ageGatedContent: false
directLending: false
optInConfirmationMessage: Thank you for opting in!
helpMessage: For help, contact support.
callToActionMessage: Click here to claim your special offer and explore our latest updates now.
usQuestionnairePrivateLlcUsTaxIdCountry:
summary: 'US questionnaire: PRIVATE + LIMITED_LIABILITY_COMPANY (US taxIdCountry)'
description: "\n Launch-compatible payload using only the US questionnaire.\n This variant uses ownershipType=PRIVATE and legalForm=LIMITED_LIABILITY_COMPANY\n with taxIdCountry=US, includes addressState, and omits stockExchange and\n stockSymbol because they are not allowed for PRIVATE.\n "
value:
region: EU
billingCategory: CONVERSATIONAL
useCase: OTP
details:
brand:
emails:
- label: label
address: test@test.com
- label: label-1
address: test-1@test.com
- label: label-2
address: test-2@test.com
phones:
- label: label
number: '+48777777777'
- label: label-1
number: '48888888888'
- label: label-2
number: '+48999999999'
websites:
- label: label
url: https://example.com
- label: label-1
url: https://example-1.com
- label: label-2
url: https://example-2.com
color: '#000000'
description: Test description
bannerUrl: https://example-banner-url.com
logoUrl: https://example-logo-url.com
privacyPolicyUrl: https://example-private-policy-url.com
termsOfServiceUrl: https://example-terms-of-service-url.com
name: Test name
testNumbers:
- '+48777777777'
countries:
- US
questionnaire:
general:
answers:
optInDescription: By subscribing to a newsletter
triggerDescription: User actions (e.g. after making a purchase)
interactionsDescription: Billing or payment reminders,aef Order updates,aef Upon package delivery
interactionsDescriptionMetadata:
ignore: ',aef'
optOutDescription: We have registered your opt out request
videoUris:
- https://example-video-url.com
screenshotUris:
- https://example-screenshot-url.com
verification:
answers:
name: Exam Ple
email: email@example.com
title: Head Example
website: https://example.com
phone: '+48777777777'
partner:
companyName: Partner company
contactName: Partner contact name
contactEmailAddress: partner.contact@partner-company.com
us:
answers:
ownershipType: PRIVATE
companyLegalName: Example company legal name
companyPhoneNumber: '+48777777777'
companyEmailAddress: email@example.com
brandName: Example brand name
brandIndustry: AGRICULTURE
legalForm: LIMITED_LIABILITY_COMPANY
taxIdCountry: US
taxId: 98-7654321
addressLine: 123 Main St
addressCity: Anytown
addressCountry: US
addressState: CA
addressPostalCode: '12345'
websiteUrl: https://example.com
contactFirstName: John
contactSurname: Doe
sampleMessages:
- Sample message 1 for the US questionnaire.
- Sample message 2 for the US questionnaire.
messagesVolume: 10000
embeddedLink: true
embeddedPhone: true
ageGatedContent: false
directLending: false
optInConfirmationMessage: Thank you for opting in!
helpMessage: For help, contact support.
callToActionMessage: Click here to claim your special offer and explore our latest updates now.
usQuestionnairePrivatePartnershipUsTaxIdCountry:
summary: 'US questionnaire: PRIVATE + PARTNERSHIP (US taxIdCountry)'
description: "\n Launch-compatible payload using only the US questionnaire.\n This variant uses ownershipType=PRIVATE and legalForm=PARTNERSHIP\n with taxIdCountry=US, includes addressState, and omits stockExchange and\n stockSymbol because they are not allowed for PRIVATE.\n "
value:
region: EU
billingCategory: CONVERSATIONAL
useCase: OTP
details:
brand:
emails:
- label: label
address: test@test.com
- label: label-1
address: test-1@test.com
- label: label-2
address: test-2@test.com
phones:
- label: label
number: '+48777777777'
- label: label-1
number: '48888888888'
- label: label-2
number: '+48999999999'
websites:
- label: label
url: https://example.com
- label: label-1
url: https://example-1.com
- label: label-2
url: https://example-2.com
color: '#000000'
description: Test description
bannerUrl: https://example-banner-url.com
logoUrl: https://example-logo-url.com
privacyPolicyUrl: https://example-private-policy-url.com
termsOfServiceUrl: https://example-terms-of-service-url.com
name: Test name
testNumbers:
- '+48777777777'
countries:
- US
questionnaire:
general:
answers:
optInDescription: By subscribing to a newsletter
triggerDescription: User actions (e.g. after making a purchase)
interactionsDescription: Billing or payment reminders,aef Order updates,aef Upon package delivery
interactionsDescriptionMetadata:
ignore: ',aef'
optOutDescription: We have registered your opt out request
videoUris:
- https://example-video-url.com
screenshotUris:
- https://example-screenshot-url.com
verification:
answers:
name: Exam Ple
email: email@example.com
title: Head Example
website: https://example.com
phone: '+48777777777'
partner:
companyName: Partner company
contactName: Partner contact name
contactEmailAddress: partner.contact@partner-company.com
us:
answers:
ownershipType: PRIVATE
companyLegalName: Example company legal name
companyPhoneNumber: '+48777777777'
companyEmailAddress: email@example.com
brandName: Example brand name
brandIndustry: AGRICULTURE
legalForm: PARTNERSHIP
taxIdCountry: US
taxId: 23-4567890
addressLine: 123 Main St
addressCity: Anytown
addressCountry: US
addressState: CA
addressPostalCode: '12345'
websiteUrl: https://example.com
contactFirstName: John
contactSurname: Doe
sampleMessages:
- Sample message 1 for the US questionnaire.
- Sample message 2 for the US questionnaire.
messagesVolume: 10000
embeddedLink: true
embeddedPhone: true
ageGatedContent: false
directLending: false
optInConfirmationMessage: Thank you for opting in!
helpMessage: For help, contact support.
callToActionMessage: Click here to claim your special offer and explore our latest updates now.
usQuestionnairePrivateSCorporationUsTaxIdCountry:
summary: 'US questionnaire: PRIVATE + S_CORPORATION (US taxIdCountry)'
description: "\n Launch-compatible payload using only the US questionnaire.\n This variant uses ownershipType=PRIVATE and legalForm=S_CORPORATION\n with taxIdCountry=US, includes addressState, and omits stockExchange and\n stockSymbol because they are not allowed for PRIVATE.\n "
value:
region: EU
billingCategory: CONVERSATIONAL
useCase: OTP
details:
brand:
emails:
- label: label
address: test@test.com
- label: label-1
address: test-1@test.com
- label: label-2
address: test-2@test.com
phones:
- label: label
number: '+48777777777'
- label: label-1
number: '48888888888'
- label: label-2
number: '+48999999999'
websites:
- label: label
url: https://example.com
- label: label-1
url: https://example-1.com
- label: label-2
url: https://example-2.com
color: '#000000'
description: Test description
bannerUrl: https://example-banner-url.com
logoUrl: https://example-logo-url.com
privacyPolicyUrl: https://example-private-policy-url.com
termsOfServiceUrl: https://example-terms-of-service-url.com
name: Test name
testNumbers:
- '+48777777777'
countries:
- US
questionnaire:
general:
answers:
optInDescription: By subscribing to a newsletter
triggerDescription: User actions (e.g. after making a purchase)
interactionsDescription: Billing or payment reminders,aef Order updates,aef Upon package delivery
interactionsDescriptionMetadata:
ignore: ',aef'
optOutDescription: We have registered your opt out request
videoUris:
- https://example-video-url.com
screenshotUris:
- https://example-screenshot-url.com
verification:
answers:
name: Exam Ple
email: email@example.com
title: Head Example
website: https://example.com
phone: '+48777777777'
partner:
companyName: Partner company
contactName: Partner contact name
contactEmailAddress: partner.contact@partner-company.com
us:
answers:
ownershipType: PRIVATE
companyLegalName: Example company legal name
companyPhoneNumber: '+48777777777'
companyEmailAddress: email@example.com
brandName: Example brand name
brandIndustry: AGRICULTURE
legalForm: S_CORPORATION
taxIdCountry: US
taxId: 87-6543210
addressLine: 123 Main St
addressCity: Anytown
addressCountry: US
addressState: CA
addressPostalCode: '12345'
websiteUrl: https://example.com
contactFirstName: John
contactSurname: Doe
sampleMessages:
- Sample message 1 for the US questionnaire.
- Sample message 2 for the US questionnaire.
messagesVolume: 10000
embeddedLink: true
embeddedPhone: true
ageGatedContent: false
directLending: false
optInConfirmationMessage: Thank you for opting in!
helpMessage: For help, contact support.
callToActionMessage: Click here to claim your special offer and explore our latest updates now.
usQuestionnairePublicCorporationGermanyTaxIdCountry:
summary: 'US questionnaire: PUBLIC + CORPORATION (DE taxIdCountry)'
description: "\n Launch-compatible payload using only the US questionnaire.\n This variant demonstrates a non-US taxIdCountry (DE) where taxId is treated\n as a generic string, addressState is omitted, and includes stockExchange and stockSymbol because\n they are required for PUBLIC and required by this example.\n "
value:
region: EU
billingCategory: CONVERSATIONAL
useCase: OTP
details:
brand:
emails:
- label: label
address: test@test.com
- label: label-1
address: test-1@test.com
- label: label-2
address: test-2@test.com
phones:
- label: label
number: '+48777777777'
- label: label-1
number: '48888888888'
- label: label-2
number: '+48999999999'
websites:
- label: label
url: https://example.com
- label: label-1
url: https://example-1.com
- label: label-2
url: https://example-2.com
color: '#000000'
description: Test description
bannerUrl: https://example-banner-url.com
logoUrl: https://example-logo-url.com
privacyPolicyUrl: https://example-private-policy-url.com
termsOfServiceUrl: https://example-terms-of-service-url.com
name: Test name
testNumbers:
- '+48777777777'
countries:
- US
questionnaire:
general:
answers:
optInDescription: By subscribing to a newsletter
triggerDescription: User actions (e.g. after making a purchase)
interactionsDescription: Billing or payment reminders,aef Order updates,aef Upon package delivery
interactionsDescriptionMetadata:
ignore: ',aef'
optOutDescription: We have registered your opt out request
videoUris:
- https://example-video-url.com
screenshotUris:
- https://example-screenshot-url.com
verification:
answers:
name: Exam Ple
email: email@example.com
title: Head Example
website: https://example.com
phone: '+48777777777'
partner:
companyName: Partner company
contactName: Partner contact name
contactEmailAddress: partner.contact@partner-company.com
us:
answers:
ownershipType: PUBLIC
companyLegalName: Example company legal name
companyPhoneNumber: '+48777777777'
companyEmailAddress: email@example.com
brandName: Example brand name
brandIndustry: AGRICULTURE
legalForm: CORPORATION
taxIdCountry: DE
taxId: DE-TAX-12345
addressLine: 123 Main St
addressCity: Anytown
addressCountry: DE
addressPostalCode: '12345'
websiteUrl: https://example.com
contactFirstName: John
contactSurname: Doe
stockExchange: NASDAQ
stockSymbol: EXMPL
sampleMessages:
- Sample message 1 for the US questionnaire.
- Sample message 2 for the US questionnaire.
messagesVolume: 10000
embeddedLink: true
embeddedPhone: true
ageGatedContent: false
directLending: false
optInConfirmationMessage: Thank you for opting in!
helpMessage: For help, contact support.
callToActionMessage: Click here to claim your special offer and explore our latest updates now.
usQuestionnairePrivateLlcSwedenTaxIdCountry:
summary: 'US questionnaire: PRIVATE + LIMITED_LIABILITY_COMPANY (SE taxIdCountry)'
description: "\n Launch-compatible payload using only the US questionnaire.\n This variant demonstrates another non-US taxIdCountry (SE), keeping the\n same US questionnaire shape while passing validation. addressState is\n omitted, and omits stockExchange and stockSymbol because they are not allowed for PRIVATE.\n "
value:
region: EU
billingCategory: CONVERSATIONAL
useCase: OTP
details:
brand:
emails:
- label: label
address: test@test.com
- label: label-1
address: test-1@test.com
- label: label-2
address: test-2@test.com
phones:
- label: label
number: '+48777777777'
- label: label-1
number: '48888888888'
- label: label-2
number: '+48999999999'
websites:
- label: label
url: https://example.com
- label: label-1
url: https://example-1.com
- label: label-2
url: https://example-2.com
color: '#000000'
description: Test description
bannerUrl: https://example-banner-url.com
logoUrl: https://example-logo-url.com
privacyPolicyUrl: https://example-private-policy-url.com
termsOfServiceUrl: https://example-terms-of-service-url.com
name: Test name
testNumbers:
- '+48777777777'
countries:
- US
questionnaire:
general:
answers:
optInDescription: By subscribing to a newsletter
triggerDescription: User actions (e.g. after making a purchase)
interactionsDescription: Billing or payment reminders,aef Order updates,aef Upon package delivery
interactionsDescriptionMetadata:
ignore: ',aef'
optOutDescription: We have registered your opt out request
videoUris:
- https://example-video-url.com
screenshotUris:
- https://example-screenshot-url.com
verification:
answers:
name: Exam Ple
email: email@example.com
title: Head Example
website: https://example.com
phone: '+48777777777'
partner:
companyName: Partner company
contactName: Partner contact name
contactEmailAddress: partner.contact@partner-company.com
us:
answers:
ownershipType: PRIVATE
companyLegalName: Example company legal name
companyPhoneNumber: '+48777777777'
companyEmailAddress: email@example.com
brandName: Example brand name
brandIndustry: AGRICULTURE
legalForm: LIMITED_LIABILITY_COMPANY
taxIdCountry: SE
taxId: SE-TAX-54321
addressLine: 123 Main St
addressCity: Anytown
addressCountry: DE
addressPostalCode: '12345'
websiteUrl: https://example.com
contactFirstName: John
contactSurname: Doe
sampleMessages:
- Sample message 1 for the US questionnaire.
- Sample message 2 for the US questionnaire.
messagesVolume: 10000
embeddedLink: true
embeddedPhone: true
ageGatedContent: false
directLending: false
optInConfirmationMessage: Thank you for opting in!
helpMessage: For help, contact support.
callToActionMessage: Click here to claim your special offer and explore our latest updates now.
usQuestionnairePrivatePartnershipGreatBritainTaxIdCountry:
summary: 'US questionnaire: PRIVATE + PARTNERSHIP (GB taxIdCountry)'
description: "\n Launch-compatible payload using only the US questionnaire.\n This variant demonstrates taxIdCountry=GB together with PRIVATE ownership\n and PARTNERSHIP legal form. addressState is omitted, and omits stockExchange and\n stockSymbol because they are not allowed for PRIVATE.\n "
value:
region: EU
billingCategory: CONVERSATIONAL
useCase: OTP
details:
brand:
emails:
- label: label
address: test@test.com
- label: label-1
address: test-1@test.com
- label: label-2
address: test-2@test.com
phones:
- label: label
number: '+48777777777'
- label: label-1
number: '48888888888'
- label: label-2
number: '+48999999999'
websites:
- label: label
url: https://example.com
- label: label-1
url: https://example-1.com
- label: label-2
url: https://example-2.com
color: '#000000'
description: Test description
bannerUrl: https://example-banner-url.com
logoUrl: https://example-logo-url.com
privacyPolicyUrl: https://example-private-policy-url.com
termsOfServiceUrl: https://example-terms-of-service-url.com
name: Test name
testNumbers:
- '+48777777777'
countries:
- US
questionnaire:
general:
answers:
optInDescription: By subscribing to a newsletter
triggerDescription: User actions (e.g. after making a purchase)
interactionsDescription: Billing or payment reminders,aef Order updates,aef Upon package delivery
interactionsDescriptionMetadata:
ignore: ',aef'
optOutDescription: We have registered your opt out request
videoUris:
- https://example-video-url.com
screenshotUris:
- https://example-screenshot-url.com
verification:
answers:
name: Exam Ple
email: email@example.com
title: Head Example
website: https://example.com
phone: '+48777777777'
partner:
companyName: Partner company
contactName: Partner contact name
contactEmailAddress: partner.contact@partner-company.com
us:
answers:
ownershipType: PRIVATE
companyLegalName: Example company legal name
companyPhoneNumber: '+48777777777'
companyEmailAddress: email@example.com
brandName: Example brand name
brandIndustry: AGRICULTURE
legalForm: PARTNERSHIP
taxIdCountry: GB
taxId: GB-TAX-778899
addressLine: 123 Main St
addressCity: Anytown
addressCountry: DE
addressPostalCode: '12345'
websiteUrl: https://example.com
contactFirstName: John
contactSurname: Doe
sampleMessages:
- Sample message 1 for the US questionnaire.
- Sample message 2 for the US questionnaire.
messagesVolume: 10000
embeddedLink: true
embeddedPhone: true
ageGatedContent: false
directLending: false
optInConfirmationMessage: Thank you for opting in!
helpMessage: For help, contact support.
callToActionMessage: Click here to claim your special offer and explore our latest updates now.
input:
summary: '[Deprecated] Body request for sender'
description: "\n Example body request to create a sender.\n "
value:
region: EU
billingCategory: CONVERSATIONAL
useCase: OTP
details:
brand:
emails:
- label: label
address: test@test.com
- label: label-1
address: test-1@test.com
- label: label-2
address: test-2@test.com
phones:
- label: label
number: '+48777777777'
- label: label-1
number: '48888888888'
- label: label-2
number: '+48999999999'
websites:
- label: label
url: https://example.com
- label: label-1
url: https://example-1.com
- label: label-2
url: https://example-2.com
color: '#000000'
description: Test description
bannerUrl: https://example-banner-url.com
logoUrl: https://example-logo-url.com
privacyPolicyUrl: https://example-private-policy-url.com
termsOfServiceUrl: https://example-terms-of-service-url.com
name: Test name
testNumbers:
- '+48777777777'
countries:
- GB
- FR
questionnaire:
general:
answers:
optInDescription: By subscribing to a newsletter
triggerDescription: User actions (e.g. after making a purchase)
interactionsDescription: Billing or payment reminders,aef Order updates,aef Upon package delivery
interactionsDescriptionMetadata:
ignore: ',aef'
optOutDescription: We have registered your opt out request
videoUris:
- https://example-video-url.com
screenshotUris:
- https://example-screenshot-url.com
verification:
answers:
name: Exam Ple
email: email@example.com
title: Head Example
website: https://example.com
phone: '+48777777777'
partner:
companyName: Partner company
contactName: Partner contact name
contactEmailAddress: partner.contact@partner-company.com
gb:
answers:
brandIndustry: Automotive
companyLegalName: Example company legal name
companyRegistrationNumber: 123-123456789
fullCompanyAddress: Skeppsbron 1 Malmö, 123 12, Sweden
messagesVolume: 10K - 100K messages
messagesFrequency: Once per month
fr:
answers:
fullCompanyAddress: Skeppsbron 1-split-211 20-split-Malmö
fullCompanyAddressMetadata:
ignore: -split-
siren: '123456789'
us:
answers:
companyLegalName: Example company legal name
ein: 12-3456789
brandIndustry: Automotive
fullCompanyAddress: Skeppsbron 1-split-211 20-split-Malmö
fullCompanyAddressMetadata:
ignore: -split-
smsCampaign: We have registered your opt out request
messagesVolume: 10K - 100K messages
responses:
'201':
description: Sender
content:
application/json:
schema:
$ref: '#/components/schemas/RcsSenderDto'
examples:
newResponse:
summary: Create response
description: "\n Response when successfully creating a sender.\n "
value:
id: cf11794a-6a5e-4a12-b103-da79bd378bf1
state: IN_TEST
testNumberStates:
- number: '+46123123111'
state: UNVERIFIED
submitted: '2023-01-19t13:11:08.204Z'
- number: '+46123123222'
state: VERIFIED
submitted: '2023-01-19t13:11:08.204Z'
- number: '+46123123333'
state: DECLINED
submitted: '2023-01-19t13:11:08.204Z'
countryStatus:
- country: FR
status: NOT_LAUNCHED
operators:
- name: Coriolis Telecom
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Lycamobile
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Bouygues
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Free
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: NRJ Mobile
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: SFR
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Orange
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- country: GB
status: NOT_LAUNCHED
operators:
- name: EE
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Three
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Sky
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: O2
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Vodafone
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- country: SE
status: NOT_LAUNCHED
operators:
- name: Tele2
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Telenor
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Telia
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Three
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
details:
brand:
emails:
- label: label
address: test@test.com
- label: label-1
address: test-1@test.com
- label: label-2
address: test-2@test.com
phones:
- label: label
number: '+48777777777'
- label: label-1
number: '48888888888'
- label: label-2
number: '+48999999999'
websites:
- label: label
url: https://example.com
- label: label-1
url: https://example-1.com
- label: label-2
url: https://example-2.com
color: '#000000'
description: Test description
bannerUrl: https://example-banner-url.com
logoUrl: https://example-logo-url.com
privacyPolicyUrl: https://example-private-policy-url.com
termsOfServiceUrl: https://example-terms-of-service-url.com
name: Test name
testNumbers:
- '+48777777777'
countries:
- FR
- GB
- SE
questionnaire:
general:
questions:
optInDescription:
question: How do users agree to receive messages from your business through the agent?
suggestedAnswers:
- By subscribing to our loyalty program
- By making a purchase in-store or online
- By subscribing to a newsletter
- By creating an account on our website or app
triggerDescription:
question: When does your business send messages to users through the agent?
suggestedAnswers:
- User actions (e.g. after making a purchase)
interactionsDescription:
question: How will users interact with your business through the agent?
suggestedAnswers:
- Online Payment
- Password reset
- OTP/2FA for account login
optOutDescription:
question: What message does your business send when a user opts out?
suggestedAnswers:
- Thank you for opting out
- Thank you for unsubscribing
- We have registered your opt out request
videoUris:
question: ''
suggestedAnswers: []
screenshotUris:
question: ''
suggestedAnswers: []
answers:
optInDescription: By subscribing to a newsletter
triggerDescription: User actions (e.g. after making a purchase)
interactionsDescription: Billing or payment reminders,aef Order updates,aef Upon package delivery
interactionsDescriptionMetadata:
ignore: ',aef'
optOutDescription: We have registered your opt out request
videoUris:
- https://example-video-url.com
screenshotUris:
- https://example-screenshot-url.com
verification:
questions:
name:
question: What is the name of your verification contact?
suggestedAnswers: []
email:
question: What is the email of your verification contact?
suggestedAnswers: []
title:
question: What is the title of your verification contact?
suggestedAnswers: []
website:
question: What is the website of your verification contact?
suggestedAnswers: []
phone:
question: What is the phone number of your verification contact?
suggestedAnswers: []
partner:
companyName:
question: 'For ASP resellers: what is the name of the brand partner company?'
suggestedAnswers: []
contactName:
question: 'For ASP resellers: what is the name of the brand partner contact person?'
suggestedAnswers: []
contactEmailAddress:
question: 'For ASP resellers: what is the email of the brand partner contact person?'
suggestedAnswers: []
answers:
name: Exam Ple
email: email@example.com
title: Head Example
website: https://example.com
phone: '+48777777777'
partner:
companyName: Partner company
contactName: Partner contact name
contactEmailAddress: partner.contact@partner-company.com
gb:
questions:
brandIndustry:
question: What sector or industry does your business operate in?
suggestedAnswers:
- Automotive
- Beauty, spa and salon
- Clothing
- Education
- Entertainment
- Event planning and service
- Finance and banking
- Food and groceries
- Public service
- Hotel and lodging
- Medical and health
- Charity
- Professional services
- Shopping and retail
- Travel and transportation
- Restaurant
companyLegalName:
question: What is the registered legal name of your company?
suggestedAnswers: []
companyRegistrationNumber:
question: What is the registration number of your company?
suggestedAnswers: []
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
messagesVolume:
question: What is the total volume of messages expected to be sent by your agent?
suggestedAnswers:
- 0 - 10K messages
- 10K - 100K messages
- 100K - 1M messages
- 1M+ messages
messagesFrequency:
question: How often do you expect to send messages?
suggestedAnswers:
- Once per day
- Once per week
- Once per month
- Once per 3 months
- Once per 6 months
campaignLength:
question: What will be the length of the RCS campaign?
suggestedAnswers:
- 1 day or less
- 2 to 7 days
- 8 to 21 days
- 1 month
- 3 months
- 6 months
- Continuous / ongoing
answers:
brandIndustry: Automotive
companyLegalName: Example company legal name
companyRegistrationNumber: 123-123456789
fullCompanyAddress: Skeppsbron 1 Malmö, 123 12, Sweden
messagesVolume: 10K - 100K messages
messagesFrequency: Once per month
fr:
questions:
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
siren:
question: What is your Company directory identification system number (SIREN)?
suggestedAnswers: []
answers:
fullCompanyAddress: Skeppsbron 1-split-211 20-split-Malmö
fullCompanyAddressMetadata:
ignore: -split-
siren: '123456789'
us:
questions:
ownershipType:
question: What is the ownership type of your company?
suggestedAnswers:
- PRIVATE
- PUBLIC
companyLegalName:
question: What is the registered legal name of your company?
suggestedAnswers: []
companyPhoneNumber:
question: What is the primary phone number of your company?
suggestedAnswers: []
companyEmailAddress:
question: What is the primary email address of your company?
suggestedAnswers: []
brandName:
question: What is your brand name or Doing Business As (DBA)?
suggestedAnswers: []
brandIndustry:
question: What sector or industry does your business operate in?
suggestedAnswers:
- AGRICULTURE
- COMMUNICATION
- CONSTRUCTION
- EDUCATION
- ENERGY
- ENTERTAINMENT
- FINANCIAL
- GAMBLING
- GOVERNMENT
- HEALTHCARE
- HOSPITALITY
- HUMAN_RESOURCES
- INSURANCE
- LEGAL
- MANUFACTURING
- NON_GOVERNMENTAL_ORGANIZATION
- POLITICAL
- POSTAL
- PROFESSIONAL
- REAL_ESTATE
- RETAIL
- TECHNOLOGY
- TRANSPORTATION
legalForm:
question: What is the legal form of your company?
suggestedAnswers:
- CORPORATION
- LIMITED_LIABILITY_COMPANY
- PARTNERSHIP
- S_CORPORATION
taxIdCountry:
question: In which country is your company's tax ID registered?
suggestedAnswers: []
taxId:
question: 'For non-US companies: what is the tax ID of your company?'
suggestedAnswers: []
addressLine:
question: What is the primary street address of your company?
suggestedAnswers: []
addressCity:
question: In which city is your company located?
suggestedAnswers: []
addressCountry:
question: In which country is your company located?
suggestedAnswers: []
addressState:
question: In which state is your company located?
suggestedAnswers: []
addressPostalCode:
question: What is the postal code for your company address?
suggestedAnswers: []
websiteUrl:
question: What is the primary website URL for your company?
suggestedAnswers: []
contactFirstName:
question: What is the first name of the responsible contact person for your company?
suggestedAnswers: []
contactSurname:
question: What is the surname of the responsible contact person for your company?
suggestedAnswers: []
stockExchange:
question: What is the primary home country stock exchange abbreviation?
suggestedAnswers: []
stockSymbol:
question: What is the primary home country stock symbol associated with the stock exchange?
suggestedAnswers: []
sampleMessages:
question: Please provide sample messages for each use case or message type sent by your brand.
suggestedAnswers: []
messagesVolume:
question: What is the expected message volume?
suggestedAnswers: []
embeddedLink:
question: Does your brand send messages that contain embedded links to external websites?
suggestedAnswers: []
embeddedPhone:
question: Does your brand send messages that contain embedded phone numbers for direct calling?
suggestedAnswers: []
ageGatedContent:
question: Does your brand send messages that contain age-gated content or require age verification?
suggestedAnswers: []
directLending:
question: Does your brand send messages that involve direct lending or financial services?
suggestedAnswers: []
optInConfirmationMessage:
question: Does your brand send opt-in confirmation messages to users who have subscribed to receive messages?
suggestedAnswers: []
helpMessage:
question: Does your brand send help messages that provide assistance or support information to users?
suggestedAnswers: []
callToActionMessage:
question: Does your brand send call-to-action messages that encourage users to take specific actions?
suggestedAnswers: []
answers:
ownershipType: PUBLIC
companyLegalName: Example company legal name
companyPhoneNumber: '+48777777777'
companyEmailAddress: email@example.com
brandName: Example brand name
brandIndustry: AGRICULTURE
legalForm: CORPORATION
taxIdCountry: US
taxId: 12-3456789
addressLine: 123 Main St
addressCity: Anytown
addressCountry: US
addressState: CA
addressPostalCode: '12345'
websiteUrl: https://example.com
contactFirstName: John
contactSurname: Doe
stockExchange: NASDAQ
stockSymbol: EXMPL
sampleMessages:
- Sample message 1 for the US questionnaire.
- Sample message 2 for the US questionnaire.
messagesVolume: 10000
embeddedLink: true
embeddedPhone: true
ageGatedContent: false
directLending: false
optInConfirmationMessage: Thank you for opting in!
helpMessage: For help, contact support.
callToActionMessage: Click here to claim your special offer and explore our latest updates now.
region: EU
billingCategory: CONVERSATIONAL
useCase: OTP
hostingRegion: EUROPE
authName: yurwN6123asd
authToken: ejiiqJtDyurwN6jLze8v
conversationApiApp: 4CF9CE97504C4A468F4610919D17ECC1
conversationApiAppDetails:
id: 4CF9CE97504C4A468F4610919D17ECC1
projectId: ea026751-3edf-40a9-ad93-1b382bd60a78
region: EU
channelStatus: ACTIVE
created: '2023-01-19t13:11:08.204Z'
modified: '2023-01-19t13:11:08.204Z'
launched: '2023-01-19t13:11:08.204Z'
supplierDetails:
google:
agentId: agentId
brandId: brandId
response:
summary: '[Deprecated] Create response'
description: "\n Response when successfully creating a sender.\n "
value:
id: cf11794a-6a5e-4a12-b103-da79bd378bf1
state: IN_TEST
testNumberStates:
- number: '+46123123111'
state: UNVERIFIED
submitted: '2023-01-19t13:11:08.204Z'
- number: '+46123123222'
state: VERIFIED
submitted: '2023-01-19t13:11:08.204Z'
- number: '+46123123333'
state: DECLINED
submitted: '2023-01-19t13:11:08.204Z'
countryStatus:
- country: FR
status: NOT_LAUNCHED
operators:
- name: Coriolis Telecom
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Lycamobile
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Bouygues
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Free
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: NRJ Mobile
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: SFR
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Orange
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- country: GB
status: NOT_LAUNCHED
operators:
- name: EE
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Three
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Sky
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: O2
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Vodafone
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- country: SE
status: NOT_LAUNCHED
operators:
- name: Tele2
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Telenor
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Telia
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Three
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
details:
brand:
emails:
- label: label
address: test@test.com
- label: label-1
address: test-1@test.com
- label: label-2
address: test-2@test.com
phones:
- label: label
number: '+48777777777'
- label: label-1
number: '48888888888'
- label: label-2
number: '+48999999999'
websites:
- label: label
url: https://example.com
- label: label-1
url: https://example-1.com
- label: label-2
url: https://example-2.com
color: '#000000'
description: Test description
bannerUrl: https://example-banner-url.com
logoUrl: https://example-logo-url.com
privacyPolicyUrl: https://example-private-policy-url.com
termsOfServiceUrl: https://example-terms-of-service-url.com
name: Test name
testNumbers:
- '+48777777777'
countries:
- FR
- GB
- SE
questionnaire:
general:
questions:
optInDescription:
question: How do users agree to receive messages from your business through the agent?
suggestedAnswers:
- By subscribing to our loyalty program
- By making a purchase in-store or online
- By subscribing to a newsletter
- By creating an account on our website or app
triggerDescription:
question: When does your business send messages to users through the agent?
suggestedAnswers:
- User actions (e.g. after making a purchase)
interactionsDescription:
question: How will users interact with your business through the agent?
suggestedAnswers:
- Online Payment
- Password reset
- OTP/2FA for account login
optOutDescription:
question: What message does your business send when a user opts out?
suggestedAnswers:
- Thank you for opting out
- Thank you for unsubscribing
- We have registered your opt out request
videoUris:
question: ''
suggestedAnswers: []
screenshotUris:
question: ''
suggestedAnswers: []
answers:
optInDescription: By subscribing to a newsletter
triggerDescription: User actions (e.g. after making a purchase)
interactionsDescription: Billing or payment reminders,aef Order updates,aef Upon package delivery
interactionsDescriptionMetadata:
ignore: ',aef'
optOutDescription: We have registered your opt out request
videoUris:
- https://example-video-url.com
screenshotUris:
- https://example-screenshot-url.com
verification:
questions:
name:
question: What is the name of your verification contact?
suggestedAnswers: []
email:
question: What is the email of your verification contact?
suggestedAnswers: []
title:
question: What is the title of your verification contact?
suggestedAnswers: []
website:
question: What is the website of your verification contact?
suggestedAnswers: []
phone:
question: What is the phone number of your verification contact?
suggestedAnswers: []
partner:
companyName:
question: 'For ASP resellers: what is the name of the brand partner company?'
suggestedAnswers: []
contactName:
question: 'For ASP resellers: what is the name of the brand partner contact person?'
suggestedAnswers: []
contactEmailAddress:
question: 'For ASP resellers: what is the email of the brand partner contact person?'
suggestedAnswers: []
answers:
name: Exam Ple
email: email@example.com
title: Head Example
website: https://example.com
phone: '+48777777777'
partner:
companyName: Partner company
contactName: Partner contact name
contactEmailAddress: partner.contact@partner-company.com
gb:
questions:
brandIndustry:
question: What sector or industry does your business operate in?
suggestedAnswers:
- Automotive
- Beauty, spa and salon
- Clothing
- Education
- Entertainment
- Event planning and service
- Finance and banking
- Food and groceries
- Public service
- Hotel and lodging
- Medical and health
- Charity
- Professional services
- Shopping and retail
- Travel and transportation
- Restaurant
companyLegalName:
question: What is the registered legal name of your company?
suggestedAnswers: []
companyRegistrationNumber:
question: What is the registration number of your company?
suggestedAnswers: []
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
messagesVolume:
question: What is the total volume of messages expected to be sent by your agent?
suggestedAnswers:
- 0 - 10K messages
- 10K - 100K messages
- 100K - 1M messages
- 1M+ messages
messagesFrequency:
question: How often do you expect to send messages?
suggestedAnswers:
- Once per day
- Once per week
- Once per month
- Once per 3 months
- Once per 6 months
campaignLength:
question: What will be the length of the RCS campaign?
suggestedAnswers:
- 1 day or less
- 2 to 7 days
- 8 to 21 days
- 1 month
- 3 months
- 6 months
- Continuous / ongoing
answers:
brandIndustry: Automotive
companyLegalName: Example company legal name
companyRegistrationNumber: 123-123456789
fullCompanyAddress: Skeppsbron 1 Malmö, 123 12, Sweden
messagesVolume: 10K - 100K messages
messagesFrequency: Once per month
fr:
questions:
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
siren:
question: What is your Company directory identification system number (SIREN)?
suggestedAnswers: []
answers:
fullCompanyAddress: Skeppsbron 1-split-211 20-split-Malmö
fullCompanyAddressMetadata:
ignore: -split-
siren: '123456789'
us:
questions:
companyLegalName:
question: What is the registered legal name of your company?
suggestedAnswers: []
ein:
question: What is the Employer Identification Number (EIN) of your company?
suggestedAnswers: []
brandIndustry:
question: What sector or industry does your business operate in?
suggestedAnswers:
- Automotive
- Beauty, spa and salon
- Clothing
- Education
- Entertainment
- Event planning and service
- Finance and banking
- Food and groceries
- Public service
- Hotel and lodging
- Medical and health
- Charity
- Professional services
- Shopping and retail
- Travel and transportation
- Restaurant
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
smsCampaign:
question: US SMS campaign used as fallback.
suggestedAnswers: []
messagesVolume:
question: What is the total volume of messages expected to be sent by your agent?
suggestedAnswers:
- 0 - 10K messages
- 10K - 100K messages
- 100K - 1M messages
- 1M+ messages
answers:
companyLegalName: Example company legal name
ein: 12-3456789
brandIndustry: Automotive
fullCompanyAddress: Skeppsbron 1-split-211 20-split-Malmö
fullCompanyAddressMetadata:
ignore: -split-
smsCampaign: We have registered your opt out request
messagesVolume: 10K - 100K messages
region: EU
billingCategory: CONVERSATIONAL
useCase: OTP
hostingRegion: EUROPE
authName: yurwN6123asd
authToken: ejiiqJtDyurwN6jLze8v
conversationApiApp: 4CF9CE97504C4A468F4610919D17ECC1
conversationApiAppDetails:
id: 4CF9CE97504C4A468F4610919D17ECC1
projectId: ea026751-3edf-40a9-ad93-1b382bd60a78
region: EU
channelStatus: ACTIVE
created: '2023-01-19t13:11:08.204Z'
modified: '2023-01-19t13:11:08.204Z'
launched: '2023-01-19t13:11:08.204Z'
supplierDetails:
google:
agentId: agentId
brandId: brandId
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
invalid_input-0:
summary: InvalidInputError
value:
errorCode: invalid_input
message: Invalid input.
resolution: Correct the validation errors and submit again.
additionalInformation:
validationErrors:
- details.brand.email.address must be an email
file_invalid_mime_type-1:
summary: FileInvalidMimeTypeError
value:
errorCode: file_invalid_mime_type
message: 'details.brand.bannerUrl: invalid file mime type.'
resolution: 'Try again with supported mime types: image/jpeg, image/png.'
invalid_payload-2:
summary: InvalidPayloadError
value:
errorCode: invalid_payload
message: Invalid payload.
resolution: Correct payload and submit again.
invalid_google_agent-3:
summary: InvalidGoogleAgentError
value:
errorCode: invalid_google_agent
message: message
resolution: Verify the sender's fields.
add_test_number_invalid-4:
summary: AddTestNumberInvalidError
value:
errorCode: add_test_number_invalid
message: Invalid phone number.
resolution: Please verify that phone number is correct.
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
unauthorized_error-0:
summary: UnauthorizedErrorError
value:
errorCode: unauthorized_error
message: Unauthorized error.
resolution: Verify that projectId is correct.
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
rbm_has_not_been_used-0:
summary: RbmHasNotBeenUsedError
value:
errorCode: rbm_has_not_been_used
message: RBM has not been used.
resolution: Please wait and try again or reach out to support at si-richmessaging@sinch.com
rbm_webhook_incorrect_secret-1:
summary: RbmWebhookIncorrectSecretError
value:
errorCode: rbm_webhook_incorrect_secret
message: RBM webhook has incorrect secret
resolution: Please wait and try again or reach out to support at si-richmessaging@sinch.com
'404':
description: NotFound
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
project_not_found-0:
summary: ProjectNotFoundError
value:
errorCode: project_not_found
message: Project not found.
resolution: Verify that the projectId is correct.
rbm_resources_not_found-1:
summary: RbmResourcesNotFoundError
value:
errorCode: rbm_resources_not_found
message: RBM resources not found.
resolution: Verify that the parameters are correct, and contact support if error persists.
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
account_data_is_corrupt-0:
summary: AccountDataIsCorruptError
value:
errorCode: account_data_is_corrupt
message: Account data is corrupt.
resolution: Please contact support.
file_not_found-1:
summary: FileNotFoundError
value:
errorCode: file_not_found
message: 'details.brand.logoUrl: file not found.'
resolution: Verify that the url is correct.
file_size_too_large-2:
summary: FileSizeTooLargeError
value:
errorCode: file_size_too_large
message: 'details.brand.bannerUrl: file size is too large.'
resolution: Try again with a smaller file. Max size for `image/jpeg` is 200KB.
file_has_wrong_dimensions-3:
summary: FileHasWrongDimensionsError
value:
errorCode: file_has_wrong_dimensions
message: 'details.brand.logoUrl: image has wrong dimensions.'
resolution: 'Try again with image dimensions: exact 224 x 224 px.'
file_unexpected_error-4:
summary: FileUnexpectedErrorError
value:
errorCode: file_unexpected_error
message: 'details.brand.logoUrl: file unexpected error.'
resolution: The file cannot be handled properly. Please try with another one.
'429':
description: TooManyRequests
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
rbm_too_many_requests-0:
summary: RbmTooManyRequestsError
value:
errorCode: rbm_too_many_requests
message: RCS Business Messaging too many requests.
resolution: Please wait and try again.
'500':
description: InternalServerError
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
internal_error-0:
summary: InternalErrorError
value:
errorCode: internal_error
message: Internal server error.
resolution: Please wait and try again, if the error persist please contact support.
summary: Create sender for project
tags:
- RCS Senders
x-badges:
- name: GA
position: after
color: green
security:
- BasicAuth: []
BearerAuth: []
OAuth2Production: []
servers:
- url: https://provisioning.api.sinch.com
description: Production server
/v1/projects/{projectId}/rcs/senders/{senderId}:
get:
description: Returns a sender for a project.
operationId: RcsSendersController_getSender_v1
parameters:
- name: projectId
required: true
in: path
description: The unique ID of the project. You can find this on the Sinch Dashboard.
schema:
type: string
- name: senderId
required: true
in: path
description: The unique ID of the sender.
schema:
type: string
responses:
'200':
description: Sender
content:
application/json:
schema:
$ref: '#/components/schemas/RcsSenderDto'
examples:
newInTest:
summary: Get response inTest
description: "\n Response with a sender inTest.\n "
value:
id: cf11794a-6a5e-4a12-b103-da79bd378bf1
state: IN_TEST
testNumberStates:
- number: '+46123123111'
state: UNVERIFIED
submitted: '2023-01-19t13:11:08.204Z'
- number: '+46123123222'
state: VERIFIED
submitted: '2023-01-19t13:11:08.204Z'
- number: '+46123123333'
state: DECLINED
submitted: '2023-01-19t13:11:08.204Z'
countryStatus:
- country: FR
status: NOT_LAUNCHED
operators:
- name: Coriolis Telecom
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Lycamobile
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Bouygues
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Free
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: NRJ Mobile
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: SFR
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Orange
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- country: GB
status: NOT_LAUNCHED
operators:
- name: EE
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Three
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Sky
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: O2
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Vodafone
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- country: SE
status: NOT_LAUNCHED
operators:
- name: Tele2
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Telenor
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Telia
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Three
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
details:
brand:
emails:
- label: label
address: test@test.com
- label: label-1
address: test-1@test.com
- label: label-2
address: test-2@test.com
phones:
- label: label
number: '+48777777777'
- label: label-1
number: '48888888888'
- label: label-2
number: '+48999999999'
websites:
- label: label
url: https://example.com
- label: label-1
url: https://example-1.com
- label: label-2
url: https://example-2.com
color: '#000000'
description: Test description
bannerUrl: https://example-banner-url.com
logoUrl: https://example-logo-url.com
privacyPolicyUrl: https://example-private-policy-url.com
termsOfServiceUrl: https://example-terms-of-service-url.com
name: Test name
testNumbers:
- '+48777777777'
countries:
- FR
- GB
- SE
questionnaire:
general:
questions:
optInDescription:
question: How do users agree to receive messages from your business through the agent?
suggestedAnswers:
- By subscribing to our loyalty program
- By making a purchase in-store or online
- By subscribing to a newsletter
- By creating an account on our website or app
triggerDescription:
question: When does your business send messages to users through the agent?
suggestedAnswers:
- User actions (e.g. after making a purchase)
interactionsDescription:
question: How will users interact with your business through the agent?
suggestedAnswers:
- Online Payment
- Password reset
- OTP/2FA for account login
optOutDescription:
question: What message does your business send when a user opts out?
suggestedAnswers:
- Thank you for opting out
- Thank you for unsubscribing
- We have registered your opt out request
videoUris:
question: ''
suggestedAnswers: []
screenshotUris:
question: ''
suggestedAnswers: []
answers:
optInDescription: By subscribing to a newsletter
triggerDescription: User actions (e.g. after making a purchase)
interactionsDescription: Billing or payment reminders,aef Order updates,aef Upon package delivery
interactionsDescriptionMetadata:
ignore: ',aef'
optOutDescription: We have registered your opt out request
videoUris:
- https://example-video-url.com
screenshotUris:
- https://example-screenshot-url.com
verification:
questions:
name:
question: What is the name of your verification contact?
suggestedAnswers: []
email:
question: What is the email of your verification contact?
suggestedAnswers: []
title:
question: What is the title of your verification contact?
suggestedAnswers: []
website:
question: What is the website of your verification contact?
suggestedAnswers: []
phone:
question: What is the phone number of your verification contact?
suggestedAnswers: []
partner:
companyName:
question: 'For ASP resellers: what is the name of the brand partner company?'
suggestedAnswers: []
contactName:
question: 'For ASP resellers: what is the name of the brand partner contact person?'
suggestedAnswers: []
contactEmailAddress:
question: 'For ASP resellers: what is the email of the brand partner contact person?'
suggestedAnswers: []
answers:
name: Exam Ple
email: email@example.com
title: Head Example
website: https://example.com
phone: '+48777777777'
partner:
companyName: Partner company
contactName: Partner contact name
contactEmailAddress: partner.contact@partner-company.com
gb:
questions:
brandIndustry:
question: What sector or industry does your business operate in?
suggestedAnswers:
- Automotive
- Beauty, spa and salon
- Clothing
- Education
- Entertainment
- Event planning and service
- Finance and banking
- Food and groceries
- Public service
- Hotel and lodging
- Medical and health
- Charity
- Professional services
- Shopping and retail
- Travel and transportation
- Restaurant
companyLegalName:
question: What is the registered legal name of your company?
suggestedAnswers: []
companyRegistrationNumber:
question: What is the registration number of your company?
suggestedAnswers: []
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
messagesVolume:
question: What is the total volume of messages expected to be sent by your agent?
suggestedAnswers:
- 0 - 10K messages
- 10K - 100K messages
- 100K - 1M messages
- 1M+ messages
messagesFrequency:
question: How often do you expect to send messages?
suggestedAnswers:
- Once per day
- Once per week
- Once per month
- Once per 3 months
- Once per 6 months
campaignLength:
question: What will be the length of the RCS campaign?
suggestedAnswers:
- 1 day or less
- 2 to 7 days
- 8 to 21 days
- 1 month
- 3 months
- 6 months
- Continuous / ongoing
answers:
brandIndustry: Automotive
companyLegalName: Example company legal name
companyRegistrationNumber: 123-123456789
fullCompanyAddress: Skeppsbron 1 Malmö, 123 12, Sweden
messagesVolume: 10K - 100K messages
messagesFrequency: Once per month
fr:
questions:
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
siren:
question: What is your Company directory identification system number (SIREN)?
suggestedAnswers: []
answers:
fullCompanyAddress: Skeppsbron 1-split-211 20-split-Malmö
fullCompanyAddressMetadata:
ignore: -split-
siren: '123456789'
us:
questions:
ownershipType:
question: What is the ownership type of your company?
suggestedAnswers:
- PRIVATE
- PUBLIC
companyLegalName:
question: What is the registered legal name of your company?
suggestedAnswers: []
companyPhoneNumber:
question: What is the primary phone number of your company?
suggestedAnswers: []
companyEmailAddress:
question: What is the primary email address of your company?
suggestedAnswers: []
brandName:
question: What is your brand name or Doing Business As (DBA)?
suggestedAnswers: []
brandIndustry:
question: What sector or industry does your business operate in?
suggestedAnswers:
- AGRICULTURE
- COMMUNICATION
- CONSTRUCTION
- EDUCATION
- ENERGY
- ENTERTAINMENT
- FINANCIAL
- GAMBLING
- GOVERNMENT
- HEALTHCARE
- HOSPITALITY
- HUMAN_RESOURCES
- INSURANCE
- LEGAL
- MANUFACTURING
- NON_GOVERNMENTAL_ORGANIZATION
- POLITICAL
- POSTAL
- PROFESSIONAL
- REAL_ESTATE
- RETAIL
- TECHNOLOGY
- TRANSPORTATION
legalForm:
question: What is the legal form of your company?
suggestedAnswers:
- CORPORATION
- LIMITED_LIABILITY_COMPANY
- PARTNERSHIP
- S_CORPORATION
taxIdCountry:
question: In which country is your company's tax ID registered?
suggestedAnswers: []
taxId:
question: 'For non-US companies: what is the tax ID of your company?'
suggestedAnswers: []
addressLine:
question: What is the primary street address of your company?
suggestedAnswers: []
addressCity:
question: In which city is your company located?
suggestedAnswers: []
addressCountry:
question: In which country is your company located?
suggestedAnswers: []
addressState:
question: In which state is your company located?
suggestedAnswers: []
addressPostalCode:
question: What is the postal code for your company address?
suggestedAnswers: []
websiteUrl:
question: What is the primary website URL for your company?
suggestedAnswers: []
contactFirstName:
question: What is the first name of the responsible contact person for your company?
suggestedAnswers: []
contactSurname:
question: What is the surname of the responsible contact person for your company?
suggestedAnswers: []
stockExchange:
question: What is the primary home country stock exchange abbreviation?
suggestedAnswers: []
stockSymbol:
question: What is the primary home country stock symbol associated with the stock exchange?
suggestedAnswers: []
sampleMessages:
question: Please provide sample messages for each use case or message type sent by your brand.
suggestedAnswers: []
messagesVolume:
question: What is the expected message volume?
suggestedAnswers: []
embeddedLink:
question: Does your brand send messages that contain embedded links to external websites?
suggestedAnswers: []
embeddedPhone:
question: Does your brand send messages that contain embedded phone numbers for direct calling?
suggestedAnswers: []
ageGatedContent:
question: Does your brand send messages that contain age-gated content or require age verification?
suggestedAnswers: []
directLending:
question: Does your brand send messages that involve direct lending or financial services?
suggestedAnswers: []
optInConfirmationMessage:
question: Does your brand send opt-in confirmation messages to users who have subscribed to receive messages?
suggestedAnswers: []
helpMessage:
question: Does your brand send help messages that provide assistance or support information to users?
suggestedAnswers: []
callToActionMessage:
question: Does your brand send call-to-action messages that encourage users to take specific actions?
suggestedAnswers: []
answers:
ownershipType: PUBLIC
companyLegalName: Example company legal name
companyPhoneNumber: '+48777777777'
companyEmailAddress: email@example.com
brandName: Example brand name
brandIndustry: AGRICULTURE
legalForm: CORPORATION
taxIdCountry: US
taxId: 12-3456789
addressLine: 123 Main St
addressCity: Anytown
addressCountry: US
addressState: CA
addressPostalCode: '12345'
websiteUrl: https://example.com
contactFirstName: John
contactSurname: Doe
stockExchange: NASDAQ
stockSymbol: EXMPL
sampleMessages:
- Sample message 1 for the US questionnaire.
- Sample message 2 for the US questionnaire.
messagesVolume: 10000
embeddedLink: true
embeddedPhone: true
ageGatedContent: false
directLending: false
optInConfirmationMessage: Thank you for opting in!
helpMessage: For help, contact support.
callToActionMessage: Click here to claim your special offer and explore our latest updates now.
region: EU
billingCategory: CONVERSATIONAL
useCase: OTP
hostingRegion: EUROPE
authName: yurwN6123asd
authToken: ejiiqJtDyurwN6jLze8v
conversationApiApp: 4CF9CE97504C4A468F4610919D17ECC1
conversationApiAppDetails:
id: 4CF9CE97504C4A468F4610919D17ECC1
projectId: ea026751-3edf-40a9-ad93-1b382bd60a78
region: EU
channelStatus: ACTIVE
created: '2023-01-19t13:11:08.204Z'
modified: '2023-01-19t13:11:08.204Z'
launched: '2023-01-19t13:11:08.204Z'
supplierDetails:
google:
agentId: agentId
brandId: brandId
newPreparingLaunch:
summary: Get response preparingLaunch
description: "\n Response with a sender preparingLaunch.\n "
value:
id: cf11794a-6a5e-4a12-b103-da79bd378bf1
state: PREPARING_LAUNCH
testNumberStates:
- number: '+46123123111'
state: UNVERIFIED
submitted: '2023-01-19t13:11:08.204Z'
- number: '+46123123222'
state: VERIFIED
submitted: '2023-01-19t13:11:08.204Z'
- number: '+46123123333'
state: DECLINED
submitted: '2023-01-19t13:11:08.204Z'
countryStatus:
- country: FR
status: PENDING
operators:
- name: Coriolis Telecom
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Lycamobile
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Bouygues
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Free
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: NRJ Mobile
status: REJECTED
remark: Sender was rejected due to operator policy.
modified: '2023-01-19t13:11:08.204Z'
- name: SFR
status: SUSPENDED
modified: '2023-01-19t13:11:08.204Z'
- name: Orange
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- country: GB
status: PENDING
operators:
- name: EE
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Three
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Sky
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: O2
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Vodafone
status: SUSPENDED
modified: '2023-01-19t13:11:08.204Z'
- country: SE
status: PENDING
operators:
- name: Tele2
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Telenor
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Telia
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Three
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
details:
brand:
emails:
- label: label
address: test@test.com
- label: label-1
address: test-1@test.com
- label: label-2
address: test-2@test.com
phones:
- label: label
number: '+48777777777'
- label: label-1
number: '48888888888'
- label: label-2
number: '+48999999999'
websites:
- label: label
url: https://example.com
- label: label-1
url: https://example-1.com
- label: label-2
url: https://example-2.com
color: '#000000'
description: Test description
bannerUrl: https://example-banner-url.com
logoUrl: https://example-logo-url.com
privacyPolicyUrl: https://example-private-policy-url.com
termsOfServiceUrl: https://example-terms-of-service-url.com
name: Test name
testNumbers:
- '+48777777777'
countries:
- FR
- GB
- SE
questionnaire:
general:
questions:
optInDescription:
question: How do users agree to receive messages from your business through the agent?
suggestedAnswers:
- By subscribing to our loyalty program
- By making a purchase in-store or online
- By subscribing to a newsletter
- By creating an account on our website or app
triggerDescription:
question: When does your business send messages to users through the agent?
suggestedAnswers:
- User actions (e.g. after making a purchase)
interactionsDescription:
question: How will users interact with your business through the agent?
suggestedAnswers:
- Online Payment
- Password reset
- OTP/2FA for account login
optOutDescription:
question: What message does your business send when a user opts out?
suggestedAnswers:
- Thank you for opting out
- Thank you for unsubscribing
- We have registered your opt out request
videoUris:
question: ''
suggestedAnswers: []
screenshotUris:
question: ''
suggestedAnswers: []
answers:
optInDescription: By subscribing to a newsletter
triggerDescription: User actions (e.g. after making a purchase)
interactionsDescription: Billing or payment reminders,aef Order updates,aef Upon package delivery
interactionsDescriptionMetadata:
ignore: ',aef'
optOutDescription: We have registered your opt out request
videoUris:
- https://example-video-url.com
screenshotUris:
- https://example-screenshot-url.com
verification:
questions:
name:
question: What is the name of your verification contact?
suggestedAnswers: []
email:
question: What is the email of your verification contact?
suggestedAnswers: []
title:
question: What is the title of your verification contact?
suggestedAnswers: []
website:
question: What is the website of your verification contact?
suggestedAnswers: []
phone:
question: What is the phone number of your verification contact?
suggestedAnswers: []
partner:
companyName:
question: 'For ASP resellers: what is the name of the brand partner company?'
suggestedAnswers: []
contactName:
question: 'For ASP resellers: what is the name of the brand partner contact person?'
suggestedAnswers: []
contactEmailAddress:
question: 'For ASP resellers: what is the email of the brand partner contact person?'
suggestedAnswers: []
answers:
name: Exam Ple
email: email@example.com
title: Head Example
website: https://example.com
phone: '+48777777777'
partner:
companyName: Partner company
contactName: Partner contact name
contactEmailAddress: partner.contact@partner-company.com
gb:
questions:
brandIndustry:
question: What sector or industry does your business operate in?
suggestedAnswers:
- Automotive
- Beauty, spa and salon
- Clothing
- Education
- Entertainment
- Event planning and service
- Finance and banking
- Food and groceries
- Public service
- Hotel and lodging
- Medical and health
- Charity
- Professional services
- Shopping and retail
- Travel and transportation
- Restaurant
companyLegalName:
question: What is the registered legal name of your company?
suggestedAnswers: []
companyRegistrationNumber:
question: What is the registration number of your company?
suggestedAnswers: []
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
messagesVolume:
question: What is the total volume of messages expected to be sent by your agent?
suggestedAnswers:
- 0 - 10K messages
- 10K - 100K messages
- 100K - 1M messages
- 1M+ messages
messagesFrequency:
question: How often do you expect to send messages?
suggestedAnswers:
- Once per day
- Once per week
- Once per month
- Once per 3 months
- Once per 6 months
campaignLength:
question: What will be the length of the RCS campaign?
suggestedAnswers:
- 1 day or less
- 2 to 7 days
- 8 to 21 days
- 1 month
- 3 months
- 6 months
- Continuous / ongoing
answers:
brandIndustry: Automotive
companyLegalName: Example company legal name
companyRegistrationNumber: 123-123456789
fullCompanyAddress: Skeppsbron 1 Malmö, 123 12, Sweden
messagesVolume: 10K - 100K messages
messagesFrequency: Once per month
fr:
questions:
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
siren:
question: What is your Company directory identification system number (SIREN)?
suggestedAnswers: []
answers:
fullCompanyAddress: Skeppsbron 1-split-211 20-split-Malmö
fullCompanyAddressMetadata:
ignore: -split-
siren: '123456789'
us:
questions:
ownershipType:
question: What is the ownership type of your company?
suggestedAnswers:
- PRIVATE
- PUBLIC
companyLegalName:
question: What is the registered legal name of your company?
suggestedAnswers: []
companyPhoneNumber:
question: What is the primary phone number of your company?
suggestedAnswers: []
companyEmailAddress:
question: What is the primary email address of your company?
suggestedAnswers: []
brandName:
question: What is your brand name or Doing Business As (DBA)?
suggestedAnswers: []
brandIndustry:
question: What sector or industry does your business operate in?
suggestedAnswers:
- AGRICULTURE
- COMMUNICATION
- CONSTRUCTION
- EDUCATION
- ENERGY
- ENTERTAINMENT
- FINANCIAL
- GAMBLING
- GOVERNMENT
- HEALTHCARE
- HOSPITALITY
- HUMAN_RESOURCES
- INSURANCE
- LEGAL
- MANUFACTURING
- NON_GOVERNMENTAL_ORGANIZATION
- POLITICAL
- POSTAL
- PROFESSIONAL
- REAL_ESTATE
- RETAIL
- TECHNOLOGY
- TRANSPORTATION
legalForm:
question: What is the legal form of your company?
suggestedAnswers:
- CORPORATION
- LIMITED_LIABILITY_COMPANY
- PARTNERSHIP
- S_CORPORATION
taxIdCountry:
question: In which country is your company's tax ID registered?
suggestedAnswers: []
taxId:
question: 'For non-US companies: what is the tax ID of your company?'
suggestedAnswers: []
addressLine:
question: What is the primary street address of your company?
suggestedAnswers: []
addressCity:
question: In which city is your company located?
suggestedAnswers: []
addressCountry:
question: In which country is your company located?
suggestedAnswers: []
addressState:
question: In which state is your company located?
suggestedAnswers: []
addressPostalCode:
question: What is the postal code for your company address?
suggestedAnswers: []
websiteUrl:
question: What is the primary website URL for your company?
suggestedAnswers: []
contactFirstName:
question: What is the first name of the responsible contact person for your company?
suggestedAnswers: []
contactSurname:
question: What is the surname of the responsible contact person for your company?
suggestedAnswers: []
stockExchange:
question: What is the primary home country stock exchange abbreviation?
suggestedAnswers: []
stockSymbol:
question: What is the primary home country stock symbol associated with the stock exchange?
suggestedAnswers: []
sampleMessages:
question: Please provide sample messages for each use case or message type sent by your brand.
suggestedAnswers: []
messagesVolume:
question: What is the expected message volume?
suggestedAnswers: []
embeddedLink:
question: Does your brand send messages that contain embedded links to external websites?
suggestedAnswers: []
embeddedPhone:
question: Does your brand send messages that contain embedded phone numbers for direct calling?
suggestedAnswers: []
ageGatedContent:
question: Does your brand send messages that contain age-gated content or require age verification?
suggestedAnswers: []
directLending:
question: Does your brand send messages that involve direct lending or financial services?
suggestedAnswers: []
optInConfirmationMessage:
question: Does your brand send opt-in confirmation messages to users who have subscribed to receive messages?
suggestedAnswers: []
helpMessage:
question: Does your brand send help messages that provide assistance or support information to users?
suggestedAnswers: []
callToActionMessage:
question: Does your brand send call-to-action messages that encourage users to take specific actions?
suggestedAnswers: []
answers:
ownershipType: PUBLIC
companyLegalName: Example company legal name
companyPhoneNumber: '+48777777777'
companyEmailAddress: email@example.com
brandName: Example brand name
brandIndustry: AGRICULTURE
legalForm: CORPORATION
taxIdCountry: US
taxId: 12-3456789
addressLine: 123 Main St
addressCity: Anytown
addressCountry: US
addressState: CA
addressPostalCode: '12345'
websiteUrl: https://example.com
contactFirstName: John
contactSurname: Doe
stockExchange: NASDAQ
stockSymbol: EXMPL
sampleMessages:
- Sample message 1 for the US questionnaire.
- Sample message 2 for the US questionnaire.
messagesVolume: 10000
embeddedLink: true
embeddedPhone: true
ageGatedContent: false
directLending: false
optInConfirmationMessage: Thank you for opting in!
helpMessage: For help, contact support.
callToActionMessage: Click here to claim your special offer and explore our latest updates now.
region: EU
billingCategory: CONVERSATIONAL
useCase: OTP
hostingRegion: EUROPE
authName: yurwN6123asd
authToken: ejiiqJtDyurwN6jLze8v
conversationApiApp: 4CF9CE97504C4A468F4610919D17ECC1
conversationApiAppDetails:
id: 4CF9CE97504C4A468F4610919D17ECC1
projectId: ea026751-3edf-40a9-ad93-1b382bd60a78
region: EU
channelStatus: ACTIVE
created: '2023-01-19t13:11:08.204Z'
modified: '2023-01-19t13:11:08.204Z'
launched: '2023-01-19t13:11:08.204Z'
supplierDetails:
google:
agentId: agentId
brandId: brandId
newLaunching:
summary: Get response launching
description: "\n Response with a sender launching.\n "
value:
id: cf11794a-6a5e-4a12-b103-da79bd378bf1
state: LAUNCHING
testNumberStates:
- number: '+46123123111'
state: UNVERIFIED
submitted: '2023-01-19t13:11:08.204Z'
- number: '+46123123222'
state: VERIFIED
submitted: '2023-01-19t13:11:08.204Z'
- number: '+46123123333'
state: DECLINED
submitted: '2023-01-19t13:11:08.204Z'
countryStatus:
- country: FR
status: PENDING
operators:
- name: Coriolis Telecom
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Lycamobile
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Bouygues
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Free
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: NRJ Mobile
status: REJECTED
remark: Sender was rejected due to operator policy.
modified: '2023-01-19t13:11:08.204Z'
- name: SFR
status: SUSPENDED
modified: '2023-01-19t13:11:08.204Z'
- name: Orange
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- country: GB
status: PENDING
operators:
- name: EE
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Three
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Sky
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: O2
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Vodafone
status: SUSPENDED
modified: '2023-01-19t13:11:08.204Z'
- country: SE
status: PENDING
operators:
- name: Tele2
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Telenor
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Telia
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Three
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
details:
brand:
emails:
- label: label
address: test@test.com
- label: label-1
address: test-1@test.com
- label: label-2
address: test-2@test.com
phones:
- label: label
number: '+48777777777'
- label: label-1
number: '48888888888'
- label: label-2
number: '+48999999999'
websites:
- label: label
url: https://example.com
- label: label-1
url: https://example-1.com
- label: label-2
url: https://example-2.com
color: '#000000'
description: Test description
bannerUrl: https://example-banner-url.com
logoUrl: https://example-logo-url.com
privacyPolicyUrl: https://example-private-policy-url.com
termsOfServiceUrl: https://example-terms-of-service-url.com
name: Test name
testNumbers:
- '+48777777777'
countries:
- FR
- GB
- SE
questionnaire:
general:
questions:
optInDescription:
question: How do users agree to receive messages from your business through the agent?
suggestedAnswers:
- By subscribing to our loyalty program
- By making a purchase in-store or online
- By subscribing to a newsletter
- By creating an account on our website or app
triggerDescription:
question: When does your business send messages to users through the agent?
suggestedAnswers:
- User actions (e.g. after making a purchase)
interactionsDescription:
question: How will users interact with your business through the agent?
suggestedAnswers:
- Online Payment
- Password reset
- OTP/2FA for account login
optOutDescription:
question: What message does your business send when a user opts out?
suggestedAnswers:
- Thank you for opting out
- Thank you for unsubscribing
- We have registered your opt out request
videoUris:
question: ''
suggestedAnswers: []
screenshotUris:
question: ''
suggestedAnswers: []
answers:
optInDescription: By subscribing to a newsletter
triggerDescription: User actions (e.g. after making a purchase)
interactionsDescription: Billing or payment reminders,aef Order updates,aef Upon package delivery
interactionsDescriptionMetadata:
ignore: ',aef'
optOutDescription: We have registered your opt out request
videoUris:
- https://example-video-url.com
screenshotUris:
- https://example-screenshot-url.com
verification:
questions:
name:
question: What is the name of your verification contact?
suggestedAnswers: []
email:
question: What is the email of your verification contact?
suggestedAnswers: []
title:
question: What is the title of your verification contact?
suggestedAnswers: []
website:
question: What is the website of your verification contact?
suggestedAnswers: []
phone:
question: What is the phone number of your verification contact?
suggestedAnswers: []
partner:
companyName:
question: 'For ASP resellers: what is the name of the brand partner company?'
suggestedAnswers: []
contactName:
question: 'For ASP resellers: what is the name of the brand partner contact person?'
suggestedAnswers: []
contactEmailAddress:
question: 'For ASP resellers: what is the email of the brand partner contact person?'
suggestedAnswers: []
answers:
name: Exam Ple
email: email@example.com
title: Head Example
website: https://example.com
phone: '+48777777777'
partner:
companyName: Partner company
contactName: Partner contact name
contactEmailAddress: partner.contact@partner-company.com
gb:
questions:
brandIndustry:
question: What sector or industry does your business operate in?
suggestedAnswers:
- Automotive
- Beauty, spa and salon
- Clothing
- Education
- Entertainment
- Event planning and service
- Finance and banking
- Food and groceries
- Public service
- Hotel and lodging
- Medical and health
- Charity
- Professional services
- Shopping and retail
- Travel and transportation
- Restaurant
companyLegalName:
question: What is the registered legal name of your company?
suggestedAnswers: []
companyRegistrationNumber:
question: What is the registration number of your company?
suggestedAnswers: []
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
messagesVolume:
question: What is the total volume of messages expected to be sent by your agent?
suggestedAnswers:
- 0 - 10K messages
- 10K - 100K messages
- 100K - 1M messages
- 1M+ messages
messagesFrequency:
question: How often do you expect to send messages?
suggestedAnswers:
- Once per day
- Once per week
- Once per month
- Once per 3 months
- Once per 6 months
campaignLength:
question: What will be the length of the RCS campaign?
suggestedAnswers:
- 1 day or less
- 2 to 7 days
- 8 to 21 days
- 1 month
- 3 months
- 6 months
- Continuous / ongoing
answers:
brandIndustry: Automotive
companyLegalName: Example company legal name
companyRegistrationNumber: 123-123456789
fullCompanyAddress: Skeppsbron 1 Malmö, 123 12, Sweden
messagesVolume: 10K - 100K messages
messagesFrequency: Once per month
fr:
questions:
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
siren:
question: What is your Company directory identification system number (SIREN)?
suggestedAnswers: []
answers:
fullCompanyAddress: Skeppsbron 1-split-211 20-split-Malmö
fullCompanyAddressMetadata:
ignore: -split-
siren: '123456789'
us:
questions:
ownershipType:
question: What is the ownership type of your company?
suggestedAnswers:
- PRIVATE
- PUBLIC
companyLegalName:
question: What is the registered legal name of your company?
suggestedAnswers: []
companyPhoneNumber:
question: What is the primary phone number of your company?
suggestedAnswers: []
companyEmailAddress:
question: What is the primary email address of your company?
suggestedAnswers: []
brandName:
question: What is your brand name or Doing Business As (DBA)?
suggestedAnswers: []
brandIndustry:
question: What sector or industry does your business operate in?
suggestedAnswers:
- AGRICULTURE
- COMMUNICATION
- CONSTRUCTION
- EDUCATION
- ENERGY
- ENTERTAINMENT
- FINANCIAL
- GAMBLING
- GOVERNMENT
- HEALTHCARE
- HOSPITALITY
- HUMAN_RESOURCES
- INSURANCE
- LEGAL
- MANUFACTURING
- NON_GOVERNMENTAL_ORGANIZATION
- POLITICAL
- POSTAL
- PROFESSIONAL
- REAL_ESTATE
- RETAIL
- TECHNOLOGY
- TRANSPORTATION
legalForm:
question: What is the legal form of your company?
suggestedAnswers:
- CORPORATION
- LIMITED_LIABILITY_COMPANY
- PARTNERSHIP
- S_CORPORATION
taxIdCountry:
question: In which country is your company's tax ID registered?
suggestedAnswers: []
taxId:
question: 'For non-US companies: what is the tax ID of your company?'
suggestedAnswers: []
addressLine:
question: What is the primary street address of your company?
suggestedAnswers: []
addressCity:
question: In which city is your company located?
suggestedAnswers: []
addressCountry:
question: In which country is your company located?
suggestedAnswers: []
addressState:
question: In which state is your company located?
suggestedAnswers: []
addressPostalCode:
question: What is the postal code for your company address?
suggestedAnswers: []
websiteUrl:
question: What is the primary website URL for your company?
suggestedAnswers: []
contactFirstName:
question: What is the first name of the responsible contact person for your company?
suggestedAnswers: []
contactSurname:
question: What is the surname of the responsible contact person for your company?
suggestedAnswers: []
stockExchange:
question: What is the primary home country stock exchange abbreviation?
suggestedAnswers: []
stockSymbol:
question: What is the primary home country stock symbol associated with the stock exchange?
suggestedAnswers: []
sampleMessages:
question: Please provide sample messages for each use case or message type sent by your brand.
suggestedAnswers: []
messagesVolume:
question: What is the expected message volume?
suggestedAnswers: []
embeddedLink:
question: Does your brand send messages that contain embedded links to external websites?
suggestedAnswers: []
embeddedPhone:
question: Does your brand send messages that contain embedded phone numbers for direct calling?
suggestedAnswers: []
ageGatedContent:
question: Does your brand send messages that contain age-gated content or require age verification?
suggestedAnswers: []
directLending:
question: Does your brand send messages that involve direct lending or financial services?
suggestedAnswers: []
optInConfirmationMessage:
question: Does your brand send opt-in confirmation messages to users who have subscribed to receive messages?
suggestedAnswers: []
helpMessage:
question: Does your brand send help messages that provide assistance or support information to users?
suggestedAnswers: []
callToActionMessage:
question: Does your brand send call-to-action messages that encourage users to take specific actions?
suggestedAnswers: []
answers:
ownershipType: PUBLIC
companyLegalName: Example company legal name
companyPhoneNumber: '+48777777777'
companyEmailAddress: email@example.com
brandName: Example brand name
brandIndustry: AGRICULTURE
legalForm: CORPORATION
taxIdCountry: US
taxId: 12-3456789
addressLine: 123 Main St
addressCity: Anytown
addressCountry: US
addressState: CA
addressPostalCode: '12345'
websiteUrl: https://example.com
contactFirstName: John
contactSurname: Doe
stockExchange: NASDAQ
stockSymbol: EXMPL
sampleMessages:
- Sample message 1 for the US questionnaire.
- Sample message 2 for the US questionnaire.
messagesVolume: 10000
embeddedLink: true
embeddedPhone: true
ageGatedContent: false
directLending: false
optInConfirmationMessage: Thank you for opting in!
helpMessage: For help, contact support.
callToActionMessage: Click here to claim your special offer and explore our latest updates now.
region: EU
billingCategory: CONVERSATIONAL
useCase: OTP
hostingRegion: EUROPE
authName: yurwN6123asd
authToken: ejiiqJtDyurwN6jLze8v
conversationApiApp: 4CF9CE97504C4A468F4610919D17ECC1
conversationApiAppDetails:
id: 4CF9CE97504C4A468F4610919D17ECC1
projectId: ea026751-3edf-40a9-ad93-1b382bd60a78
region: EU
channelStatus: ACTIVE
created: '2023-01-19t13:11:08.204Z'
modified: '2023-01-19t13:11:08.204Z'
launched: '2023-01-19t13:11:08.204Z'
supplierDetails:
google:
agentId: agentId
brandId: brandId
newPreparingLaunchBrand:
summary: Get response preparingLaunchBrand
description: "\n Response with a sender preparingLaunchBrand.\n "
value:
id: cf11794a-6a5e-4a12-b103-da79bd378bf1
state: PREPARING_LAUNCH
testNumberStates:
- number: '+46123123111'
state: UNVERIFIED
submitted: '2023-01-19t13:11:08.204Z'
- number: '+46123123222'
state: VERIFIED
submitted: '2023-01-19t13:11:08.204Z'
- number: '+46123123333'
state: DECLINED
submitted: '2023-01-19t13:11:08.204Z'
countryStatus:
- country: FR
status: PENDING
operators:
- name: Coriolis Telecom
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Lycamobile
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Bouygues
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Free
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: NRJ Mobile
status: REJECTED
remark: Sender was rejected due to operator policy.
modified: '2023-01-19t13:11:08.204Z'
- name: SFR
status: SUSPENDED
modified: '2023-01-19t13:11:08.204Z'
- name: Orange
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- country: GB
status: PENDING
operators:
- name: EE
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Three
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Sky
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: O2
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Vodafone
status: SUSPENDED
modified: '2023-01-19t13:11:08.204Z'
- country: SE
status: PENDING
operators:
- name: Tele2
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Telenor
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Telia
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Three
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
details:
brand:
emails:
- label: label
address: test@test.com
- label: label-1
address: test-1@test.com
- label: label-2
address: test-2@test.com
phones:
- label: label
number: '+48777777777'
- label: label-1
number: '48888888888'
- label: label-2
number: '+48999999999'
websites:
- label: label
url: https://example.com
- label: label-1
url: https://example-1.com
- label: label-2
url: https://example-2.com
color: '#000000'
description: Test description
bannerUrl: https://example-banner-url.com
logoUrl: https://example-logo-url.com
privacyPolicyUrl: https://example-private-policy-url.com
termsOfServiceUrl: https://example-terms-of-service-url.com
name: Test name
testNumbers:
- '+48777777777'
countries:
- FR
- GB
- SE
questionnaire:
general:
questions:
optInDescription:
question: How do users agree to receive messages from your business through the agent?
suggestedAnswers:
- By subscribing to our loyalty program
- By making a purchase in-store or online
- By subscribing to a newsletter
- By creating an account on our website or app
triggerDescription:
question: When does your business send messages to users through the agent?
suggestedAnswers:
- User actions (e.g. after making a purchase)
interactionsDescription:
question: How will users interact with your business through the agent?
suggestedAnswers:
- Online Payment
- Password reset
- OTP/2FA for account login
optOutDescription:
question: What message does your business send when a user opts out?
suggestedAnswers:
- Thank you for opting out
- Thank you for unsubscribing
- We have registered your opt out request
videoUris:
question: ''
suggestedAnswers: []
screenshotUris:
question: ''
suggestedAnswers: []
answers:
optInDescription: By subscribing to a newsletter
triggerDescription: User actions (e.g. after making a purchase)
interactionsDescription: Billing or payment reminders,aef Order updates,aef Upon package delivery
interactionsDescriptionMetadata:
ignore: ',aef'
optOutDescription: We have registered your opt out request
videoUris:
- https://example-video-url.com
screenshotUris:
- https://example-screenshot-url.com
verification:
questions:
name:
question: What is the name of your verification contact?
suggestedAnswers: []
email:
question: What is the email of your verification contact?
suggestedAnswers: []
title:
question: What is the title of your verification contact?
suggestedAnswers: []
website:
question: What is the website of your verification contact?
suggestedAnswers: []
phone:
question: What is the phone number of your verification contact?
suggestedAnswers: []
partner:
companyName:
question: 'For ASP resellers: what is the name of the brand partner company?'
suggestedAnswers: []
contactName:
question: 'For ASP resellers: what is the name of the brand partner contact person?'
suggestedAnswers: []
contactEmailAddress:
question: 'For ASP resellers: what is the email of the brand partner contact person?'
suggestedAnswers: []
answers:
name: Exam Ple
email: email@example.com
title: Head Example
website: https://example.com
phone: '+48777777777'
partner:
companyName: Partner company
contactName: Partner contact name
contactEmailAddress: partner.contact@partner-company.com
gb:
questions:
brandIndustry:
question: What sector or industry does your business operate in?
suggestedAnswers:
- Automotive
- Beauty, spa and salon
- Clothing
- Education
- Entertainment
- Event planning and service
- Finance and banking
- Food and groceries
- Public service
- Hotel and lodging
- Medical and health
- Charity
- Professional services
- Shopping and retail
- Travel and transportation
- Restaurant
companyLegalName:
question: What is the registered legal name of your company?
suggestedAnswers: []
companyRegistrationNumber:
question: What is the registration number of your company?
suggestedAnswers: []
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
messagesVolume:
question: What is the total volume of messages expected to be sent by your agent?
suggestedAnswers:
- 0 - 10K messages
- 10K - 100K messages
- 100K - 1M messages
- 1M+ messages
messagesFrequency:
question: How often do you expect to send messages?
suggestedAnswers:
- Once per day
- Once per week
- Once per month
- Once per 3 months
- Once per 6 months
campaignLength:
question: What will be the length of the RCS campaign?
suggestedAnswers:
- 1 day or less
- 2 to 7 days
- 8 to 21 days
- 1 month
- 3 months
- 6 months
- Continuous / ongoing
answers:
brandIndustry: Automotive
companyLegalName: Example company legal name
companyRegistrationNumber: 123-123456789
fullCompanyAddress: Skeppsbron 1 Malmö, 123 12, Sweden
messagesVolume: 10K - 100K messages
messagesFrequency: Once per month
fr:
questions:
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
siren:
question: What is your Company directory identification system number (SIREN)?
suggestedAnswers: []
answers:
fullCompanyAddress: Skeppsbron 1-split-211 20-split-Malmö
fullCompanyAddressMetadata:
ignore: -split-
siren: '123456789'
us:
questions:
ownershipType:
question: What is the ownership type of your company?
suggestedAnswers:
- PRIVATE
- PUBLIC
companyLegalName:
question: What is the registered legal name of your company?
suggestedAnswers: []
companyPhoneNumber:
question: What is the primary phone number of your company?
suggestedAnswers: []
companyEmailAddress:
question: What is the primary email address of your company?
suggestedAnswers: []
brandName:
question: What is your brand name or Doing Business As (DBA)?
suggestedAnswers: []
brandIndustry:
question: What sector or industry does your business operate in?
suggestedAnswers:
- AGRICULTURE
- COMMUNICATION
- CONSTRUCTION
- EDUCATION
- ENERGY
- ENTERTAINMENT
- FINANCIAL
- GAMBLING
- GOVERNMENT
- HEALTHCARE
- HOSPITALITY
- HUMAN_RESOURCES
- INSURANCE
- LEGAL
- MANUFACTURING
- NON_GOVERNMENTAL_ORGANIZATION
- POLITICAL
- POSTAL
- PROFESSIONAL
- REAL_ESTATE
- RETAIL
- TECHNOLOGY
- TRANSPORTATION
legalForm:
question: What is the legal form of your company?
suggestedAnswers:
- CORPORATION
- LIMITED_LIABILITY_COMPANY
- PARTNERSHIP
- S_CORPORATION
taxIdCountry:
question: In which country is your company's tax ID registered?
suggestedAnswers: []
taxId:
question: 'For non-US companies: what is the tax ID of your company?'
suggestedAnswers: []
addressLine:
question: What is the primary street address of your company?
suggestedAnswers: []
addressCity:
question: In which city is your company located?
suggestedAnswers: []
addressCountry:
question: In which country is your company located?
suggestedAnswers: []
addressState:
question: In which state is your company located?
suggestedAnswers: []
addressPostalCode:
question: What is the postal code for your company address?
suggestedAnswers: []
websiteUrl:
question: What is the primary website URL for your company?
suggestedAnswers: []
contactFirstName:
question: What is the first name of the responsible contact person for your company?
suggestedAnswers: []
contactSurname:
question: What is the surname of the responsible contact person for your company?
suggestedAnswers: []
stockExchange:
question: What is the primary home country stock exchange abbreviation?
suggestedAnswers: []
stockSymbol:
question: What is the primary home country stock symbol associated with the stock exchange?
suggestedAnswers: []
sampleMessages:
question: Please provide sample messages for each use case or message type sent by your brand.
suggestedAnswers: []
messagesVolume:
question: What is the expected message volume?
suggestedAnswers: []
embeddedLink:
question: Does your brand send messages that contain embedded links to external websites?
suggestedAnswers: []
embeddedPhone:
question: Does your brand send messages that contain embedded phone numbers for direct calling?
suggestedAnswers: []
ageGatedContent:
question: Does your brand send messages that contain age-gated content or require age verification?
suggestedAnswers: []
directLending:
question: Does your brand send messages that involve direct lending or financial services?
suggestedAnswers: []
optInConfirmationMessage:
question: Does your brand send opt-in confirmation messages to users who have subscribed to receive messages?
suggestedAnswers: []
helpMessage:
question: Does your brand send help messages that provide assistance or support information to users?
suggestedAnswers: []
callToActionMessage:
question: Does your brand send call-to-action messages that encourage users to take specific actions?
suggestedAnswers: []
answers:
ownershipType: PUBLIC
companyLegalName: Example company legal name
companyPhoneNumber: '+48777777777'
companyEmailAddress: email@example.com
brandName: Example brand name
brandIndustry: AGRICULTURE
legalForm: CORPORATION
taxIdCountry: US
taxId: 12-3456789
addressLine: 123 Main St
addressCity: Anytown
addressCountry: US
addressState: CA
addressPostalCode: '12345'
websiteUrl: https://example.com
contactFirstName: John
contactSurname: Doe
stockExchange: NASDAQ
stockSymbol: EXMPL
sampleMessages:
- Sample message 1 for the US questionnaire.
- Sample message 2 for the US questionnaire.
messagesVolume: 10000
embeddedLink: true
embeddedPhone: true
ageGatedContent: false
directLending: false
optInConfirmationMessage: Thank you for opting in!
helpMessage: For help, contact support.
callToActionMessage: Click here to claim your special offer and explore our latest updates now.
region: EU
billingCategory: CONVERSATIONAL
useCase: OTP
hostingRegion: EUROPE
authName: yurwN6123asd
authToken: ejiiqJtDyurwN6jLze8v
conversationApiApp: 4CF9CE97504C4A468F4610919D17ECC1
conversationApiAppDetails:
id: 4CF9CE97504C4A468F4610919D17ECC1
projectId: ea026751-3edf-40a9-ad93-1b382bd60a78
region: EU
channelStatus: ACTIVE
created: '2023-01-19t13:11:08.204Z'
modified: '2023-01-19t13:11:08.204Z'
launched: '2023-01-19t13:11:08.204Z'
supplierDetails:
google:
agentId: agentId
brandId: brandId
brandDetails:
id: eceed77f-22f6-42bc-b2ce-3fe65916028e
status: DRAFT
registration:
id: 2ea4f0aa-f85d-4785-9ad9-0b08bbc148c2
status: NEW
inTest:
summary: '[Deprecated] Get response inTest'
description: "\n Response with a sender inTest.\n "
value:
id: cf11794a-6a5e-4a12-b103-da79bd378bf1
state: IN_TEST
testNumberStates:
- number: '+46123123111'
state: UNVERIFIED
submitted: '2023-01-19t13:11:08.204Z'
- number: '+46123123222'
state: VERIFIED
submitted: '2023-01-19t13:11:08.204Z'
- number: '+46123123333'
state: DECLINED
submitted: '2023-01-19t13:11:08.204Z'
countryStatus:
- country: FR
status: NOT_LAUNCHED
operators:
- name: Coriolis Telecom
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Lycamobile
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Bouygues
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Free
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: NRJ Mobile
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: SFR
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Orange
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- country: GB
status: NOT_LAUNCHED
operators:
- name: EE
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Three
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Sky
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: O2
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Vodafone
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- country: SE
status: NOT_LAUNCHED
operators:
- name: Tele2
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Telenor
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Telia
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Three
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
details:
brand:
emails:
- label: label
address: test@test.com
- label: label-1
address: test-1@test.com
- label: label-2
address: test-2@test.com
phones:
- label: label
number: '+48777777777'
- label: label-1
number: '48888888888'
- label: label-2
number: '+48999999999'
websites:
- label: label
url: https://example.com
- label: label-1
url: https://example-1.com
- label: label-2
url: https://example-2.com
color: '#000000'
description: Test description
bannerUrl: https://example-banner-url.com
logoUrl: https://example-logo-url.com
privacyPolicyUrl: https://example-private-policy-url.com
termsOfServiceUrl: https://example-terms-of-service-url.com
name: Test name
testNumbers:
- '+48777777777'
countries:
- FR
- GB
- SE
questionnaire:
general:
questions:
optInDescription:
question: How do users agree to receive messages from your business through the agent?
suggestedAnswers:
- By subscribing to our loyalty program
- By making a purchase in-store or online
- By subscribing to a newsletter
- By creating an account on our website or app
triggerDescription:
question: When does your business send messages to users through the agent?
suggestedAnswers:
- User actions (e.g. after making a purchase)
interactionsDescription:
question: How will users interact with your business through the agent?
suggestedAnswers:
- Online Payment
- Password reset
- OTP/2FA for account login
optOutDescription:
question: What message does your business send when a user opts out?
suggestedAnswers:
- Thank you for opting out
- Thank you for unsubscribing
- We have registered your opt out request
videoUris:
question: ''
suggestedAnswers: []
screenshotUris:
question: ''
suggestedAnswers: []
answers:
optInDescription: By subscribing to a newsletter
triggerDescription: User actions (e.g. after making a purchase)
interactionsDescription: Billing or payment reminders,aef Order updates,aef Upon package delivery
interactionsDescriptionMetadata:
ignore: ',aef'
optOutDescription: We have registered your opt out request
videoUris:
- https://example-video-url.com
screenshotUris:
- https://example-screenshot-url.com
verification:
questions:
name:
question: What is the name of your verification contact?
suggestedAnswers: []
email:
question: What is the email of your verification contact?
suggestedAnswers: []
title:
question: What is the title of your verification contact?
suggestedAnswers: []
website:
question: What is the website of your verification contact?
suggestedAnswers: []
phone:
question: What is the phone number of your verification contact?
suggestedAnswers: []
partner:
companyName:
question: 'For ASP resellers: what is the name of the brand partner company?'
suggestedAnswers: []
contactName:
question: 'For ASP resellers: what is the name of the brand partner contact person?'
suggestedAnswers: []
contactEmailAddress:
question: 'For ASP resellers: what is the email of the brand partner contact person?'
suggestedAnswers: []
answers:
name: Exam Ple
email: email@example.com
title: Head Example
website: https://example.com
phone: '+48777777777'
partner:
companyName: Partner company
contactName: Partner contact name
contactEmailAddress: partner.contact@partner-company.com
gb:
questions:
brandIndustry:
question: What sector or industry does your business operate in?
suggestedAnswers:
- Automotive
- Beauty, spa and salon
- Clothing
- Education
- Entertainment
- Event planning and service
- Finance and banking
- Food and groceries
- Public service
- Hotel and lodging
- Medical and health
- Charity
- Professional services
- Shopping and retail
- Travel and transportation
- Restaurant
companyLegalName:
question: What is the registered legal name of your company?
suggestedAnswers: []
companyRegistrationNumber:
question: What is the registration number of your company?
suggestedAnswers: []
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
messagesVolume:
question: What is the total volume of messages expected to be sent by your agent?
suggestedAnswers:
- 0 - 10K messages
- 10K - 100K messages
- 100K - 1M messages
- 1M+ messages
messagesFrequency:
question: How often do you expect to send messages?
suggestedAnswers:
- Once per day
- Once per week
- Once per month
- Once per 3 months
- Once per 6 months
campaignLength:
question: What will be the length of the RCS campaign?
suggestedAnswers:
- 1 day or less
- 2 to 7 days
- 8 to 21 days
- 1 month
- 3 months
- 6 months
- Continuous / ongoing
answers:
brandIndustry: Automotive
companyLegalName: Example company legal name
companyRegistrationNumber: 123-123456789
fullCompanyAddress: Skeppsbron 1 Malmö, 123 12, Sweden
messagesVolume: 10K - 100K messages
messagesFrequency: Once per month
fr:
questions:
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
siren:
question: What is your Company directory identification system number (SIREN)?
suggestedAnswers: []
answers:
fullCompanyAddress: Skeppsbron 1-split-211 20-split-Malmö
fullCompanyAddressMetadata:
ignore: -split-
siren: '123456789'
us:
questions:
companyLegalName:
question: What is the registered legal name of your company?
suggestedAnswers: []
ein:
question: What is the Employer Identification Number (EIN) of your company?
suggestedAnswers: []
brandIndustry:
question: What sector or industry does your business operate in?
suggestedAnswers:
- Automotive
- Beauty, spa and salon
- Clothing
- Education
- Entertainment
- Event planning and service
- Finance and banking
- Food and groceries
- Public service
- Hotel and lodging
- Medical and health
- Charity
- Professional services
- Shopping and retail
- Travel and transportation
- Restaurant
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
smsCampaign:
question: US SMS campaign used as fallback.
suggestedAnswers: []
messagesVolume:
question: What is the total volume of messages expected to be sent by your agent?
suggestedAnswers:
- 0 - 10K messages
- 10K - 100K messages
- 100K - 1M messages
- 1M+ messages
answers:
companyLegalName: Example company legal name
ein: 12-3456789
brandIndustry: Automotive
fullCompanyAddress: Skeppsbron 1-split-211 20-split-Malmö
fullCompanyAddressMetadata:
ignore: -split-
smsCampaign: We have registered your opt out request
messagesVolume: 10K - 100K messages
region: EU
billingCategory: CONVERSATIONAL
useCase: OTP
hostingRegion: EUROPE
authName: yurwN6123asd
authToken: ejiiqJtDyurwN6jLze8v
conversationApiApp: 4CF9CE97504C4A468F4610919D17ECC1
conversationApiAppDetails:
id: 4CF9CE97504C4A468F4610919D17ECC1
projectId: ea026751-3edf-40a9-ad93-1b382bd60a78
region: EU
channelStatus: ACTIVE
created: '2023-01-19t13:11:08.204Z'
modified: '2023-01-19t13:11:08.204Z'
launched: '2023-01-19t13:11:08.204Z'
supplierDetails:
google:
agentId: agentId
brandId: brandId
preparingLaunch:
summary: '[Deprecated] Get response preparingLaunch'
description: "\n Response with a sender preparingLaunch.\n "
value:
id: cf11794a-6a5e-4a12-b103-da79bd378bf1
state: PREPARING_LAUNCH
testNumberStates:
- number: '+46123123111'
state: UNVERIFIED
submitted: '2023-01-19t13:11:08.204Z'
- number: '+46123123222'
state: VERIFIED
submitted: '2023-01-19t13:11:08.204Z'
- number: '+46123123333'
state: DECLINED
submitted: '2023-01-19t13:11:08.204Z'
countryStatus:
- country: FR
status: PENDING
operators:
- name: Coriolis Telecom
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Lycamobile
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Bouygues
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Free
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: NRJ Mobile
status: REJECTED
remark: Sender was rejected due to operator policy.
modified: '2023-01-19t13:11:08.204Z'
- name: SFR
status: SUSPENDED
modified: '2023-01-19t13:11:08.204Z'
- name: Orange
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- country: GB
status: PENDING
operators:
- name: EE
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Three
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Sky
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: O2
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Vodafone
status: SUSPENDED
modified: '2023-01-19t13:11:08.204Z'
- country: SE
status: PENDING
operators:
- name: Tele2
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Telenor
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Telia
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Three
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
details:
brand:
emails:
- label: label
address: test@test.com
- label: label-1
address: test-1@test.com
- label: label-2
address: test-2@test.com
phones:
- label: label
number: '+48777777777'
- label: label-1
number: '48888888888'
- label: label-2
number: '+48999999999'
websites:
- label: label
url: https://example.com
- label: label-1
url: https://example-1.com
- label: label-2
url: https://example-2.com
color: '#000000'
description: Test description
bannerUrl: https://example-banner-url.com
logoUrl: https://example-logo-url.com
privacyPolicyUrl: https://example-private-policy-url.com
termsOfServiceUrl: https://example-terms-of-service-url.com
name: Test name
testNumbers:
- '+48777777777'
countries:
- FR
- GB
- SE
questionnaire:
general:
questions:
optInDescription:
question: How do users agree to receive messages from your business through the agent?
suggestedAnswers:
- By subscribing to our loyalty program
- By making a purchase in-store or online
- By subscribing to a newsletter
- By creating an account on our website or app
triggerDescription:
question: When does your business send messages to users through the agent?
suggestedAnswers:
- User actions (e.g. after making a purchase)
interactionsDescription:
question: How will users interact with your business through the agent?
suggestedAnswers:
- Online Payment
- Password reset
- OTP/2FA for account login
optOutDescription:
question: What message does your business send when a user opts out?
suggestedAnswers:
- Thank you for opting out
- Thank you for unsubscribing
- We have registered your opt out request
videoUris:
question: ''
suggestedAnswers: []
screenshotUris:
question: ''
suggestedAnswers: []
answers:
optInDescription: By subscribing to a newsletter
triggerDescription: User actions (e.g. after making a purchase)
interactionsDescription: Billing or payment reminders,aef Order updates,aef Upon package delivery
interactionsDescriptionMetadata:
ignore: ',aef'
optOutDescription: We have registered your opt out request
videoUris:
- https://example-video-url.com
screenshotUris:
- https://example-screenshot-url.com
verification:
questions:
name:
question: What is the name of your verification contact?
suggestedAnswers: []
email:
question: What is the email of your verification contact?
suggestedAnswers: []
title:
question: What is the title of your verification contact?
suggestedAnswers: []
website:
question: What is the website of your verification contact?
suggestedAnswers: []
phone:
question: What is the phone number of your verification contact?
suggestedAnswers: []
partner:
companyName:
question: 'For ASP resellers: what is the name of the brand partner company?'
suggestedAnswers: []
contactName:
question: 'For ASP resellers: what is the name of the brand partner contact person?'
suggestedAnswers: []
contactEmailAddress:
question: 'For ASP resellers: what is the email of the brand partner contact person?'
suggestedAnswers: []
answers:
name: Exam Ple
email: email@example.com
title: Head Example
website: https://example.com
phone: '+48777777777'
partner:
companyName: Partner company
contactName: Partner contact name
contactEmailAddress: partner.contact@partner-company.com
gb:
questions:
brandIndustry:
question: What sector or industry does your business operate in?
suggestedAnswers:
- Automotive
- Beauty, spa and salon
- Clothing
- Education
- Entertainment
- Event planning and service
- Finance and banking
- Food and groceries
- Public service
- Hotel and lodging
- Medical and health
- Charity
- Professional services
- Shopping and retail
- Travel and transportation
- Restaurant
companyLegalName:
question: What is the registered legal name of your company?
suggestedAnswers: []
companyRegistrationNumber:
question: What is the registration number of your company?
suggestedAnswers: []
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
messagesVolume:
question: What is the total volume of messages expected to be sent by your agent?
suggestedAnswers:
- 0 - 10K messages
- 10K - 100K messages
- 100K - 1M messages
- 1M+ messages
messagesFrequency:
question: How often do you expect to send messages?
suggestedAnswers:
- Once per day
- Once per week
- Once per month
- Once per 3 months
- Once per 6 months
campaignLength:
question: What will be the length of the RCS campaign?
suggestedAnswers:
- 1 day or less
- 2 to 7 days
- 8 to 21 days
- 1 month
- 3 months
- 6 months
- Continuous / ongoing
answers:
brandIndustry: Automotive
companyLegalName: Example company legal name
companyRegistrationNumber: 123-123456789
fullCompanyAddress: Skeppsbron 1 Malmö, 123 12, Sweden
messagesVolume: 10K - 100K messages
messagesFrequency: Once per month
fr:
questions:
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
siren:
question: What is your Company directory identification system number (SIREN)?
suggestedAnswers: []
answers:
fullCompanyAddress: Skeppsbron 1-split-211 20-split-Malmö
fullCompanyAddressMetadata:
ignore: -split-
siren: '123456789'
us:
questions:
companyLegalName:
question: What is the registered legal name of your company?
suggestedAnswers: []
ein:
question: What is the Employer Identification Number (EIN) of your company?
suggestedAnswers: []
brandIndustry:
question: What sector or industry does your business operate in?
suggestedAnswers:
- Automotive
- Beauty, spa and salon
- Clothing
- Education
- Entertainment
- Event planning and service
- Finance and banking
- Food and groceries
- Public service
- Hotel and lodging
- Medical and health
- Charity
- Professional services
- Shopping and retail
- Travel and transportation
- Restaurant
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
smsCampaign:
question: US SMS campaign used as fallback.
suggestedAnswers: []
messagesVolume:
question: What is the total volume of messages expected to be sent by your agent?
suggestedAnswers:
- 0 - 10K messages
- 10K - 100K messages
- 100K - 1M messages
- 1M+ messages
answers:
companyLegalName: Example company legal name
ein: 12-3456789
brandIndustry: Automotive
fullCompanyAddress: Skeppsbron 1-split-211 20-split-Malmö
fullCompanyAddressMetadata:
ignore: -split-
smsCampaign: We have registered your opt out request
messagesVolume: 10K - 100K messages
region: EU
billingCategory: CONVERSATIONAL
useCase: OTP
hostingRegion: EUROPE
authName: yurwN6123asd
authToken: ejiiqJtDyurwN6jLze8v
conversationApiApp: 4CF9CE97504C4A468F4610919D17ECC1
conversationApiAppDetails:
id: 4CF9CE97504C4A468F4610919D17ECC1
projectId: ea026751-3edf-40a9-ad93-1b382bd60a78
region: EU
channelStatus: ACTIVE
created: '2023-01-19t13:11:08.204Z'
modified: '2023-01-19t13:11:08.204Z'
launched: '2023-01-19t13:11:08.204Z'
supplierDetails:
google:
agentId: agentId
brandId: brandId
launching:
summary: '[Deprecated] Get response launching'
description: "\n Response with a sender launching.\n "
value:
id: cf11794a-6a5e-4a12-b103-da79bd378bf1
state: LAUNCHING
testNumberStates:
- number: '+46123123111'
state: UNVERIFIED
submitted: '2023-01-19t13:11:08.204Z'
- number: '+46123123222'
state: VERIFIED
submitted: '2023-01-19t13:11:08.204Z'
- number: '+46123123333'
state: DECLINED
submitted: '2023-01-19t13:11:08.204Z'
countryStatus:
- country: FR
status: PENDING
operators:
- name: Coriolis Telecom
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Lycamobile
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Bouygues
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Free
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: NRJ Mobile
status: REJECTED
remark: Sender was rejected due to operator policy.
modified: '2023-01-19t13:11:08.204Z'
- name: SFR
status: SUSPENDED
modified: '2023-01-19t13:11:08.204Z'
- name: Orange
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- country: GB
status: PENDING
operators:
- name: EE
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Three
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Sky
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: O2
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Vodafone
status: SUSPENDED
modified: '2023-01-19t13:11:08.204Z'
- country: SE
status: PENDING
operators:
- name: Tele2
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Telenor
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Telia
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Three
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
details:
brand:
emails:
- label: label
address: test@test.com
- label: label-1
address: test-1@test.com
- label: label-2
address: test-2@test.com
phones:
- label: label
number: '+48777777777'
- label: label-1
number: '48888888888'
- label: label-2
number: '+48999999999'
websites:
- label: label
url: https://example.com
- label: label-1
url: https://example-1.com
- label: label-2
url: https://example-2.com
color: '#000000'
description: Test description
bannerUrl: https://example-banner-url.com
logoUrl: https://example-logo-url.com
privacyPolicyUrl: https://example-private-policy-url.com
termsOfServiceUrl: https://example-terms-of-service-url.com
name: Test name
testNumbers:
- '+48777777777'
countries:
- FR
- GB
- SE
questionnaire:
general:
questions:
optInDescription:
question: How do users agree to receive messages from your business through the agent?
suggestedAnswers:
- By subscribing to our loyalty program
- By making a purchase in-store or online
- By subscribing to a newsletter
- By creating an account on our website or app
triggerDescription:
question: When does your business send messages to users through the agent?
suggestedAnswers:
- User actions (e.g. after making a purchase)
interactionsDescription:
question: How will users interact with your business through the agent?
suggestedAnswers:
- Online Payment
- Password reset
- OTP/2FA for account login
optOutDescription:
question: What message does your business send when a user opts out?
suggestedAnswers:
- Thank you for opting out
- Thank you for unsubscribing
- We have registered your opt out request
videoUris:
question: ''
suggestedAnswers: []
screenshotUris:
question: ''
suggestedAnswers: []
answers:
optInDescription: By subscribing to a newsletter
triggerDescription: User actions (e.g. after making a purchase)
interactionsDescription: Billing or payment reminders,aef Order updates,aef Upon package delivery
interactionsDescriptionMetadata:
ignore: ',aef'
optOutDescription: We have registered your opt out request
videoUris:
- https://example-video-url.com
screenshotUris:
- https://example-screenshot-url.com
verification:
questions:
name:
question: What is the name of your verification contact?
suggestedAnswers: []
email:
question: What is the email of your verification contact?
suggestedAnswers: []
title:
question: What is the title of your verification contact?
suggestedAnswers: []
website:
question: What is the website of your verification contact?
suggestedAnswers: []
phone:
question: What is the phone number of your verification contact?
suggestedAnswers: []
partner:
companyName:
question: 'For ASP resellers: what is the name of the brand partner company?'
suggestedAnswers: []
contactName:
question: 'For ASP resellers: what is the name of the brand partner contact person?'
suggestedAnswers: []
contactEmailAddress:
question: 'For ASP resellers: what is the email of the brand partner contact person?'
suggestedAnswers: []
answers:
name: Exam Ple
email: email@example.com
title: Head Example
website: https://example.com
phone: '+48777777777'
partner:
companyName: Partner company
contactName: Partner contact name
contactEmailAddress: partner.contact@partner-company.com
gb:
questions:
brandIndustry:
question: What sector or industry does your business operate in?
suggestedAnswers:
- Automotive
- Beauty, spa and salon
- Clothing
- Education
- Entertainment
- Event planning and service
- Finance and banking
- Food and groceries
- Public service
- Hotel and lodging
- Medical and health
- Charity
- Professional services
- Shopping and retail
- Travel and transportation
- Restaurant
companyLegalName:
question: What is the registered legal name of your company?
suggestedAnswers: []
companyRegistrationNumber:
question: What is the registration number of your company?
suggestedAnswers: []
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
messagesVolume:
question: What is the total volume of messages expected to be sent by your agent?
suggestedAnswers:
- 0 - 10K messages
- 10K - 100K messages
- 100K - 1M messages
- 1M+ messages
messagesFrequency:
question: How often do you expect to send messages?
suggestedAnswers:
- Once per day
- Once per week
- Once per month
- Once per 3 months
- Once per 6 months
campaignLength:
question: What will be the length of the RCS campaign?
suggestedAnswers:
- 1 day or less
- 2 to 7 days
- 8 to 21 days
- 1 month
- 3 months
- 6 months
- Continuous / ongoing
answers:
brandIndustry: Automotive
companyLegalName: Example company legal name
companyRegistrationNumber: 123-123456789
fullCompanyAddress: Skeppsbron 1 Malmö, 123 12, Sweden
messagesVolume: 10K - 100K messages
messagesFrequency: Once per month
fr:
questions:
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
siren:
question: What is your Company directory identification system number (SIREN)?
suggestedAnswers: []
answers:
fullCompanyAddress: Skeppsbron 1-split-211 20-split-Malmö
fullCompanyAddressMetadata:
ignore: -split-
siren: '123456789'
us:
questions:
companyLegalName:
question: What is the registered legal name of your company?
suggestedAnswers: []
ein:
question: What is the Employer Identification Number (EIN) of your company?
suggestedAnswers: []
brandIndustry:
question: What sector or industry does your business operate in?
suggestedAnswers:
- Automotive
- Beauty, spa and salon
- Clothing
- Education
- Entertainment
- Event planning and service
- Finance and banking
- Food and groceries
- Public service
- Hotel and lodging
- Medical and health
- Charity
- Professional services
- Shopping and retail
- Travel and transportation
- Restaurant
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
smsCampaign:
question: US SMS campaign used as fallback.
suggestedAnswers: []
messagesVolume:
question: What is the total volume of messages expected to be sent by your agent?
suggestedAnswers:
- 0 - 10K messages
- 10K - 100K messages
- 100K - 1M messages
- 1M+ messages
answers:
companyLegalName: Example company legal name
ein: 12-3456789
brandIndustry: Automotive
fullCompanyAddress: Skeppsbron 1-split-211 20-split-Malmö
fullCompanyAddressMetadata:
ignore: -split-
smsCampaign: We have registered your opt out request
messagesVolume: 10K - 100K messages
region: EU
billingCategory: CONVERSATIONAL
useCase: OTP
hostingRegion: EUROPE
authName: yurwN6123asd
authToken: ejiiqJtDyurwN6jLze8v
conversationApiApp: 4CF9CE97504C4A468F4610919D17ECC1
conversationApiAppDetails:
id: 4CF9CE97504C4A468F4610919D17ECC1
projectId: ea026751-3edf-40a9-ad93-1b382bd60a78
region: EU
channelStatus: ACTIVE
created: '2023-01-19t13:11:08.204Z'
modified: '2023-01-19t13:11:08.204Z'
launched: '2023-01-19t13:11:08.204Z'
supplierDetails:
google:
agentId: agentId
brandId: brandId
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
invalid_id_format-0:
summary: InvalidIdFormatError
value:
errorCode: invalid_id_format
message: Id is not in the expected format.
resolution: senderId param is in the wrong format. Confirm that you're sending the correct value.
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
unauthorized_error-0:
summary: UnauthorizedErrorError
value:
errorCode: unauthorized_error
message: Unauthorized error.
resolution: Verify that projectId is correct.
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
rbm_has_not_been_used-0:
summary: RbmHasNotBeenUsedError
value:
errorCode: rbm_has_not_been_used
message: RBM has not been used.
resolution: Please wait and try again or reach out to support at si-richmessaging@sinch.com
'404':
description: NotFound
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
sender_not_found-0:
summary: SenderNotFoundError
value:
errorCode: sender_not_found
message: Sender not found.
resolution: Verify that the parameters are correct.
'429':
description: TooManyRequests
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
rbm_too_many_requests-0:
summary: RbmTooManyRequestsError
value:
errorCode: rbm_too_many_requests
message: RCS Business Messaging too many requests.
resolution: Please wait and try again.
'500':
description: InternalServerError
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
internal_error-0:
summary: InternalErrorError
value:
errorCode: internal_error
message: Internal server error.
resolution: Please wait and try again, if the error persist please contact support.
summary: Get sender for project
tags:
- RCS Senders
x-badges:
- name: GA
position: after
color: green
security:
- BasicAuth: []
BearerAuth: []
OAuth2Production: []
patch:
description: Returns updated sender for a project.
operationId: RcsSendersController_updateSender_v1
parameters:
- name: projectId
required: true
in: path
description: The unique ID of the project. You can find this on the Sinch Dashboard.
schema:
type: string
- name: senderId
required: true
in: path
schema:
type: string
- name: usQuestionnaireVersion
required: false
in: query
description: Optional query parameter to specify the US questionnaire version for the update.
x-enumDescriptions:
v1: Specifies the initial legacy version of the US compliance questionnaire framework.
v2: Specifies the current updated version of the US compliance questionnaire framework.
schema:
$ref: '#/components/schemas/RcsUsQuestionnaireVersionsEnum'
requestBody:
required: true
description: Sender data update
content:
application/json:
schema:
$ref: '#/components/schemas/RcsUpdateSenderInputDto'
examples:
newInput:
summary: Body request for sender
description: "\n Example body request to update a sender.\n "
value:
details:
brand:
emails:
- label: label
address: test@test.com
- label: label-1
address: test-1@test.com
- label: label-2
address: test-2@test.com
phones:
- label: label
number: '+48777777777'
- label: label-1
number: '48888888888'
- label: label-2
number: '+48999999999'
websites:
- label: label
url: https://example.com
- label: label-1
url: https://example-1.com
- label: label-2
url: https://example-2.com
color: '#000000'
description: Test description
bannerUrl: https://example-banner-url.com
logoUrl: https://example-logo-url.com
privacyPolicyUrl: https://example-private-policy-url.com
termsOfServiceUrl: https://example-terms-of-service-url.com
name: Test name
testNumbers:
- '+48777777777'
countries:
- GB
- FR
questionnaire:
general:
answers:
optInDescription: By subscribing to a newsletter
triggerDescription: User actions (e.g. after making a purchase)
interactionsDescription: Billing or payment reminders,aef Order updates,aef Upon package delivery
interactionsDescriptionMetadata:
ignore: ',aef'
optOutDescription: We have registered your opt out request
videoUris:
- https://example-video-url.com
screenshotUris:
- https://example-screenshot-url.com
verification:
answers:
name: Exam Ple
email: email@example.com
title: Head Example
website: https://example.com
phone: '+48777777777'
partner:
companyName: Partner company
contactName: Partner contact name
contactEmailAddress: partner.contact@partner-company.com
gb:
answers:
brandIndustry: Automotive
companyLegalName: Example company legal name
companyRegistrationNumber: 123-123456789
fullCompanyAddress: Skeppsbron 1 Malmö, 123 12, Sweden
messagesVolume: 10K - 100K messages
messagesFrequency: Once per month
fr:
answers:
fullCompanyAddress: Skeppsbron 1-split-211 20-split-Malmö
fullCompanyAddressMetadata:
ignore: -split-
siren: '123456789'
us:
answers:
ownershipType: PUBLIC
companyLegalName: Example company legal name
companyPhoneNumber: '+48777777777'
companyEmailAddress: email@example.com
brandName: Example brand name
brandIndustry: AGRICULTURE
legalForm: CORPORATION
taxIdCountry: US
taxId: 12-3456789
addressLine: 123 Main St
addressCity: Anytown
addressCountry: US
addressState: CA
addressPostalCode: '12345'
websiteUrl: https://example.com
contactFirstName: John
contactSurname: Doe
stockExchange: NASDAQ
stockSymbol: EXMPL
sampleMessages:
- Sample message 1 for the US questionnaire.
- Sample message 2 for the US questionnaire.
messagesVolume: 10000
embeddedLink: true
embeddedPhone: true
ageGatedContent: false
directLending: false
optInConfirmationMessage: Thank you for opting in!
helpMessage: For help, contact support.
callToActionMessage: Click here to claim your special offer and explore our latest updates now.
input:
summary: '[Deprecated] Body request for sender'
description: "\n Example body request to update a sender.\n "
value:
details:
brand:
emails:
- label: label
address: test@test.com
- label: label-1
address: test-1@test.com
- label: label-2
address: test-2@test.com
phones:
- label: label
number: '+48777777777'
- label: label-1
number: '48888888888'
- label: label-2
number: '+48999999999'
websites:
- label: label
url: https://example.com
- label: label-1
url: https://example-1.com
- label: label-2
url: https://example-2.com
color: '#000000'
description: Test description
bannerUrl: https://example-banner-url.com
logoUrl: https://example-logo-url.com
privacyPolicyUrl: https://example-private-policy-url.com
termsOfServiceUrl: https://example-terms-of-service-url.com
name: Test name
testNumbers:
- '+48777777777'
countries:
- GB
- FR
questionnaire:
general:
answers:
optInDescription: By subscribing to a newsletter
triggerDescription: User actions (e.g. after making a purchase)
interactionsDescription: Billing or payment reminders,aef Order updates,aef Upon package delivery
interactionsDescriptionMetadata:
ignore: ',aef'
optOutDescription: We have registered your opt out request
videoUris:
- https://example-video-url.com
screenshotUris:
- https://example-screenshot-url.com
verification:
answers:
name: Exam Ple
email: email@example.com
title: Head Example
website: https://example.com
phone: '+48777777777'
partner:
companyName: Partner company
contactName: Partner contact name
contactEmailAddress: partner.contact@partner-company.com
gb:
answers:
brandIndustry: Automotive
companyLegalName: Example company legal name
companyRegistrationNumber: 123-123456789
fullCompanyAddress: Skeppsbron 1 Malmö, 123 12, Sweden
messagesVolume: 10K - 100K messages
messagesFrequency: Once per month
fr:
answers:
fullCompanyAddress: Skeppsbron 1-split-211 20-split-Malmö
fullCompanyAddressMetadata:
ignore: -split-
siren: '123456789'
us:
answers:
companyLegalName: Example company legal name
ein: 12-3456789
brandIndustry: Automotive
fullCompanyAddress: Skeppsbron 1-split-211 20-split-Malmö
fullCompanyAddressMetadata:
ignore: -split-
smsCampaign: We have registered your opt out request
messagesVolume: 10K - 100K messages
responses:
'200':
description: Sender
content:
application/json:
schema:
$ref: '#/components/schemas/RcsSenderDto'
examples:
newResponse:
summary: Update response
description: "\n Response when successfully updated a sender.\n "
value:
id: cf11794a-6a5e-4a12-b103-da79bd378bf1
state: IN_TEST
testNumberStates:
- number: '+46123123111'
state: UNVERIFIED
submitted: '2023-01-19t13:11:08.204Z'
- number: '+46123123222'
state: VERIFIED
submitted: '2023-01-19t13:11:08.204Z'
- number: '+46123123333'
state: DECLINED
submitted: '2023-01-19t13:11:08.204Z'
countryStatus:
- country: FR
status: NOT_LAUNCHED
operators:
- name: Coriolis Telecom
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Lycamobile
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Bouygues
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Free
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: NRJ Mobile
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: SFR
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Orange
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- country: GB
status: NOT_LAUNCHED
operators:
- name: EE
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Three
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Sky
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: O2
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Vodafone
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- country: SE
status: NOT_LAUNCHED
operators:
- name: Tele2
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Telenor
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Telia
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Three
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
details:
brand:
emails:
- label: label
address: test@test.com
- label: label-1
address: test-1@test.com
- label: label-2
address: test-2@test.com
phones:
- label: label
number: '+48777777777'
- label: label-1
number: '48888888888'
- label: label-2
number: '+48999999999'
websites:
- label: label
url: https://example.com
- label: label-1
url: https://example-1.com
- label: label-2
url: https://example-2.com
color: '#000000'
description: Test description
bannerUrl: https://example-banner-url.com
logoUrl: https://example-logo-url.com
privacyPolicyUrl: https://example-private-policy-url.com
termsOfServiceUrl: https://example-terms-of-service-url.com
name: Test name
testNumbers:
- '+48777777777'
countries:
- FR
- GB
- SE
questionnaire:
general:
questions:
optInDescription:
question: How do users agree to receive messages from your business through the agent?
suggestedAnswers:
- By subscribing to our loyalty program
- By making a purchase in-store or online
- By subscribing to a newsletter
- By creating an account on our website or app
triggerDescription:
question: When does your business send messages to users through the agent?
suggestedAnswers:
- User actions (e.g. after making a purchase)
interactionsDescription:
question: How will users interact with your business through the agent?
suggestedAnswers:
- Online Payment
- Password reset
- OTP/2FA for account login
optOutDescription:
question: What message does your business send when a user opts out?
suggestedAnswers:
- Thank you for opting out
- Thank you for unsubscribing
- We have registered your opt out request
videoUris:
question: ''
suggestedAnswers: []
screenshotUris:
question: ''
suggestedAnswers: []
answers:
optInDescription: By subscribing to a newsletter
triggerDescription: User actions (e.g. after making a purchase)
interactionsDescription: Billing or payment reminders,aef Order updates,aef Upon package delivery
interactionsDescriptionMetadata:
ignore: ',aef'
optOutDescription: We have registered your opt out request
videoUris:
- https://example-video-url.com
screenshotUris:
- https://example-screenshot-url.com
verification:
questions:
name:
question: What is the name of your verification contact?
suggestedAnswers: []
email:
question: What is the email of your verification contact?
suggestedAnswers: []
title:
question: What is the title of your verification contact?
suggestedAnswers: []
website:
question: What is the website of your verification contact?
suggestedAnswers: []
phone:
question: What is the phone number of your verification contact?
suggestedAnswers: []
partner:
companyName:
question: 'For ASP resellers: what is the name of the brand partner company?'
suggestedAnswers: []
contactName:
question: 'For ASP resellers: what is the name of the brand partner contact person?'
suggestedAnswers: []
contactEmailAddress:
question: 'For ASP resellers: what is the email of the brand partner contact person?'
suggestedAnswers: []
answers:
name: Exam Ple
email: email@example.com
title: Head Example
website: https://example.com
phone: '+48777777777'
partner:
companyName: Partner company
contactName: Partner contact name
contactEmailAddress: partner.contact@partner-company.com
gb:
questions:
brandIndustry:
question: What sector or industry does your business operate in?
suggestedAnswers:
- Automotive
- Beauty, spa and salon
- Clothing
- Education
- Entertainment
- Event planning and service
- Finance and banking
- Food and groceries
- Public service
- Hotel and lodging
- Medical and health
- Charity
- Professional services
- Shopping and retail
- Travel and transportation
- Restaurant
companyLegalName:
question: What is the registered legal name of your company?
suggestedAnswers: []
companyRegistrationNumber:
question: What is the registration number of your company?
suggestedAnswers: []
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
messagesVolume:
question: What is the total volume of messages expected to be sent by your agent?
suggestedAnswers:
- 0 - 10K messages
- 10K - 100K messages
- 100K - 1M messages
- 1M+ messages
messagesFrequency:
question: How often do you expect to send messages?
suggestedAnswers:
- Once per day
- Once per week
- Once per month
- Once per 3 months
- Once per 6 months
campaignLength:
question: What will be the length of the RCS campaign?
suggestedAnswers:
- 1 day or less
- 2 to 7 days
- 8 to 21 days
- 1 month
- 3 months
- 6 months
- Continuous / ongoing
answers:
brandIndustry: Automotive
companyLegalName: Example company legal name
companyRegistrationNumber: 123-123456789
fullCompanyAddress: Skeppsbron 1 Malmö, 123 12, Sweden
messagesVolume: 10K - 100K messages
messagesFrequency: Once per month
fr:
questions:
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
siren:
question: What is your Company directory identification system number (SIREN)?
suggestedAnswers: []
answers:
fullCompanyAddress: Skeppsbron 1-split-211 20-split-Malmö
fullCompanyAddressMetadata:
ignore: -split-
siren: '123456789'
us:
questions:
ownershipType:
question: What is the ownership type of your company?
suggestedAnswers:
- PRIVATE
- PUBLIC
companyLegalName:
question: What is the registered legal name of your company?
suggestedAnswers: []
companyPhoneNumber:
question: What is the primary phone number of your company?
suggestedAnswers: []
companyEmailAddress:
question: What is the primary email address of your company?
suggestedAnswers: []
brandName:
question: What is your brand name or Doing Business As (DBA)?
suggestedAnswers: []
brandIndustry:
question: What sector or industry does your business operate in?
suggestedAnswers:
- AGRICULTURE
- COMMUNICATION
- CONSTRUCTION
- EDUCATION
- ENERGY
- ENTERTAINMENT
- FINANCIAL
- GAMBLING
- GOVERNMENT
- HEALTHCARE
- HOSPITALITY
- HUMAN_RESOURCES
- INSURANCE
- LEGAL
- MANUFACTURING
- NON_GOVERNMENTAL_ORGANIZATION
- POLITICAL
- POSTAL
- PROFESSIONAL
- REAL_ESTATE
- RETAIL
- TECHNOLOGY
- TRANSPORTATION
legalForm:
question: What is the legal form of your company?
suggestedAnswers:
- CORPORATION
- LIMITED_LIABILITY_COMPANY
- PARTNERSHIP
- S_CORPORATION
taxIdCountry:
question: In which country is your company's tax ID registered?
suggestedAnswers: []
taxId:
question: 'For non-US companies: what is the tax ID of your company?'
suggestedAnswers: []
addressLine:
question: What is the primary street address of your company?
suggestedAnswers: []
addressCity:
question: In which city is your company located?
suggestedAnswers: []
addressCountry:
question: In which country is your company located?
suggestedAnswers: []
addressState:
question: In which state is your company located?
suggestedAnswers: []
addressPostalCode:
question: What is the postal code for your company address?
suggestedAnswers: []
websiteUrl:
question: What is the primary website URL for your company?
suggestedAnswers: []
contactFirstName:
question: What is the first name of the responsible contact person for your company?
suggestedAnswers: []
contactSurname:
question: What is the surname of the responsible contact person for your company?
suggestedAnswers: []
stockExchange:
question: What is the primary home country stock exchange abbreviation?
suggestedAnswers: []
stockSymbol:
question: What is the primary home country stock symbol associated with the stock exchange?
suggestedAnswers: []
sampleMessages:
question: Please provide sample messages for each use case or message type sent by your brand.
suggestedAnswers: []
messagesVolume:
question: What is the expected message volume?
suggestedAnswers: []
embeddedLink:
question: Does your brand send messages that contain embedded links to external websites?
suggestedAnswers: []
embeddedPhone:
question: Does your brand send messages that contain embedded phone numbers for direct calling?
suggestedAnswers: []
ageGatedContent:
question: Does your brand send messages that contain age-gated content or require age verification?
suggestedAnswers: []
directLending:
question: Does your brand send messages that involve direct lending or financial services?
suggestedAnswers: []
optInConfirmationMessage:
question: Does your brand send opt-in confirmation messages to users who have subscribed to receive messages?
suggestedAnswers: []
helpMessage:
question: Does your brand send help messages that provide assistance or support information to users?
suggestedAnswers: []
callToActionMessage:
question: Does your brand send call-to-action messages that encourage users to take specific actions?
suggestedAnswers: []
answers:
ownershipType: PUBLIC
companyLegalName: Example company legal name
companyPhoneNumber: '+48777777777'
companyEmailAddress: email@example.com
brandName: Example brand name
brandIndustry: AGRICULTURE
legalForm: CORPORATION
taxIdCountry: US
taxId: 12-3456789
addressLine: 123 Main St
addressCity: Anytown
addressCountry: US
addressState: CA
addressPostalCode: '12345'
websiteUrl: https://example.com
contactFirstName: John
contactSurname: Doe
stockExchange: NASDAQ
stockSymbol: EXMPL
sampleMessages:
- Sample message 1 for the US questionnaire.
- Sample message 2 for the US questionnaire.
messagesVolume: 10000
embeddedLink: true
embeddedPhone: true
ageGatedContent: false
directLending: false
optInConfirmationMessage: Thank you for opting in!
helpMessage: For help, contact support.
callToActionMessage: Click here to claim your special offer and explore our latest updates now.
region: EU
billingCategory: CONVERSATIONAL
useCase: OTP
hostingRegion: EUROPE
authName: yurwN6123asd
authToken: ejiiqJtDyurwN6jLze8v
conversationApiApp: 4CF9CE97504C4A468F4610919D17ECC1
conversationApiAppDetails:
id: 4CF9CE97504C4A468F4610919D17ECC1
projectId: ea026751-3edf-40a9-ad93-1b382bd60a78
region: EU
channelStatus: ACTIVE
created: '2023-01-19t13:11:08.204Z'
modified: '2023-01-19t13:11:08.204Z'
launched: '2023-01-19t13:11:08.204Z'
supplierDetails:
google:
agentId: agentId
brandId: brandId
response:
summary: '[Deprecated] Update response'
description: "\n Response when successfully updated a sender.\n "
value:
id: cf11794a-6a5e-4a12-b103-da79bd378bf1
state: IN_TEST
testNumberStates:
- number: '+46123123111'
state: UNVERIFIED
submitted: '2023-01-19t13:11:08.204Z'
- number: '+46123123222'
state: VERIFIED
submitted: '2023-01-19t13:11:08.204Z'
- number: '+46123123333'
state: DECLINED
submitted: '2023-01-19t13:11:08.204Z'
countryStatus:
- country: FR
status: NOT_LAUNCHED
operators:
- name: Coriolis Telecom
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Lycamobile
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Bouygues
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Free
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: NRJ Mobile
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: SFR
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Orange
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- country: GB
status: NOT_LAUNCHED
operators:
- name: EE
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Three
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Sky
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: O2
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Vodafone
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- country: SE
status: NOT_LAUNCHED
operators:
- name: Tele2
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Telenor
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Telia
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
- name: Three
status: NOT_LAUNCHED
modified: '2023-01-19t13:11:08.204Z'
details:
brand:
emails:
- label: label
address: test@test.com
- label: label-1
address: test-1@test.com
- label: label-2
address: test-2@test.com
phones:
- label: label
number: '+48777777777'
- label: label-1
number: '48888888888'
- label: label-2
number: '+48999999999'
websites:
- label: label
url: https://example.com
- label: label-1
url: https://example-1.com
- label: label-2
url: https://example-2.com
color: '#000000'
description: Test description
bannerUrl: https://example-banner-url.com
logoUrl: https://example-logo-url.com
privacyPolicyUrl: https://example-private-policy-url.com
termsOfServiceUrl: https://example-terms-of-service-url.com
name: Test name
testNumbers:
- '+48777777777'
countries:
- FR
- GB
- SE
questionnaire:
general:
questions:
optInDescription:
question: How do users agree to receive messages from your business through the agent?
suggestedAnswers:
- By subscribing to our loyalty program
- By making a purchase in-store or online
- By subscribing to a newsletter
- By creating an account on our website or app
triggerDescription:
question: When does your business send messages to users through the agent?
suggestedAnswers:
- User actions (e.g. after making a purchase)
interactionsDescription:
question: How will users interact with your business through the agent?
suggestedAnswers:
- Online Payment
- Password reset
- OTP/2FA for account login
optOutDescription:
question: What message does your business send when a user opts out?
suggestedAnswers:
- Thank you for opting out
- Thank you for unsubscribing
- We have registered your opt out request
videoUris:
question: ''
suggestedAnswers: []
screenshotUris:
question: ''
suggestedAnswers: []
answers:
optInDescription: By subscribing to a newsletter
triggerDescription: User actions (e.g. after making a purchase)
interactionsDescription: Billing or payment reminders,aef Order updates,aef Upon package delivery
interactionsDescriptionMetadata:
ignore: ',aef'
optOutDescription: We have registered your opt out request
videoUris:
- https://example-video-url.com
screenshotUris:
- https://example-screenshot-url.com
verification:
questions:
name:
question: What is the name of your verification contact?
suggestedAnswers: []
email:
question: What is the email of your verification contact?
suggestedAnswers: []
title:
question: What is the title of your verification contact?
suggestedAnswers: []
website:
question: What is the website of your verification contact?
suggestedAnswers: []
phone:
question: What is the phone number of your verification contact?
suggestedAnswers: []
partner:
companyName:
question: 'For ASP resellers: what is the name of the brand partner company?'
suggestedAnswers: []
contactName:
question: 'For ASP resellers: what is the name of the brand partner contact person?'
suggestedAnswers: []
contactEmailAddress:
question: 'For ASP resellers: what is the email of the brand partner contact person?'
suggestedAnswers: []
answers:
name: Exam Ple
email: email@example.com
title: Head Example
website: https://example.com
phone: '+48777777777'
partner:
companyName: Partner company
contactName: Partner contact name
contactEmailAddress: partner.contact@partner-company.com
gb:
questions:
brandIndustry:
question: What sector or industry does your business operate in?
suggestedAnswers:
- Automotive
- Beauty, spa and salon
- Clothing
- Education
- Entertainment
- Event planning and service
- Finance and banking
- Food and groceries
- Public service
- Hotel and lodging
- Medical and health
- Charity
- Professional services
- Shopping and retail
- Travel and transportation
- Restaurant
companyLegalName:
question: What is the registered legal name of your company?
suggestedAnswers: []
companyRegistrationNumber:
question: What is the registration number of your company?
suggestedAnswers: []
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
messagesVolume:
question: What is the total volume of messages expected to be sent by your agent?
suggestedAnswers:
- 0 - 10K messages
- 10K - 100K messages
- 100K - 1M messages
- 1M+ messages
messagesFrequency:
question: How often do you expect to send messages?
suggestedAnswers:
- Once per day
- Once per week
- Once per month
- Once per 3 months
- Once per 6 months
campaignLength:
question: What will be the length of the RCS campaign?
suggestedAnswers:
- 1 day or less
- 2 to 7 days
- 8 to 21 days
- 1 month
- 3 months
- 6 months
- Continuous / ongoing
answers:
brandIndustry: Automotive
companyLegalName: Example company legal name
companyRegistrationNumber: 123-123456789
fullCompanyAddress: Skeppsbron 1 Malmö, 123 12, Sweden
messagesVolume: 10K - 100K messages
messagesFrequency: Once per month
fr:
questions:
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
siren:
question: What is your Company directory identification system number (SIREN)?
suggestedAnswers: []
answers:
fullCompanyAddress: Skeppsbron 1-split-211 20-split-Malmö
fullCompanyAddressMetadata:
ignore: -split-
siren: '123456789'
us:
questions:
companyLegalName:
question: What is the registered legal name of your company?
suggestedAnswers: []
ein:
question: What is the Employer Identification Number (EIN) of your company?
suggestedAnswers: []
brandIndustry:
question: What sector or industry does your business operate in?
suggestedAnswers:
- Automotive
- Beauty, spa and salon
- Clothing
- Education
- Entertainment
- Event planning and service
- Finance and banking
- Food and groceries
- Public service
- Hotel and lodging
- Medical and health
- Charity
- Professional services
- Shopping and retail
- Travel and transportation
- Restaurant
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
smsCampaign:
question: US SMS campaign used as fallback.
suggestedAnswers: []
messagesVolume:
question: What is the total volume of messages expected to be sent by your agent?
suggestedAnswers:
- 0 - 10K messages
- 10K - 100K messages
- 100K - 1M messages
- 1M+ messages
answers:
companyLegalName: Example company legal name
ein: 12-3456789
brandIndustry: Automotive
fullCompanyAddress: Skeppsbron 1-split-211 20-split-Malmö
fullCompanyAddressMetadata:
ignore: -split-
smsCampaign: We have registered your opt out request
messagesVolume: 10K - 100K messages
region: EU
billingCategory: CONVERSATIONAL
useCase: OTP
hostingRegion: EUROPE
authName: yurwN6123asd
authToken: ejiiqJtDyurwN6jLze8v
conversationApiApp: 4CF9CE97504C4A468F4610919D17ECC1
conversationApiAppDetails:
id: 4CF9CE97504C4A468F4610919D17ECC1
projectId: ea026751-3edf-40a9-ad93-1b382bd60a78
region: EU
channelStatus: ACTIVE
created: '2023-01-19t13:11:08.204Z'
modified: '2023-01-19t13:11:08.204Z'
launched: '2023-01-19t13:11:08.204Z'
supplierDetails:
google:
agentId: agentId
brandId: brandId
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
invalid_input-0:
summary: InvalidInputError
value:
errorCode: invalid_input
message: Invalid input.
resolution: Correct the validation errors and submit again.
additionalInformation:
validationErrors:
- details.brand.email.address must be an email
invalid_id_format-1:
summary: InvalidIdFormatError
value:
errorCode: invalid_id_format
message: Id is not in the expected format.
resolution: senderId param is in the wrong format. Confirm that you're sending the correct value.
no_fields_to_update-2:
summary: NoFieldsToUpdateError
value:
errorCode: no_fields_to_update
message: No fields to be updated.
resolution: Supply at least one field to be updated.
fields_not_updatable-3:
summary: FieldsNotUpdatableError
value:
errorCode: fields_not_updatable
message: Fields not updatable.
resolution: 'Only `details.countries` and `details.launch` can be updated when in state: LAUNCHING, LAUNCHED.'
invalid_payload-4:
summary: InvalidPayloadError
value:
errorCode: invalid_payload
message: Invalid payload.
resolution: Correct payload and submit again.
invalid_google_agent-5:
summary: InvalidGoogleAgentError
value:
errorCode: invalid_google_agent
message: message
resolution: Verify the sender's fields.
add_test_number_invalid-6:
summary: AddTestNumberInvalidError
value:
errorCode: add_test_number_invalid
message: Invalid phone number.
resolution: Please verify that phone number is correct.
invalid_region_for_att_supplier-7:
summary: InvalidRegionForAttSupplierError
value:
errorCode: invalid_region_for_att_supplier
message: Invalid region for ATT supplier.
resolution: ATT supplier is only allowed in the US region.
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
unauthorized_error-0:
summary: UnauthorizedErrorError
value:
errorCode: unauthorized_error
message: Unauthorized error.
resolution: Verify that projectId is correct.
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
rbm_has_not_been_used-0:
summary: RbmHasNotBeenUsedError
value:
errorCode: rbm_has_not_been_used
message: RBM has not been used.
resolution: Please wait and try again or reach out to support at si-richmessaging@sinch.com
'404':
description: NotFound
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
project_not_found-0:
summary: ProjectNotFoundError
value:
errorCode: project_not_found
message: Project not found.
resolution: Verify that the projectId is correct.
sender_not_found-1:
summary: SenderNotFoundError
value:
errorCode: sender_not_found
message: Sender not found.
resolution: Verify that the parameters are correct.
rbm_resources_not_found-2:
summary: RbmResourcesNotFoundError
value:
errorCode: rbm_resources_not_found
message: RBM resources not found.
resolution: Verify that the parameters are correct, and contact support if error persists.
blocked_because_the_recipient_declined-3:
summary: BlockedBecauseTheRecipientDeclinedError
value:
errorCode: blocked_because_the_recipient_declined
message: Blocked because the recipient declined.
resolution: This operation is blocked because the recipient declined the invitation to become a tester.
'429':
description: TooManyRequests
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
rbm_too_many_requests-0:
summary: RbmTooManyRequestsError
value:
errorCode: rbm_too_many_requests
message: RCS Business Messaging too many requests.
resolution: Please wait and try again.
'500':
description: InternalServerError
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
internal_error-0:
summary: InternalErrorError
value:
errorCode: internal_error
message: Internal server error.
resolution: Please wait and try again, if the error persist please contact support.
summary: Update sender for project
tags:
- RCS Senders
x-badges:
- name: GA
position: after
color: green
security:
- BasicAuth: []
BearerAuth: []
OAuth2Production: []
servers:
- url: https://provisioning.api.sinch.com
description: Production server
/v1/projects/{projectId}/rcs/senders/{senderId}/activities:
get:
description: Paginated list of activities for sender. Ordered from the most recent one to the oldest one.
operationId: RcsSendersController_listActivities_v1
parameters:
- name: projectId
required: true
in: path
description: The unique ID of the project. You can find this on the Sinch Dashboard.
schema:
type: string
- name: senderId
required: true
in: path
description: The unique ID of the sender.
schema:
type: string
- name: pageToken
required: false
in: query
schema:
type: string
description: The page token if retrieving the next page from a previous query.
- name: pageSize
required: false
in: query
schema:
type: number
minimum: 1
maximum: 100
description: The page size requested.
responses:
'200':
description: Recent activities on sender
content:
application/json:
schema:
$ref: '#/components/schemas/RcsSenderNotificationListDto'
examples:
response:
summary: List sender activities response
description: "\n Response for all sender activities.\n "
value:
totalSize: 2
pageSize: 50
notifications:
- type: CREATED
created: '2023-02-10T11:41:14.202Z'
author: Provisioning API user
- type: COMMENT_ADDED
created: '2023-02-10T11:41:14.202Z'
comment: Example comment
author: Provisioning API user
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
invalid_page_token-0:
summary: InvalidPageTokenError
value:
errorCode: invalid_page_token
message: Invalid page token.
resolution: The page token to use is provided in the previous query response, for new queries simply leave this field undefined.
invalid_page_size-1:
summary: InvalidPageSizeError
value:
errorCode: invalid_page_size
message: Page size must be numeric.
resolution: Use a integer value for pageSize parameter.
invalid_id_format-2:
summary: InvalidIdFormatError
value:
errorCode: invalid_id_format
message: Id is not in the expected format.
resolution: senderId param is in the wrong format. Confirm that you're sending the correct value.
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
unauthorized_error-0:
summary: UnauthorizedErrorError
value:
errorCode: unauthorized_error
message: Unauthorized error.
resolution: Verify that projectId is correct.
'404':
description: NotFound
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
sender_not_found-0:
summary: SenderNotFoundError
value:
errorCode: sender_not_found
message: Sender not found.
resolution: Verify that the parameters are correct.
'500':
description: InternalServerError
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
internal_error-0:
summary: InternalErrorError
value:
errorCode: internal_error
message: Internal server error.
resolution: Please wait and try again, if the error persist please contact support.
summary: Lists activities on sender
tags:
- RCS Senders
x-badges:
- name: GA
position: after
color: green
security:
- BasicAuth: []
BearerAuth: []
OAuth2Production: []
servers:
- url: https://provisioning.api.sinch.com
description: Production server
/v1/projects/{projectId}/rcs/senders/{senderId}/comments:
post:
description: Creates a comment for a sender in project.
operationId: RcsSendersController_createSenderComment_v1
parameters:
- name: projectId
required: true
in: path
description: The unique ID of the project. You can find this on the Sinch Dashboard.
schema:
type: string
- name: senderId
required: true
in: path
description: The unique ID of the sender.
schema:
type: string
requestBody:
required: true
description: Comment data.
content:
application/json:
schema:
$ref: '#/components/schemas/RcsCommentInputDto'
examples:
input:
summary: Body request
description: "\n Example body request to create a comment.\n "
value:
comment: Example comment.
responses:
'201':
description: Created comment for a sender in project
content:
application/json:
schema:
$ref: '#/components/schemas/RcsCommentDto'
examples:
created:
summary: Create response
description: "\n Response when successfully creating a comment.\n "
value:
type: CREATED
comment: Example comment
created: '2023-01-19T13:11:08.204Z'
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
invalid_input-0:
summary: InvalidInputError
value:
errorCode: invalid_input
message: Invalid input.
resolution: Correct the validation errors and submit again.
additionalInformation:
validationErrors:
- comment must be longer than or equal to 1 characters
invalid_payload-1:
summary: InvalidPayloadError
value:
errorCode: invalid_payload
message: Invalid payload.
resolution: Correct payload and submit again.
invalid_id_format-2:
summary: InvalidIdFormatError
value:
errorCode: invalid_id_format
message: Id is not in the expected format.
resolution: senderId param is in the wrong format. Confirm that you're sending the correct value.
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
unauthorized_error-0:
summary: UnauthorizedErrorError
value:
errorCode: unauthorized_error
message: Unauthorized error.
resolution: Verify that projectId is correct.
'404':
description: NotFound
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
sender_not_found-0:
summary: SenderNotFoundError
value:
errorCode: sender_not_found
message: Sender not found.
resolution: Verify that the parameters are correct.
'500':
description: InternalServerError
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
internal_error-0:
summary: InternalErrorError
value:
errorCode: internal_error
message: Internal server error.
resolution: Please wait and try again, if the error persist please contact support.
summary: Creates a comment for a sender in project
tags:
- RCS Senders
x-badges:
- name: GA
position: after
color: green
security:
- BasicAuth: []
BearerAuth: []
OAuth2Production: []
servers:
- url: https://provisioning.api.sinch.com
description: Production server
/v1/projects/{projectId}/rcs/senders/{senderId}/launch:
post:
description: 'Begins launch process for a sender in project.
Requirements to begin launch process:
- All required questionnaire answers must be provided;
- For senders using the US V2 questionnaire, the verification phone number is required;
- Country-specific questionnaire answers are required when applicable to the sender''s countries;
- Countries (`details.countries`) must have at least one (1) value;
- At least one contact phone number (`details.brand.phones`) or a contact email (`details.brand.emails`) is required, but both are recommended;
- A brand banner url (`details.brand.bannerUrl`) must be defined;
- A brand logo url (`details.brand.logoUrl`) must be defined;
- A privacy policy url (`details.brand.privacyPolicyUrl`) must be defined;
- A terms of service url (`details.brand.termsOfServiceUrl`) must be defined;
If no video URI was provided in questionnaire, Sender will go into PENDING_LAUNCH while a video is added by Service Implementation.'
operationId: RcsSendersController_launchSender_v1
parameters:
- name: projectId
required: true
in: path
description: The unique ID of the project. You can find this on the Sinch Dashboard.
schema:
type: string
- name: senderId
required: true
in: path
description: The unique ID of the sender.
schema:
type: string
responses:
'200':
description: Launched sender in project
content:
application/json:
schema:
$ref: '#/components/schemas/RcsSenderDto'
examples:
newLaunchingResponse:
summary: Launching response
description: "\n Response when successfully launching a sender with all required attributes.\n "
value:
id: cf11794a-6a5e-4a12-b103-da79bd378bf1
state: LAUNCHING
testNumberStates:
- number: '+46123123111'
state: UNVERIFIED
submitted: '2023-01-19t13:11:08.204Z'
- number: '+46123123222'
state: VERIFIED
submitted: '2023-01-19t13:11:08.204Z'
- number: '+46123123333'
state: DECLINED
submitted: '2023-01-19t13:11:08.204Z'
countryStatus:
- country: FR
status: PENDING
operators:
- name: Coriolis Telecom
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Lycamobile
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Bouygues
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Free
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: NRJ Mobile
status: REJECTED
remark: Sender was rejected due to operator policy.
modified: '2023-01-19t13:11:08.204Z'
- name: SFR
status: SUSPENDED
modified: '2023-01-19t13:11:08.204Z'
- name: Orange
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- country: GB
status: PENDING
operators:
- name: EE
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Three
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Sky
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: O2
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Vodafone
status: SUSPENDED
modified: '2023-01-19t13:11:08.204Z'
- country: SE
status: PENDING
operators:
- name: Tele2
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Telenor
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Telia
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Three
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
details:
brand:
emails:
- label: label
address: test@test.com
- label: label-1
address: test-1@test.com
- label: label-2
address: test-2@test.com
phones:
- label: label
number: '+48777777777'
- label: label-1
number: '48888888888'
- label: label-2
number: '+48999999999'
websites:
- label: label
url: https://example.com
- label: label-1
url: https://example-1.com
- label: label-2
url: https://example-2.com
color: '#000000'
description: Test description
bannerUrl: https://example-banner-url.com
logoUrl: https://example-logo-url.com
privacyPolicyUrl: https://example-private-policy-url.com
termsOfServiceUrl: https://example-terms-of-service-url.com
name: Test name
testNumbers:
- '+48777777777'
countries:
- FR
- GB
- SE
questionnaire:
general:
questions:
optInDescription:
question: How do users agree to receive messages from your business through the agent?
suggestedAnswers:
- By subscribing to our loyalty program
- By making a purchase in-store or online
- By subscribing to a newsletter
- By creating an account on our website or app
triggerDescription:
question: When does your business send messages to users through the agent?
suggestedAnswers:
- User actions (e.g. after making a purchase)
interactionsDescription:
question: How will users interact with your business through the agent?
suggestedAnswers:
- Online Payment
- Password reset
- OTP/2FA for account login
optOutDescription:
question: What message does your business send when a user opts out?
suggestedAnswers:
- Thank you for opting out
- Thank you for unsubscribing
- We have registered your opt out request
videoUris:
question: ''
suggestedAnswers: []
screenshotUris:
question: ''
suggestedAnswers: []
answers:
optInDescription: By subscribing to a newsletter
triggerDescription: User actions (e.g. after making a purchase)
interactionsDescription: Billing or payment reminders,aef Order updates,aef Upon package delivery
interactionsDescriptionMetadata:
ignore: ',aef'
optOutDescription: We have registered your opt out request
videoUris:
- https://example-video-url.com
screenshotUris:
- https://example-screenshot-url.com
verification:
questions:
name:
question: What is the name of your verification contact?
suggestedAnswers: []
email:
question: What is the email of your verification contact?
suggestedAnswers: []
title:
question: What is the title of your verification contact?
suggestedAnswers: []
website:
question: What is the website of your verification contact?
suggestedAnswers: []
phone:
question: What is the phone number of your verification contact?
suggestedAnswers: []
partner:
companyName:
question: 'For ASP resellers: what is the name of the brand partner company?'
suggestedAnswers: []
contactName:
question: 'For ASP resellers: what is the name of the brand partner contact person?'
suggestedAnswers: []
contactEmailAddress:
question: 'For ASP resellers: what is the email of the brand partner contact person?'
suggestedAnswers: []
answers:
name: Exam Ple
email: email@example.com
title: Head Example
website: https://example.com
phone: '+48777777777'
partner:
companyName: Partner company
contactName: Partner contact name
contactEmailAddress: partner.contact@partner-company.com
gb:
questions:
brandIndustry:
question: What sector or industry does your business operate in?
suggestedAnswers:
- Automotive
- Beauty, spa and salon
- Clothing
- Education
- Entertainment
- Event planning and service
- Finance and banking
- Food and groceries
- Public service
- Hotel and lodging
- Medical and health
- Charity
- Professional services
- Shopping and retail
- Travel and transportation
- Restaurant
companyLegalName:
question: What is the registered legal name of your company?
suggestedAnswers: []
companyRegistrationNumber:
question: What is the registration number of your company?
suggestedAnswers: []
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
messagesVolume:
question: What is the total volume of messages expected to be sent by your agent?
suggestedAnswers:
- 0 - 10K messages
- 10K - 100K messages
- 100K - 1M messages
- 1M+ messages
messagesFrequency:
question: How often do you expect to send messages?
suggestedAnswers:
- Once per day
- Once per week
- Once per month
- Once per 3 months
- Once per 6 months
campaignLength:
question: What will be the length of the RCS campaign?
suggestedAnswers:
- 1 day or less
- 2 to 7 days
- 8 to 21 days
- 1 month
- 3 months
- 6 months
- Continuous / ongoing
answers:
brandIndustry: Automotive
companyLegalName: Example company legal name
companyRegistrationNumber: 123-123456789
fullCompanyAddress: Skeppsbron 1 Malmö, 123 12, Sweden
messagesVolume: 10K - 100K messages
messagesFrequency: Once per month
fr:
questions:
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
siren:
question: What is your Company directory identification system number (SIREN)?
suggestedAnswers: []
answers:
fullCompanyAddress: Skeppsbron 1-split-211 20-split-Malmö
fullCompanyAddressMetadata:
ignore: -split-
siren: '123456789'
us:
questions:
ownershipType:
question: What is the ownership type of your company?
suggestedAnswers:
- PRIVATE
- PUBLIC
companyLegalName:
question: What is the registered legal name of your company?
suggestedAnswers: []
companyPhoneNumber:
question: What is the primary phone number of your company?
suggestedAnswers: []
companyEmailAddress:
question: What is the primary email address of your company?
suggestedAnswers: []
brandName:
question: What is your brand name or Doing Business As (DBA)?
suggestedAnswers: []
brandIndustry:
question: What sector or industry does your business operate in?
suggestedAnswers:
- AGRICULTURE
- COMMUNICATION
- CONSTRUCTION
- EDUCATION
- ENERGY
- ENTERTAINMENT
- FINANCIAL
- GAMBLING
- GOVERNMENT
- HEALTHCARE
- HOSPITALITY
- HUMAN_RESOURCES
- INSURANCE
- LEGAL
- MANUFACTURING
- NON_GOVERNMENTAL_ORGANIZATION
- POLITICAL
- POSTAL
- PROFESSIONAL
- REAL_ESTATE
- RETAIL
- TECHNOLOGY
- TRANSPORTATION
legalForm:
question: What is the legal form of your company?
suggestedAnswers:
- CORPORATION
- LIMITED_LIABILITY_COMPANY
- PARTNERSHIP
- S_CORPORATION
taxIdCountry:
question: In which country is your company's tax ID registered?
suggestedAnswers: []
taxId:
question: 'For non-US companies: what is the tax ID of your company?'
suggestedAnswers: []
addressLine:
question: What is the primary street address of your company?
suggestedAnswers: []
addressCity:
question: In which city is your company located?
suggestedAnswers: []
addressCountry:
question: In which country is your company located?
suggestedAnswers: []
addressState:
question: In which state is your company located?
suggestedAnswers: []
addressPostalCode:
question: What is the postal code for your company address?
suggestedAnswers: []
websiteUrl:
question: What is the primary website URL for your company?
suggestedAnswers: []
contactFirstName:
question: What is the first name of the responsible contact person for your company?
suggestedAnswers: []
contactSurname:
question: What is the surname of the responsible contact person for your company?
suggestedAnswers: []
stockExchange:
question: What is the primary home country stock exchange abbreviation?
suggestedAnswers: []
stockSymbol:
question: What is the primary home country stock symbol associated with the stock exchange?
suggestedAnswers: []
sampleMessages:
question: Please provide sample messages for each use case or message type sent by your brand.
suggestedAnswers: []
messagesVolume:
question: What is the expected message volume?
suggestedAnswers: []
embeddedLink:
question: Does your brand send messages that contain embedded links to external websites?
suggestedAnswers: []
embeddedPhone:
question: Does your brand send messages that contain embedded phone numbers for direct calling?
suggestedAnswers: []
ageGatedContent:
question: Does your brand send messages that contain age-gated content or require age verification?
suggestedAnswers: []
directLending:
question: Does your brand send messages that involve direct lending or financial services?
suggestedAnswers: []
optInConfirmationMessage:
question: Does your brand send opt-in confirmation messages to users who have subscribed to receive messages?
suggestedAnswers: []
helpMessage:
question: Does your brand send help messages that provide assistance or support information to users?
suggestedAnswers: []
callToActionMessage:
question: Does your brand send call-to-action messages that encourage users to take specific actions?
suggestedAnswers: []
answers:
ownershipType: PUBLIC
companyLegalName: Example company legal name
companyPhoneNumber: '+48777777777'
companyEmailAddress: email@example.com
brandName: Example brand name
brandIndustry: AGRICULTURE
legalForm: CORPORATION
taxIdCountry: US
taxId: 12-3456789
addressLine: 123 Main St
addressCity: Anytown
addressCountry: US
addressState: CA
addressPostalCode: '12345'
websiteUrl: https://example.com
contactFirstName: John
contactSurname: Doe
stockExchange: NASDAQ
stockSymbol: EXMPL
sampleMessages:
- Sample message 1 for the US questionnaire.
- Sample message 2 for the US questionnaire.
messagesVolume: 10000
embeddedLink: true
embeddedPhone: true
ageGatedContent: false
directLending: false
optInConfirmationMessage: Thank you for opting in!
helpMessage: For help, contact support.
callToActionMessage: Click here to claim your special offer and explore our latest updates now.
region: EU
billingCategory: CONVERSATIONAL
useCase: OTP
hostingRegion: EUROPE
authName: yurwN6123asd
authToken: ejiiqJtDyurwN6jLze8v
conversationApiApp: 4CF9CE97504C4A468F4610919D17ECC1
conversationApiAppDetails:
id: 4CF9CE97504C4A468F4610919D17ECC1
projectId: ea026751-3edf-40a9-ad93-1b382bd60a78
region: EU
channelStatus: ACTIVE
created: '2023-01-19t13:11:08.204Z'
modified: '2023-01-19t13:11:08.204Z'
launched: '2023-01-19t13:11:08.204Z'
supplierDetails:
google:
agentId: agentId
brandId: brandId
newPreparingLaunchResponse:
summary: Preparing launch response
description: "\n Response when successfully launching a sender.\n "
value:
id: cf11794a-6a5e-4a12-b103-da79bd378bf1
state: PREPARING_LAUNCH
testNumberStates:
- number: '+46123123111'
state: UNVERIFIED
submitted: '2023-01-19t13:11:08.204Z'
- number: '+46123123222'
state: VERIFIED
submitted: '2023-01-19t13:11:08.204Z'
- number: '+46123123333'
state: DECLINED
submitted: '2023-01-19t13:11:08.204Z'
countryStatus:
- country: FR
status: PENDING
operators:
- name: Coriolis Telecom
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Lycamobile
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Bouygues
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Free
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: NRJ Mobile
status: REJECTED
remark: Sender was rejected due to operator policy.
modified: '2023-01-19t13:11:08.204Z'
- name: SFR
status: SUSPENDED
modified: '2023-01-19t13:11:08.204Z'
- name: Orange
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- country: GB
status: PENDING
operators:
- name: EE
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Three
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Sky
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: O2
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Vodafone
status: SUSPENDED
modified: '2023-01-19t13:11:08.204Z'
- country: SE
status: PENDING
operators:
- name: Tele2
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Telenor
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Telia
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Three
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
details:
brand:
emails:
- label: label
address: test@test.com
- label: label-1
address: test-1@test.com
- label: label-2
address: test-2@test.com
phones:
- label: label
number: '+48777777777'
- label: label-1
number: '48888888888'
- label: label-2
number: '+48999999999'
websites:
- label: label
url: https://example.com
- label: label-1
url: https://example-1.com
- label: label-2
url: https://example-2.com
color: '#000000'
description: Test description
bannerUrl: https://example-banner-url.com
logoUrl: https://example-logo-url.com
privacyPolicyUrl: https://example-private-policy-url.com
termsOfServiceUrl: https://example-terms-of-service-url.com
name: Test name
testNumbers:
- '+48777777777'
countries:
- FR
- GB
- SE
questionnaire:
general:
questions:
optInDescription:
question: How do users agree to receive messages from your business through the agent?
suggestedAnswers:
- By subscribing to our loyalty program
- By making a purchase in-store or online
- By subscribing to a newsletter
- By creating an account on our website or app
triggerDescription:
question: When does your business send messages to users through the agent?
suggestedAnswers:
- User actions (e.g. after making a purchase)
interactionsDescription:
question: How will users interact with your business through the agent?
suggestedAnswers:
- Online Payment
- Password reset
- OTP/2FA for account login
optOutDescription:
question: What message does your business send when a user opts out?
suggestedAnswers:
- Thank you for opting out
- Thank you for unsubscribing
- We have registered your opt out request
videoUris:
question: ''
suggestedAnswers: []
screenshotUris:
question: ''
suggestedAnswers: []
answers:
optInDescription: By subscribing to a newsletter
triggerDescription: User actions (e.g. after making a purchase)
interactionsDescription: Billing or payment reminders,aef Order updates,aef Upon package delivery
interactionsDescriptionMetadata:
ignore: ',aef'
optOutDescription: We have registered your opt out request
videoUris:
- https://example-video-url.com
screenshotUris:
- https://example-screenshot-url.com
verification:
questions:
name:
question: What is the name of your verification contact?
suggestedAnswers: []
email:
question: What is the email of your verification contact?
suggestedAnswers: []
title:
question: What is the title of your verification contact?
suggestedAnswers: []
website:
question: What is the website of your verification contact?
suggestedAnswers: []
phone:
question: What is the phone number of your verification contact?
suggestedAnswers: []
partner:
companyName:
question: 'For ASP resellers: what is the name of the brand partner company?'
suggestedAnswers: []
contactName:
question: 'For ASP resellers: what is the name of the brand partner contact person?'
suggestedAnswers: []
contactEmailAddress:
question: 'For ASP resellers: what is the email of the brand partner contact person?'
suggestedAnswers: []
answers:
name: Exam Ple
email: email@example.com
title: Head Example
website: https://example.com
phone: '+48777777777'
partner:
companyName: Partner company
contactName: Partner contact name
contactEmailAddress: partner.contact@partner-company.com
gb:
questions:
brandIndustry:
question: What sector or industry does your business operate in?
suggestedAnswers:
- Automotive
- Beauty, spa and salon
- Clothing
- Education
- Entertainment
- Event planning and service
- Finance and banking
- Food and groceries
- Public service
- Hotel and lodging
- Medical and health
- Charity
- Professional services
- Shopping and retail
- Travel and transportation
- Restaurant
companyLegalName:
question: What is the registered legal name of your company?
suggestedAnswers: []
companyRegistrationNumber:
question: What is the registration number of your company?
suggestedAnswers: []
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
messagesVolume:
question: What is the total volume of messages expected to be sent by your agent?
suggestedAnswers:
- 0 - 10K messages
- 10K - 100K messages
- 100K - 1M messages
- 1M+ messages
messagesFrequency:
question: How often do you expect to send messages?
suggestedAnswers:
- Once per day
- Once per week
- Once per month
- Once per 3 months
- Once per 6 months
campaignLength:
question: What will be the length of the RCS campaign?
suggestedAnswers:
- 1 day or less
- 2 to 7 days
- 8 to 21 days
- 1 month
- 3 months
- 6 months
- Continuous / ongoing
answers:
brandIndustry: Automotive
companyLegalName: Example company legal name
companyRegistrationNumber: 123-123456789
fullCompanyAddress: Skeppsbron 1 Malmö, 123 12, Sweden
messagesVolume: 10K - 100K messages
messagesFrequency: Once per month
fr:
questions:
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
siren:
question: What is your Company directory identification system number (SIREN)?
suggestedAnswers: []
answers:
fullCompanyAddress: Skeppsbron 1-split-211 20-split-Malmö
fullCompanyAddressMetadata:
ignore: -split-
siren: '123456789'
us:
questions:
ownershipType:
question: What is the ownership type of your company?
suggestedAnswers:
- PRIVATE
- PUBLIC
companyLegalName:
question: What is the registered legal name of your company?
suggestedAnswers: []
companyPhoneNumber:
question: What is the primary phone number of your company?
suggestedAnswers: []
companyEmailAddress:
question: What is the primary email address of your company?
suggestedAnswers: []
brandName:
question: What is your brand name or Doing Business As (DBA)?
suggestedAnswers: []
brandIndustry:
question: What sector or industry does your business operate in?
suggestedAnswers:
- AGRICULTURE
- COMMUNICATION
- CONSTRUCTION
- EDUCATION
- ENERGY
- ENTERTAINMENT
- FINANCIAL
- GAMBLING
- GOVERNMENT
- HEALTHCARE
- HOSPITALITY
- HUMAN_RESOURCES
- INSURANCE
- LEGAL
- MANUFACTURING
- NON_GOVERNMENTAL_ORGANIZATION
- POLITICAL
- POSTAL
- PROFESSIONAL
- REAL_ESTATE
- RETAIL
- TECHNOLOGY
- TRANSPORTATION
legalForm:
question: What is the legal form of your company?
suggestedAnswers:
- CORPORATION
- LIMITED_LIABILITY_COMPANY
- PARTNERSHIP
- S_CORPORATION
taxIdCountry:
question: In which country is your company's tax ID registered?
suggestedAnswers: []
taxId:
question: 'For non-US companies: what is the tax ID of your company?'
suggestedAnswers: []
addressLine:
question: What is the primary street address of your company?
suggestedAnswers: []
addressCity:
question: In which city is your company located?
suggestedAnswers: []
addressCountry:
question: In which country is your company located?
suggestedAnswers: []
addressState:
question: In which state is your company located?
suggestedAnswers: []
addressPostalCode:
question: What is the postal code for your company address?
suggestedAnswers: []
websiteUrl:
question: What is the primary website URL for your company?
suggestedAnswers: []
contactFirstName:
question: What is the first name of the responsible contact person for your company?
suggestedAnswers: []
contactSurname:
question: What is the surname of the responsible contact person for your company?
suggestedAnswers: []
stockExchange:
question: What is the primary home country stock exchange abbreviation?
suggestedAnswers: []
stockSymbol:
question: What is the primary home country stock symbol associated with the stock exchange?
suggestedAnswers: []
sampleMessages:
question: Please provide sample messages for each use case or message type sent by your brand.
suggestedAnswers: []
messagesVolume:
question: What is the expected message volume?
suggestedAnswers: []
embeddedLink:
question: Does your brand send messages that contain embedded links to external websites?
suggestedAnswers: []
embeddedPhone:
question: Does your brand send messages that contain embedded phone numbers for direct calling?
suggestedAnswers: []
ageGatedContent:
question: Does your brand send messages that contain age-gated content or require age verification?
suggestedAnswers: []
directLending:
question: Does your brand send messages that involve direct lending or financial services?
suggestedAnswers: []
optInConfirmationMessage:
question: Does your brand send opt-in confirmation messages to users who have subscribed to receive messages?
suggestedAnswers: []
helpMessage:
question: Does your brand send help messages that provide assistance or support information to users?
suggestedAnswers: []
callToActionMessage:
question: Does your brand send call-to-action messages that encourage users to take specific actions?
suggestedAnswers: []
answers:
ownershipType: PUBLIC
companyLegalName: Example company legal name
companyPhoneNumber: '+48777777777'
companyEmailAddress: email@example.com
brandName: Example brand name
brandIndustry: AGRICULTURE
legalForm: CORPORATION
taxIdCountry: US
taxId: 12-3456789
addressLine: 123 Main St
addressCity: Anytown
addressCountry: US
addressState: CA
addressPostalCode: '12345'
websiteUrl: https://example.com
contactFirstName: John
contactSurname: Doe
stockExchange: NASDAQ
stockSymbol: EXMPL
sampleMessages:
- Sample message 1 for the US questionnaire.
- Sample message 2 for the US questionnaire.
messagesVolume: 10000
embeddedLink: true
embeddedPhone: true
ageGatedContent: false
directLending: false
optInConfirmationMessage: Thank you for opting in!
helpMessage: For help, contact support.
callToActionMessage: Click here to claim your special offer and explore our latest updates now.
region: EU
billingCategory: CONVERSATIONAL
useCase: OTP
hostingRegion: EUROPE
authName: yurwN6123asd
authToken: ejiiqJtDyurwN6jLze8v
conversationApiApp: 4CF9CE97504C4A468F4610919D17ECC1
conversationApiAppDetails:
id: 4CF9CE97504C4A468F4610919D17ECC1
projectId: ea026751-3edf-40a9-ad93-1b382bd60a78
region: EU
channelStatus: ACTIVE
created: '2023-01-19t13:11:08.204Z'
modified: '2023-01-19t13:11:08.204Z'
launched: '2023-01-19t13:11:08.204Z'
supplierDetails:
google:
agentId: agentId
brandId: brandId
newPreparingLaunchBrandResponse:
summary: Preparing launch response with brand approval
description: "\n Response when successfully launching a sender that is waiting on brand approval.\n "
value:
id: cf11794a-6a5e-4a12-b103-da79bd378bf1
state: PREPARING_LAUNCH
testNumberStates:
- number: '+46123123111'
state: UNVERIFIED
submitted: '2023-01-19t13:11:08.204Z'
- number: '+46123123222'
state: VERIFIED
submitted: '2023-01-19t13:11:08.204Z'
- number: '+46123123333'
state: DECLINED
submitted: '2023-01-19t13:11:08.204Z'
countryStatus:
- country: FR
status: PENDING
operators:
- name: Coriolis Telecom
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Lycamobile
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Bouygues
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Free
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: NRJ Mobile
status: REJECTED
remark: Sender was rejected due to operator policy.
modified: '2023-01-19t13:11:08.204Z'
- name: SFR
status: SUSPENDED
modified: '2023-01-19t13:11:08.204Z'
- name: Orange
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- country: GB
status: PENDING
operators:
- name: EE
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Three
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Sky
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: O2
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Vodafone
status: SUSPENDED
modified: '2023-01-19t13:11:08.204Z'
- country: SE
status: PENDING
operators:
- name: Tele2
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Telenor
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Telia
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Three
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
details:
brand:
emails:
- label: label
address: test@test.com
- label: label-1
address: test-1@test.com
- label: label-2
address: test-2@test.com
phones:
- label: label
number: '+48777777777'
- label: label-1
number: '48888888888'
- label: label-2
number: '+48999999999'
websites:
- label: label
url: https://example.com
- label: label-1
url: https://example-1.com
- label: label-2
url: https://example-2.com
color: '#000000'
description: Test description
bannerUrl: https://example-banner-url.com
logoUrl: https://example-logo-url.com
privacyPolicyUrl: https://example-private-policy-url.com
termsOfServiceUrl: https://example-terms-of-service-url.com
name: Test name
testNumbers:
- '+48777777777'
countries:
- FR
- GB
- SE
questionnaire:
general:
questions:
optInDescription:
question: How do users agree to receive messages from your business through the agent?
suggestedAnswers:
- By subscribing to our loyalty program
- By making a purchase in-store or online
- By subscribing to a newsletter
- By creating an account on our website or app
triggerDescription:
question: When does your business send messages to users through the agent?
suggestedAnswers:
- User actions (e.g. after making a purchase)
interactionsDescription:
question: How will users interact with your business through the agent?
suggestedAnswers:
- Online Payment
- Password reset
- OTP/2FA for account login
optOutDescription:
question: What message does your business send when a user opts out?
suggestedAnswers:
- Thank you for opting out
- Thank you for unsubscribing
- We have registered your opt out request
videoUris:
question: ''
suggestedAnswers: []
screenshotUris:
question: ''
suggestedAnswers: []
answers:
optInDescription: By subscribing to a newsletter
triggerDescription: User actions (e.g. after making a purchase)
interactionsDescription: Billing or payment reminders,aef Order updates,aef Upon package delivery
interactionsDescriptionMetadata:
ignore: ',aef'
optOutDescription: We have registered your opt out request
videoUris:
- https://example-video-url.com
screenshotUris:
- https://example-screenshot-url.com
verification:
questions:
name:
question: What is the name of your verification contact?
suggestedAnswers: []
email:
question: What is the email of your verification contact?
suggestedAnswers: []
title:
question: What is the title of your verification contact?
suggestedAnswers: []
website:
question: What is the website of your verification contact?
suggestedAnswers: []
phone:
question: What is the phone number of your verification contact?
suggestedAnswers: []
partner:
companyName:
question: 'For ASP resellers: what is the name of the brand partner company?'
suggestedAnswers: []
contactName:
question: 'For ASP resellers: what is the name of the brand partner contact person?'
suggestedAnswers: []
contactEmailAddress:
question: 'For ASP resellers: what is the email of the brand partner contact person?'
suggestedAnswers: []
answers:
name: Exam Ple
email: email@example.com
title: Head Example
website: https://example.com
phone: '+48777777777'
partner:
companyName: Partner company
contactName: Partner contact name
contactEmailAddress: partner.contact@partner-company.com
gb:
questions:
brandIndustry:
question: What sector or industry does your business operate in?
suggestedAnswers:
- Automotive
- Beauty, spa and salon
- Clothing
- Education
- Entertainment
- Event planning and service
- Finance and banking
- Food and groceries
- Public service
- Hotel and lodging
- Medical and health
- Charity
- Professional services
- Shopping and retail
- Travel and transportation
- Restaurant
companyLegalName:
question: What is the registered legal name of your company?
suggestedAnswers: []
companyRegistrationNumber:
question: What is the registration number of your company?
suggestedAnswers: []
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
messagesVolume:
question: What is the total volume of messages expected to be sent by your agent?
suggestedAnswers:
- 0 - 10K messages
- 10K - 100K messages
- 100K - 1M messages
- 1M+ messages
messagesFrequency:
question: How often do you expect to send messages?
suggestedAnswers:
- Once per day
- Once per week
- Once per month
- Once per 3 months
- Once per 6 months
campaignLength:
question: What will be the length of the RCS campaign?
suggestedAnswers:
- 1 day or less
- 2 to 7 days
- 8 to 21 days
- 1 month
- 3 months
- 6 months
- Continuous / ongoing
answers:
brandIndustry: Automotive
companyLegalName: Example company legal name
companyRegistrationNumber: 123-123456789
fullCompanyAddress: Skeppsbron 1 Malmö, 123 12, Sweden
messagesVolume: 10K - 100K messages
messagesFrequency: Once per month
fr:
questions:
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
siren:
question: What is your Company directory identification system number (SIREN)?
suggestedAnswers: []
answers:
fullCompanyAddress: Skeppsbron 1-split-211 20-split-Malmö
fullCompanyAddressMetadata:
ignore: -split-
siren: '123456789'
us:
questions:
ownershipType:
question: What is the ownership type of your company?
suggestedAnswers:
- PRIVATE
- PUBLIC
companyLegalName:
question: What is the registered legal name of your company?
suggestedAnswers: []
companyPhoneNumber:
question: What is the primary phone number of your company?
suggestedAnswers: []
companyEmailAddress:
question: What is the primary email address of your company?
suggestedAnswers: []
brandName:
question: What is your brand name or Doing Business As (DBA)?
suggestedAnswers: []
brandIndustry:
question: What sector or industry does your business operate in?
suggestedAnswers:
- AGRICULTURE
- COMMUNICATION
- CONSTRUCTION
- EDUCATION
- ENERGY
- ENTERTAINMENT
- FINANCIAL
- GAMBLING
- GOVERNMENT
- HEALTHCARE
- HOSPITALITY
- HUMAN_RESOURCES
- INSURANCE
- LEGAL
- MANUFACTURING
- NON_GOVERNMENTAL_ORGANIZATION
- POLITICAL
- POSTAL
- PROFESSIONAL
- REAL_ESTATE
- RETAIL
- TECHNOLOGY
- TRANSPORTATION
legalForm:
question: What is the legal form of your company?
suggestedAnswers:
- CORPORATION
- LIMITED_LIABILITY_COMPANY
- PARTNERSHIP
- S_CORPORATION
taxIdCountry:
question: In which country is your company's tax ID registered?
suggestedAnswers: []
taxId:
question: 'For non-US companies: what is the tax ID of your company?'
suggestedAnswers: []
addressLine:
question: What is the primary street address of your company?
suggestedAnswers: []
addressCity:
question: In which city is your company located?
suggestedAnswers: []
addressCountry:
question: In which country is your company located?
suggestedAnswers: []
addressState:
question: In which state is your company located?
suggestedAnswers: []
addressPostalCode:
question: What is the postal code for your company address?
suggestedAnswers: []
websiteUrl:
question: What is the primary website URL for your company?
suggestedAnswers: []
contactFirstName:
question: What is the first name of the responsible contact person for your company?
suggestedAnswers: []
contactSurname:
question: What is the surname of the responsible contact person for your company?
suggestedAnswers: []
stockExchange:
question: What is the primary home country stock exchange abbreviation?
suggestedAnswers: []
stockSymbol:
question: What is the primary home country stock symbol associated with the stock exchange?
suggestedAnswers: []
sampleMessages:
question: Please provide sample messages for each use case or message type sent by your brand.
suggestedAnswers: []
messagesVolume:
question: What is the expected message volume?
suggestedAnswers: []
embeddedLink:
question: Does your brand send messages that contain embedded links to external websites?
suggestedAnswers: []
embeddedPhone:
question: Does your brand send messages that contain embedded phone numbers for direct calling?
suggestedAnswers: []
ageGatedContent:
question: Does your brand send messages that contain age-gated content or require age verification?
suggestedAnswers: []
directLending:
question: Does your brand send messages that involve direct lending or financial services?
suggestedAnswers: []
optInConfirmationMessage:
question: Does your brand send opt-in confirmation messages to users who have subscribed to receive messages?
suggestedAnswers: []
helpMessage:
question: Does your brand send help messages that provide assistance or support information to users?
suggestedAnswers: []
callToActionMessage:
question: Does your brand send call-to-action messages that encourage users to take specific actions?
suggestedAnswers: []
answers:
ownershipType: PUBLIC
companyLegalName: Example company legal name
companyPhoneNumber: '+48777777777'
companyEmailAddress: email@example.com
brandName: Example brand name
brandIndustry: AGRICULTURE
legalForm: CORPORATION
taxIdCountry: US
taxId: 12-3456789
addressLine: 123 Main St
addressCity: Anytown
addressCountry: US
addressState: CA
addressPostalCode: '12345'
websiteUrl: https://example.com
contactFirstName: John
contactSurname: Doe
stockExchange: NASDAQ
stockSymbol: EXMPL
sampleMessages:
- Sample message 1 for the US questionnaire.
- Sample message 2 for the US questionnaire.
messagesVolume: 10000
embeddedLink: true
embeddedPhone: true
ageGatedContent: false
directLending: false
optInConfirmationMessage: Thank you for opting in!
helpMessage: For help, contact support.
callToActionMessage: Click here to claim your special offer and explore our latest updates now.
region: EU
billingCategory: CONVERSATIONAL
useCase: OTP
hostingRegion: EUROPE
authName: yurwN6123asd
authToken: ejiiqJtDyurwN6jLze8v
conversationApiApp: 4CF9CE97504C4A468F4610919D17ECC1
conversationApiAppDetails:
id: 4CF9CE97504C4A468F4610919D17ECC1
projectId: ea026751-3edf-40a9-ad93-1b382bd60a78
region: EU
channelStatus: ACTIVE
created: '2023-01-19t13:11:08.204Z'
modified: '2023-01-19t13:11:08.204Z'
launched: '2023-01-19t13:11:08.204Z'
supplierDetails:
google:
agentId: agentId
brandId: brandId
brandDetails:
id: eceed77f-22f6-42bc-b2ce-3fe65916028e
status: DRAFT
registration:
id: 2ea4f0aa-f85d-4785-9ad9-0b08bbc148c2
status: NEW
launchingResponse:
summary: '[Deprecated] Launching response'
description: "\n Response when successfully launching a sender with all required attributes.\n "
value:
id: cf11794a-6a5e-4a12-b103-da79bd378bf1
state: LAUNCHING
testNumberStates:
- number: '+46123123111'
state: UNVERIFIED
submitted: '2023-01-19t13:11:08.204Z'
- number: '+46123123222'
state: VERIFIED
submitted: '2023-01-19t13:11:08.204Z'
- number: '+46123123333'
state: DECLINED
submitted: '2023-01-19t13:11:08.204Z'
countryStatus:
- country: FR
status: PENDING
operators:
- name: Coriolis Telecom
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Lycamobile
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Bouygues
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Free
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: NRJ Mobile
status: REJECTED
remark: Sender was rejected due to operator policy.
modified: '2023-01-19t13:11:08.204Z'
- name: SFR
status: SUSPENDED
modified: '2023-01-19t13:11:08.204Z'
- name: Orange
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- country: GB
status: PENDING
operators:
- name: EE
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Three
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Sky
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: O2
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Vodafone
status: SUSPENDED
modified: '2023-01-19t13:11:08.204Z'
- country: SE
status: PENDING
operators:
- name: Tele2
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Telenor
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Telia
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Three
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
details:
brand:
emails:
- label: label
address: test@test.com
- label: label-1
address: test-1@test.com
- label: label-2
address: test-2@test.com
phones:
- label: label
number: '+48777777777'
- label: label-1
number: '48888888888'
- label: label-2
number: '+48999999999'
websites:
- label: label
url: https://example.com
- label: label-1
url: https://example-1.com
- label: label-2
url: https://example-2.com
color: '#000000'
description: Test description
bannerUrl: https://example-banner-url.com
logoUrl: https://example-logo-url.com
privacyPolicyUrl: https://example-private-policy-url.com
termsOfServiceUrl: https://example-terms-of-service-url.com
name: Test name
testNumbers:
- '+48777777777'
countries:
- FR
- GB
- SE
questionnaire:
general:
questions:
optInDescription:
question: How do users agree to receive messages from your business through the agent?
suggestedAnswers:
- By subscribing to our loyalty program
- By making a purchase in-store or online
- By subscribing to a newsletter
- By creating an account on our website or app
triggerDescription:
question: When does your business send messages to users through the agent?
suggestedAnswers:
- User actions (e.g. after making a purchase)
interactionsDescription:
question: How will users interact with your business through the agent?
suggestedAnswers:
- Online Payment
- Password reset
- OTP/2FA for account login
optOutDescription:
question: What message does your business send when a user opts out?
suggestedAnswers:
- Thank you for opting out
- Thank you for unsubscribing
- We have registered your opt out request
videoUris:
question: ''
suggestedAnswers: []
screenshotUris:
question: ''
suggestedAnswers: []
answers:
optInDescription: By subscribing to a newsletter
triggerDescription: User actions (e.g. after making a purchase)
interactionsDescription: Billing or payment reminders,aef Order updates,aef Upon package delivery
interactionsDescriptionMetadata:
ignore: ',aef'
optOutDescription: We have registered your opt out request
videoUris:
- https://example-video-url.com
screenshotUris:
- https://example-screenshot-url.com
verification:
questions:
name:
question: What is the name of your verification contact?
suggestedAnswers: []
email:
question: What is the email of your verification contact?
suggestedAnswers: []
title:
question: What is the title of your verification contact?
suggestedAnswers: []
website:
question: What is the website of your verification contact?
suggestedAnswers: []
phone:
question: What is the phone number of your verification contact?
suggestedAnswers: []
partner:
companyName:
question: 'For ASP resellers: what is the name of the brand partner company?'
suggestedAnswers: []
contactName:
question: 'For ASP resellers: what is the name of the brand partner contact person?'
suggestedAnswers: []
contactEmailAddress:
question: 'For ASP resellers: what is the email of the brand partner contact person?'
suggestedAnswers: []
answers:
name: Exam Ple
email: email@example.com
title: Head Example
website: https://example.com
phone: '+48777777777'
partner:
companyName: Partner company
contactName: Partner contact name
contactEmailAddress: partner.contact@partner-company.com
gb:
questions:
brandIndustry:
question: What sector or industry does your business operate in?
suggestedAnswers:
- Automotive
- Beauty, spa and salon
- Clothing
- Education
- Entertainment
- Event planning and service
- Finance and banking
- Food and groceries
- Public service
- Hotel and lodging
- Medical and health
- Charity
- Professional services
- Shopping and retail
- Travel and transportation
- Restaurant
companyLegalName:
question: What is the registered legal name of your company?
suggestedAnswers: []
companyRegistrationNumber:
question: What is the registration number of your company?
suggestedAnswers: []
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
messagesVolume:
question: What is the total volume of messages expected to be sent by your agent?
suggestedAnswers:
- 0 - 10K messages
- 10K - 100K messages
- 100K - 1M messages
- 1M+ messages
messagesFrequency:
question: How often do you expect to send messages?
suggestedAnswers:
- Once per day
- Once per week
- Once per month
- Once per 3 months
- Once per 6 months
campaignLength:
question: What will be the length of the RCS campaign?
suggestedAnswers:
- 1 day or less
- 2 to 7 days
- 8 to 21 days
- 1 month
- 3 months
- 6 months
- Continuous / ongoing
answers:
brandIndustry: Automotive
companyLegalName: Example company legal name
companyRegistrationNumber: 123-123456789
fullCompanyAddress: Skeppsbron 1 Malmö, 123 12, Sweden
messagesVolume: 10K - 100K messages
messagesFrequency: Once per month
fr:
questions:
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
siren:
question: What is your Company directory identification system number (SIREN)?
suggestedAnswers: []
answers:
fullCompanyAddress: Skeppsbron 1-split-211 20-split-Malmö
fullCompanyAddressMetadata:
ignore: -split-
siren: '123456789'
us:
questions:
companyLegalName:
question: What is the registered legal name of your company?
suggestedAnswers: []
ein:
question: What is the Employer Identification Number (EIN) of your company?
suggestedAnswers: []
brandIndustry:
question: What sector or industry does your business operate in?
suggestedAnswers:
- Automotive
- Beauty, spa and salon
- Clothing
- Education
- Entertainment
- Event planning and service
- Finance and banking
- Food and groceries
- Public service
- Hotel and lodging
- Medical and health
- Charity
- Professional services
- Shopping and retail
- Travel and transportation
- Restaurant
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
smsCampaign:
question: US SMS campaign used as fallback.
suggestedAnswers: []
messagesVolume:
question: What is the total volume of messages expected to be sent by your agent?
suggestedAnswers:
- 0 - 10K messages
- 10K - 100K messages
- 100K - 1M messages
- 1M+ messages
answers:
companyLegalName: Example company legal name
ein: 12-3456789
brandIndustry: Automotive
fullCompanyAddress: Skeppsbron 1-split-211 20-split-Malmö
fullCompanyAddressMetadata:
ignore: -split-
smsCampaign: We have registered your opt out request
messagesVolume: 10K - 100K messages
region: EU
billingCategory: CONVERSATIONAL
useCase: OTP
hostingRegion: EUROPE
authName: yurwN6123asd
authToken: ejiiqJtDyurwN6jLze8v
conversationApiApp: 4CF9CE97504C4A468F4610919D17ECC1
conversationApiAppDetails:
id: 4CF9CE97504C4A468F4610919D17ECC1
projectId: ea026751-3edf-40a9-ad93-1b382bd60a78
region: EU
channelStatus: ACTIVE
created: '2023-01-19t13:11:08.204Z'
modified: '2023-01-19t13:11:08.204Z'
launched: '2023-01-19t13:11:08.204Z'
supplierDetails:
google:
agentId: agentId
brandId: brandId
preparingLaunchResponse:
summary: '[Deprecated] Preparing launch response'
description: "\n Response when successfully launching a sender.\n "
value:
id: cf11794a-6a5e-4a12-b103-da79bd378bf1
state: PREPARING_LAUNCH
testNumberStates:
- number: '+46123123111'
state: UNVERIFIED
submitted: '2023-01-19t13:11:08.204Z'
- number: '+46123123222'
state: VERIFIED
submitted: '2023-01-19t13:11:08.204Z'
- number: '+46123123333'
state: DECLINED
submitted: '2023-01-19t13:11:08.204Z'
countryStatus:
- country: FR
status: PENDING
operators:
- name: Coriolis Telecom
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Lycamobile
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Bouygues
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Free
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: NRJ Mobile
status: REJECTED
remark: Sender was rejected due to operator policy.
modified: '2023-01-19t13:11:08.204Z'
- name: SFR
status: SUSPENDED
modified: '2023-01-19t13:11:08.204Z'
- name: Orange
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- country: GB
status: PENDING
operators:
- name: EE
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Three
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Sky
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: O2
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Vodafone
status: SUSPENDED
modified: '2023-01-19t13:11:08.204Z'
- country: SE
status: PENDING
operators:
- name: Tele2
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Telenor
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Telia
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
- name: Three
status: PENDING
modified: '2023-01-19t13:11:08.204Z'
details:
brand:
emails:
- label: label
address: test@test.com
- label: label-1
address: test-1@test.com
- label: label-2
address: test-2@test.com
phones:
- label: label
number: '+48777777777'
- label: label-1
number: '48888888888'
- label: label-2
number: '+48999999999'
websites:
- label: label
url: https://example.com
- label: label-1
url: https://example-1.com
- label: label-2
url: https://example-2.com
color: '#000000'
description: Test description
bannerUrl: https://example-banner-url.com
logoUrl: https://example-logo-url.com
privacyPolicyUrl: https://example-private-policy-url.com
termsOfServiceUrl: https://example-terms-of-service-url.com
name: Test name
testNumbers:
- '+48777777777'
countries:
- FR
- GB
- SE
questionnaire:
general:
questions:
optInDescription:
question: How do users agree to receive messages from your business through the agent?
suggestedAnswers:
- By subscribing to our loyalty program
- By making a purchase in-store or online
- By subscribing to a newsletter
- By creating an account on our website or app
triggerDescription:
question: When does your business send messages to users through the agent?
suggestedAnswers:
- User actions (e.g. after making a purchase)
interactionsDescription:
question: How will users interact with your business through the agent?
suggestedAnswers:
- Online Payment
- Password reset
- OTP/2FA for account login
optOutDescription:
question: What message does your business send when a user opts out?
suggestedAnswers:
- Thank you for opting out
- Thank you for unsubscribing
- We have registered your opt out request
videoUris:
question: ''
suggestedAnswers: []
screenshotUris:
question: ''
suggestedAnswers: []
answers:
optInDescription: By subscribing to a newsletter
triggerDescription: User actions (e.g. after making a purchase)
interactionsDescription: Billing or payment reminders,aef Order updates,aef Upon package delivery
interactionsDescriptionMetadata:
ignore: ',aef'
optOutDescription: We have registered your opt out request
videoUris:
- https://example-video-url.com
screenshotUris:
- https://example-screenshot-url.com
verification:
questions:
name:
question: What is the name of your verification contact?
suggestedAnswers: []
email:
question: What is the email of your verification contact?
suggestedAnswers: []
title:
question: What is the title of your verification contact?
suggestedAnswers: []
website:
question: What is the website of your verification contact?
suggestedAnswers: []
phone:
question: What is the phone number of your verification contact?
suggestedAnswers: []
partner:
companyName:
question: 'For ASP resellers: what is the name of the brand partner company?'
suggestedAnswers: []
contactName:
question: 'For ASP resellers: what is the name of the brand partner contact person?'
suggestedAnswers: []
contactEmailAddress:
question: 'For ASP resellers: what is the email of the brand partner contact person?'
suggestedAnswers: []
answers:
name: Exam Ple
email: email@example.com
title: Head Example
website: https://example.com
phone: '+48777777777'
partner:
companyName: Partner company
contactName: Partner contact name
contactEmailAddress: partner.contact@partner-company.com
gb:
questions:
brandIndustry:
question: What sector or industry does your business operate in?
suggestedAnswers:
- Automotive
- Beauty, spa and salon
- Clothing
- Education
- Entertainment
- Event planning and service
- Finance and banking
- Food and groceries
- Public service
- Hotel and lodging
- Medical and health
- Charity
- Professional services
- Shopping and retail
- Travel and transportation
- Restaurant
companyLegalName:
question: What is the registered legal name of your company?
suggestedAnswers: []
companyRegistrationNumber:
question: What is the registration number of your company?
suggestedAnswers: []
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
messagesVolume:
question: What is the total volume of messages expected to be sent by your agent?
suggestedAnswers:
- 0 - 10K messages
- 10K - 100K messages
- 100K - 1M messages
- 1M+ messages
messagesFrequency:
question: How often do you expect to send messages?
suggestedAnswers:
- Once per day
- Once per week
- Once per month
- Once per 3 months
- Once per 6 months
campaignLength:
question: What will be the length of the RCS campaign?
suggestedAnswers:
- 1 day or less
- 2 to 7 days
- 8 to 21 days
- 1 month
- 3 months
- 6 months
- Continuous / ongoing
answers:
brandIndustry: Automotive
companyLegalName: Example company legal name
companyRegistrationNumber: 123-123456789
fullCompanyAddress: Skeppsbron 1 Malmö, 123 12, Sweden
messagesVolume: 10K - 100K messages
messagesFrequency: Once per month
fr:
questions:
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
siren:
question: What is your Company directory identification system number (SIREN)?
suggestedAnswers: []
answers:
fullCompanyAddress: Skeppsbron 1-split-211 20-split-Malmö
fullCompanyAddressMetadata:
ignore: -split-
siren: '123456789'
us:
questions:
companyLegalName:
question: What is the registered legal name of your company?
suggestedAnswers: []
ein:
question: What is the Employer Identification Number (EIN) of your company?
suggestedAnswers: []
brandIndustry:
question: What sector or industry does your business operate in?
suggestedAnswers:
- Automotive
- Beauty, spa and salon
- Clothing
- Education
- Entertainment
- Event planning and service
- Finance and banking
- Food and groceries
- Public service
- Hotel and lodging
- Medical and health
- Charity
- Professional services
- Shopping and retail
- Travel and transportation
- Restaurant
fullCompanyAddress:
question: Full Company Address
suggestedAnswers: []
smsCampaign:
question: US SMS campaign used as fallback.
suggestedAnswers: []
messagesVolume:
question: What is the total volume of messages expected to be sent by your agent?
suggestedAnswers:
- 0 - 10K messages
- 10K - 100K messages
- 100K - 1M messages
- 1M+ messages
answers:
companyLegalName: Example company legal name
ein: 12-3456789
brandIndustry: Automotive
fullCompanyAddress: Skeppsbron 1-split-211 20-split-Malmö
fullCompanyAddressMetadata:
ignore: -split-
smsCampaign: We have registered your opt out request
messagesVolume: 10K - 100K messages
region: EU
billingCategory: CONVERSATIONAL
useCase: OTP
hostingRegion: EUROPE
authName: yurwN6123asd
authToken: ejiiqJtDyurwN6jLze8v
conversationApiApp: 4CF9CE97504C4A468F4610919D17ECC1
conversationApiAppDetails:
id: 4CF9CE97504C4A468F4610919D17ECC1
projectId: ea026751-3edf-40a9-ad93-1b382bd60a78
region: EU
channelStatus: ACTIVE
created: '2023-01-19t13:11:08.204Z'
modified: '2023-01-19t13:11:08.204Z'
launched: '2023-01-19t13:11:08.204Z'
supplierDetails:
google:
agentId: agentId
brandId: brandId
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
verification_suspended_in_gmb-0:
summary: VerificationSuspendedInGmbError
value:
errorCode: verification_suspended_in_gmb
message: Associated Google My Business is suspended
resolution: Reverify Google My Business.
invalid_id_format-1:
summary: InvalidIdFormatError
value:
errorCode: invalid_id_format
message: Id is not in the expected format.
resolution: senderId param is in the wrong format. Confirm that you're sending the correct value.
invalid_region_for_att_supplier-2:
summary: InvalidRegionForAttSupplierError
value:
errorCode: invalid_region_for_att_supplier
message: Invalid region for ATT supplier.
resolution: ATT supplier is only allowed in the US region.
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
unauthorized_error-0:
summary: UnauthorizedErrorError
value:
errorCode: unauthorized_error
message: Unauthorized error.
resolution: Verify that projectId is correct.
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
rbm_has_not_been_used-0:
summary: RbmHasNotBeenUsedError
value:
errorCode: rbm_has_not_been_used
message: RBM has not been used.
resolution: Please wait and try again or reach out to support at si-richmessaging@sinch.com
'404':
description: NotFound
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
sender_not_found-0:
summary: SenderNotFoundError
value:
errorCode: sender_not_found
message: Sender not found.
resolution: Verify that the parameters are correct.
rbm_resources_not_found-1:
summary: RbmResourcesNotFoundError
value:
errorCode: rbm_resources_not_found
message: RBM resources not found.
resolution: Verify that the parameters are correct, and contact support if error persists.
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
launch_invalid_agent_state-0:
summary: LaunchInvalidAgentStateError
value:
errorCode: launch_invalid_agent_state
message: Sender can't be launched.
resolution: 'Launch are only supported by senders with state: IN_TEST, LAUNCHING, LAUNCHED, UNLAUNCHED.'
launch_invalid_verification_state-1:
summary: LaunchInvalidVerificationStateError
value:
errorCode: launch_invalid_verification_state
message: Sender verification can't be updated.
resolution: 'Sender verification update are only supported by verifications with state: VERIFICATION_STATE_PENDING.'
'412':
description: PreconditionFailed
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
launch_precondition_failed-0:
summary: LaunchPreconditionFailedError
value:
errorCode: launch_precondition_failed
message: Launch precondition failed.
resolution: Correct the precondition errors and launch again.
additionalInformation:
validationErrors:
- validation.error
'429':
description: TooManyRequests
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
rbm_too_many_requests-0:
summary: RbmTooManyRequestsError
value:
errorCode: rbm_too_many_requests
message: RCS Business Messaging too many requests.
resolution: Please wait and try again.
'500':
description: InternalServerError
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
internal_error-0:
summary: InternalErrorError
value:
errorCode: internal_error
message: Internal server error.
resolution: Please wait and try again, if the error persist please contact support.
summary: Begin launch process for sender
tags:
- RCS Senders
x-badges:
- name: GA
position: after
color: green
security:
- BasicAuth: []
BearerAuth: []
OAuth2Production: []
servers:
- url: https://provisioning.api.sinch.com
description: Production server
/v1/projects/{projectId}/rcs/senders/{senderId}/testNumbers:
post:
description: 'Returns updated test number states of sender for a project.
Please note that if you re-add verified number, state will be changed to unverified and an invite to become a tester will be sent again.'
operationId: RcsSendersController_addTestNumbers_v1
parameters:
- name: projectId
required: true
in: path
description: The unique ID of the project. You can find this on the Sinch Dashboard.
schema:
type: string
- name: senderId
required: true
in: path
schema:
type: string
requestBody:
required: true
description: Test numbers to add
content:
application/json:
schema:
$ref: '#/components/schemas/RcsTestNumbersInputDto'
examples:
newInput:
summary: Body request for add test numbers
description: "\n Example body request to add test numbers.\n "
value:
testNumbers:
- '+48777777777'
input:
summary: '[Deprecated] Body request for add test numbers'
description: "\n Example body request to add test numbers.\n "
value:
testNumbers:
- '+48777777777'
responses:
'200':
description: Test number states
content:
application/json:
schema:
$ref: '#/components/schemas/RcsTestNumbersDto'
examples:
response:
summary: Test number states
description: "\n Test number states.\n "
value:
testNumbers:
- number: '+46123123111'
state: UNVERIFIED
submitted: '2023-01-19t13:11:08.204Z'
- number: '+46123123222'
state: VERIFIED
submitted: '2023-01-19t13:11:08.204Z'
- number: '+46123123333'
state: DECLINED
submitted: '2023-01-19t13:11:08.204Z'
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
invalid_id_format-0:
summary: InvalidIdFormatError
value:
errorCode: invalid_id_format
message: Id is not in the expected format.
resolution: senderId param is in the wrong format. Confirm that you're sending the correct value.
invalid_input-1:
summary: InvalidInputError
value:
errorCode: invalid_input
message: Invalid input.
resolution: Correct the validation errors and submit again.
additionalInformation:
validationErrors:
- each value in testNumbers must be a string
no_google_supplier-2:
summary: NoGoogleSupplierError
value:
errorCode: no_google_supplier
message: No google supplier in sender.
resolution: Verify that the sender has google supplier.
add_test_number_invalid-3:
summary: AddTestNumberInvalidError
value:
errorCode: add_test_number_invalid
message: Invalid phone number.
resolution: Please verify that phone number is correct.
invalid_region_for_att_supplier-4:
summary: InvalidRegionForAttSupplierError
value:
errorCode: invalid_region_for_att_supplier
message: Invalid region for ATT supplier.
resolution: ATT supplier is only allowed in the US region.
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
unauthorized_error-0:
summary: UnauthorizedErrorError
value:
errorCode: unauthorized_error
message: Unauthorized error.
resolution: Verify that projectId is correct.
'404':
description: NotFound
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
project_not_found-0:
summary: ProjectNotFoundError
value:
errorCode: project_not_found
message: Project not found.
resolution: Verify that the projectId is correct.
sender_not_found-1:
summary: SenderNotFoundError
value:
errorCode: sender_not_found
message: Sender not found.
resolution: Verify that the parameters are correct.
add_test_number_not_allowed_before_launch-2:
summary: AddTestNumberNotAllowedBeforeLaunchError
value:
errorCode: add_test_number_not_allowed_before_launch
message: Adding test number not allowed before launch.
resolution: Carrier does not allow test number to be created prior to sender launch.
blocked_because_the_recipient_declined-3:
summary: BlockedBecauseTheRecipientDeclinedError
value:
errorCode: blocked_because_the_recipient_declined
message: Blocked because the recipient declined.
resolution: This operation is blocked because the recipient declined the invitation to become a tester.
user_cannot_be_reached-4:
summary: UserCannotBeReachedError
value:
errorCode: user_cannot_be_reached
message: message
resolution: Verify that the user has RCS feature available.
'429':
description: TooManyRequests
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
rbm_too_many_requests-0:
summary: RbmTooManyRequestsError
value:
errorCode: rbm_too_many_requests
message: RCS Business Messaging too many requests.
resolution: Please wait and try again.
'500':
description: InternalServerError
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
internal_error-0:
summary: InternalErrorError
value:
errorCode: internal_error
message: Internal server error.
resolution: Please wait and try again, if the error persist please contact support.
summary: Add test numbers to sender for project
tags:
- RCS Senders
x-badges:
- name: GA
position: after
color: green
security:
- BasicAuth: []
BearerAuth: []
OAuth2Production: []
servers:
- url: https://provisioning.api.sinch.com
description: Production server
/v1/projects/{projectId}/rcs/senders/{senderId}/testNumbers/{testNumber}:
get:
description: Returns test number state of the sender for the project.
operationId: RcsSendersController_getTestNumberState_v1
parameters:
- name: projectId
required: true
in: path
description: The unique ID of the project. You can find this on the Sinch Dashboard.
schema:
type: string
- name: senderId
required: true
in: path
schema:
type: string
- name: testNumber
required: true
in: path
schema:
type: string
responses:
'200':
description: Test number state.
content:
application/json:
schema:
$ref: '#/components/schemas/RcsTestNumberStateDto'
examples:
newResponse:
summary: Test number state
description: "\n Test number state.\n "
value:
number: '+46123123222'
state: VERIFIED
submitted: '2023-01-19t13:11:08.204Z'
response:
summary: '[Deprecated] Test number state'
description: "\n Test number state.\n "
value:
number: '+46123123222'
state: VERIFIED
submitted: '2023-01-19t13:11:08.204Z'
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
no_google_supplier-0:
summary: NoGoogleSupplierError
value:
errorCode: no_google_supplier
message: No google supplier in sender.
resolution: Verify that the sender has google supplier.
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
unauthorized_error-0:
summary: UnauthorizedErrorError
value:
errorCode: unauthorized_error
message: Unauthorized error.
resolution: Verify that projectId is correct.
'404':
description: NotFound
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
project_not_found-0:
summary: ProjectNotFoundError
value:
errorCode: project_not_found
message: Project not found.
resolution: Verify that the projectId is correct.
sender_not_found-1:
summary: SenderNotFoundError
value:
errorCode: sender_not_found
message: Sender not found.
resolution: Verify that the parameters are correct.
user_is_not_tester_for_agent-2:
summary: UserIsNotTesterForAgentError
value:
errorCode: user_is_not_tester_for_agent
message: Test number not found.
resolution: Add test number to agent.
'429':
description: TooManyRequests
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
rbm_too_many_requests-0:
summary: RbmTooManyRequestsError
value:
errorCode: rbm_too_many_requests
message: RCS Business Messaging too many requests.
resolution: Please wait and try again.
'500':
description: InternalServerError
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
internal_error-0:
summary: InternalErrorError
value:
errorCode: internal_error
message: Internal server error.
resolution: Please wait and try again, if the error persist please contact support.
summary: Gets test number state of the sender for the project
tags:
- RCS Senders
x-badges:
- name: GA
position: after
color: green
security:
- BasicAuth: []
BearerAuth: []
OAuth2Production: []
delete:
description: Deletes a test number for the sender.
operationId: RcsSendersController_deleteTestNumber_v1
parameters:
- name: projectId
required: true
in: path
description: The unique ID of the project. You can find this on the Sinch Dashboard.
schema:
type: string
- name: senderId
required: true
in: path
description: The unique ID of the sender.
schema:
type: string
- name: testNumber
required: true
in: path
description: the user's phone number in E.164 format. For example, for a user with the US phone number +1-222-333-4444, the resulting parameter is '+12223334444'.
schema:
type: string
responses:
'204':
description: Test number deleted
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
invalid_id_format-0:
summary: InvalidIdFormatError
value:
errorCode: invalid_id_format
message: Id is not in the expected format.
resolution: senderId param is in the wrong format. Confirm that you're sending the correct value.
no_google_supplier-1:
summary: NoGoogleSupplierError
value:
errorCode: no_google_supplier
message: No google supplier in sender.
resolution: Verify that the sender has google supplier.
invalid_region_for_att_supplier-2:
summary: InvalidRegionForAttSupplierError
value:
errorCode: invalid_region_for_att_supplier
message: Invalid region for ATT supplier.
resolution: ATT supplier is only allowed in the US region.
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
unauthorized_error-0:
summary: UnauthorizedErrorError
value:
errorCode: unauthorized_error
message: Unauthorized error.
resolution: Verify that projectId is correct.
'404':
description: NotFound
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
sender_not_found-0:
summary: SenderNotFoundError
value:
errorCode: sender_not_found
message: Sender not found.
resolution: Verify that the parameters are correct.
user_is_not_tester_for_agent-1:
summary: UserIsNotTesterForAgentError
value:
errorCode: user_is_not_tester_for_agent
message: Test number not found.
resolution: Add test number to agent.
'429':
description: TooManyRequests
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
rbm_too_many_requests-0:
summary: RbmTooManyRequestsError
value:
errorCode: rbm_too_many_requests
message: RCS Business Messaging too many requests.
resolution: Please wait and try again.
'500':
description: InternalServerError
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
internal_error-0:
summary: InternalErrorError
value:
errorCode: internal_error
message: Internal server error.
resolution: Please wait and try again, if the error persist please contact support.
summary: Deletes a test number for the sender
tags:
- RCS Senders
x-badges:
- name: GA
position: after
color: green
security:
- BasicAuth: []
BearerAuth: []
OAuth2Production: []
servers:
- url: https://provisioning.api.sinch.com
description: Production server
/v1/projects/{projectId}/rcs/senders/{senderId}/testNumbers/{testNumber}/capabilities:
get:
description: Returns test number capabilities of sender for a project.
operationId: RcsSendersController_getTestNumberCapabilities_v1
parameters:
- name: projectId
required: true
in: path
description: The unique ID of the project. You can find this on the Sinch Dashboard.
schema:
type: string
- name: senderId
required: true
in: path
description: The unique ID of the sender.
schema:
type: string
- name: testNumber
required: true
in: path
description: the user's phone number in E.164 format. For example, for a user with the US phone number +1-222-333-4444, the resulting parameter is '+12223334444'.
schema:
type: string
responses:
'200':
description: test number capabilities
content:
application/json:
schema:
$ref: '#/components/schemas/RcsTestNumberCapabilitiesDto'
examples:
response:
summary: Get response
description: "\n Response with test number capabilities.\n "
value:
features:
- REVOCATION
- ACTION_DIAL
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
invalid_id_format-0:
summary: InvalidIdFormatError
value:
errorCode: invalid_id_format
message: Id is not in the expected format.
resolution: senderId param is in the wrong format. Confirm that you're sending the correct value.
no_google_supplier-1:
summary: NoGoogleSupplierError
value:
errorCode: no_google_supplier
message: No google supplier in sender.
resolution: Verify that the sender has google supplier.
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
unauthorized_error-0:
summary: UnauthorizedErrorError
value:
errorCode: unauthorized_error
message: Unauthorized error.
resolution: Verify that projectId is correct.
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
wrong_supplier_configuration-0:
summary: WrongSupplierConfigurationError
value:
errorCode: wrong_supplier_configuration
message: Wrong supplier configuration is used, configuration needs to be setup via SI team
resolution: Please reach out to support at si-richmessaging@sinch.com
'404':
description: NotFound
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
sender_not_found-0:
summary: SenderNotFoundError
value:
errorCode: sender_not_found
message: Sender not found.
resolution: Verify that the parameters are correct.
user_is_not_tester_for_agent-1:
summary: UserIsNotTesterForAgentError
value:
errorCode: user_is_not_tester_for_agent
message: Test number not found.
resolution: Add test number to agent.
looking_up_the_rbm_agent-2:
summary: LookingUpTheRbmAgentError
value:
errorCode: looking_up_the_rbm_agent
message: Looking up the RBM agent.
resolution: There was an error looking up the RBM agent.
blocked_because_the_recipient_declined-3:
summary: BlockedBecauseTheRecipientDeclinedError
value:
errorCode: blocked_because_the_recipient_declined
message: Blocked because the recipient declined.
resolution: This operation is blocked because the recipient declined the invitation to become a tester.
user_has_not_accepted_invite-4:
summary: UserHasNotAcceptedInviteError
value:
errorCode: user_has_not_accepted_invite
message: User has not accepted invite to become tester for agent.
resolution: Please wait and try again later.
user_cannot_be_reached-5:
summary: UserCannotBeReachedError
value:
errorCode: user_cannot_be_reached
message: message
resolution: Verify that the user has RCS feature available.
'429':
description: TooManyRequests
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
rbm_too_many_requests-0:
summary: RbmTooManyRequestsError
value:
errorCode: rbm_too_many_requests
message: RCS Business Messaging too many requests.
resolution: Please wait and try again.
'500':
description: InternalServerError
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
internal_error-0:
summary: InternalErrorError
value:
errorCode: internal_error
message: Internal server error.
resolution: Please wait and try again, if the error persist please contact support.
summary: Get test number capabilities of sender for project
tags:
- RCS Senders
x-badges:
- name: GA
position: after
color: green
security:
- BasicAuth: []
BearerAuth: []
OAuth2Production: []
servers:
- url: https://provisioning.api.sinch.com
description: Production server
/v1/projects/{projectId}/rcs/senders/{senderId}/testNumbers/{testNumber}/retry:
get:
description: Resend an invite and returns state for test number of sender for a project.
operationId: RcsSendersController_retryTestNumber_v1
parameters:
- name: projectId
required: true
in: path
description: The unique ID of the project. You can find this on the Sinch Dashboard.
schema:
type: string
- name: senderId
required: true
in: path
description: The unique ID of the sender.
schema:
type: string
- name: testNumber
required: true
in: path
description: the user's phone number in E.164 format. For example, for a user with the US phone number +1-222-333-4444, the resulting parameter is '+12223334444'.
schema:
type: string
responses:
'200':
description: test number state
content:
application/json:
schema:
$ref: '#/components/schemas/RcsTestNumberStateDto'
examples:
response:
summary: Get response
description: "\n Response with test number state.\n\n Please note that if you send an invite to verified number, state will be changed to unverified.\n "
value:
number: '+46123123111'
state: UNVERIFIED
submitted: '2023-01-19t13:11:08.204Z'
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
invalid_id_format-0:
summary: InvalidIdFormatError
value:
errorCode: invalid_id_format
message: Id is not in the expected format.
resolution: senderId param is in the wrong format. Confirm that you're sending the correct value.
no_google_supplier-1:
summary: NoGoogleSupplierError
value:
errorCode: no_google_supplier
message: No google supplier in sender.
resolution: Verify that the sender has google supplier.
add_test_number_invalid-2:
summary: AddTestNumberInvalidError
value:
errorCode: add_test_number_invalid
message: Invalid phone number.
resolution: Please verify that phone number is correct.
invalid_region_for_att_supplier-3:
summary: InvalidRegionForAttSupplierError
value:
errorCode: invalid_region_for_att_supplier
message: Invalid region for ATT supplier.
resolution: ATT supplier is only allowed in the US region.
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
unauthorized_error-0:
summary: UnauthorizedErrorError
value:
errorCode: unauthorized_error
message: Unauthorized error.
resolution: Verify that projectId is correct.
'404':
description: NotFound
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
sender_not_found-0:
summary: SenderNotFoundError
value:
errorCode: sender_not_found
message: Sender not found.
resolution: Verify that the parameters are correct.
user_is_not_tester_for_agent-1:
summary: UserIsNotTesterForAgentError
value:
errorCode: user_is_not_tester_for_agent
message: Test number not found.
resolution: Add test number to agent.
add_test_number_not_allowed_before_launch-2:
summary: AddTestNumberNotAllowedBeforeLaunchError
value:
errorCode: add_test_number_not_allowed_before_launch
message: Adding test number not allowed before launch.
resolution: Carrier does not allow test number to be created prior to sender launch.
blocked_because_the_recipient_declined-3:
summary: BlockedBecauseTheRecipientDeclinedError
value:
errorCode: blocked_because_the_recipient_declined
message: Blocked because the recipient declined.
resolution: This operation is blocked because the recipient declined the invitation to become a tester.
'429':
description: TooManyRequests
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
rbm_too_many_requests-0:
summary: RbmTooManyRequestsError
value:
errorCode: rbm_too_many_requests
message: RCS Business Messaging too many requests.
resolution: Please wait and try again.
'500':
description: InternalServerError
content:
application/json:
schema:
$ref: '#/components/schemas/RcsPapiErrorDto'
examples:
internal_error-0:
summary: InternalErrorError
value:
errorCode: internal_error
message: Internal server error.
resolution: Please wait and try again, if the error persist please contact support.
summary: Resend an invite to test number of sender for project
tags:
- RCS Senders
x-badges:
- name: GA
position: after
color: green
security:
- BasicAuth: []
BearerAuth: []
OAuth2Production: []
servers:
- url: https://provisioning.api.sinch.com
description: Production server
/v1/projects/{project_id}/rcs/senders:
get:
operationId: listRcsSenders
summary: List Rcs Senders
description: Returns a list of all RCS senders configured for the project.
tags:
- RCS Senders
parameters:
- $ref: '#/components/parameters/ProjectId'
responses:
'200':
description: List of RCS senders
content:
application/json:
schema:
$ref: '#/components/schemas/RcsSenderList'
'401':
description: Unauthorized
security:
- oAuth2: []
- basicAuth: []
post:
operationId: createRcsSender
summary: Create an Rcs Sender
description: Creates a new RCS sender identity with brand information and messaging agent configuration.
tags:
- RCS Senders
parameters:
- $ref: '#/components/parameters/ProjectId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateRcsSenderRequest'
responses:
'200':
description: RCS sender created
content:
application/json:
schema:
$ref: '#/components/schemas/RcsSender'
'400':
description: Invalid request
'401':
description: Unauthorized
security:
- oAuth2: []
- basicAuth: []
servers:
- url: https://provisioning.api.sinch.com
description: Global Production Server
/v1/projects/{project_id}/rcs/senders/{sender_id}:
get:
operationId: getRcsSender
summary: Get an Rcs Sender
description: Returns the details and status of a specific RCS sender.
tags:
- RCS Senders
parameters:
- $ref: '#/components/parameters/ProjectId'
- $ref: '#/components/parameters/SenderId'
responses:
'200':
description: RCS sender details
content:
application/json:
schema:
$ref: '#/components/schemas/RcsSender'
'401':
description: Unauthorized
'404':
description: Sender not found
security:
- oAuth2: []
- basicAuth: []
patch:
operationId: updateRcsSender
summary: Update an Rcs Sender
description: Updates the configuration of a specific RCS sender.
tags:
- RCS Senders
parameters:
- $ref: '#/components/parameters/ProjectId'
- $ref: '#/components/parameters/SenderId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateRcsSenderRequest'
responses:
'200':
description: RCS sender updated
content:
application/json:
schema:
$ref: '#/components/schemas/RcsSender'
'401':
description: Unauthorized
'404':
description: Sender not found
security:
- oAuth2: []
- basicAuth: []
delete:
operationId: deleteRcsSender
summary: Delete an Rcs Sender
description: Deletes a specific RCS sender from the project.
tags:
- RCS Senders
parameters:
- $ref: '#/components/parameters/ProjectId'
- $ref: '#/components/parameters/SenderId'
responses:
'200':
description: RCS sender deleted
'401':
description: Unauthorized
'404':
description: Sender not found
security:
- oAuth2: []
- basicAuth: []
servers:
- url: https://provisioning.api.sinch.com
description: Global Production Server
/v1/projects/{project_id}/rcs/senders/{sender_id}/launch:
post:
operationId: launchRcsSender
summary: Launch an Rcs Sender
description: Submits an RCS sender for launch, initiating the approval process with carriers and Google.
tags:
- RCS Senders
parameters:
- $ref: '#/components/parameters/ProjectId'
- $ref: '#/components/parameters/SenderId'
responses:
'200':
description: RCS sender launch initiated
content:
application/json:
schema:
$ref: '#/components/schemas/RcsSender'
'401':
description: Unauthorized
'404':
description: Sender not found
security:
- oAuth2: []
- basicAuth: []
servers:
- url: https://provisioning.api.sinch.com
description: Global Production Server
components:
schemas:
RcsUsQuestionnaireOwnershipTypePublicEnum:
type: string
const: PUBLIC
description: Ownership type of the company. Not required for create, but required for launch.
RcsOperatorStatusEnum:
type: string
enum:
- LAUNCHED
- NOT_LAUNCHED
- PENDING
- PENDING_UNLAUNCHED
- REJECTED
- SUSPENDED
- UNLAUNCHED
- INVALID_IN_GOOGLE_MY_BUSINESS
- UNRECOGNIZED
description: Operator status.
RcsNonUsPrivateBrandCampaignSenderDetailsQuestionnaireUSAnswersInputDto:
type: object
properties:
companyLegalName:
type: string
description: The registered legal name of the company. Not required for create, but required for launch.
minLength: 1
maxLength: 100
uniqueItems: false
companyPhoneNumber:
type: string
description: The registered phone number of the company. Not required for create, but required for launch.
minLength: 1
maxLength: 13
uniqueItems: false
companyEmailAddress:
type: string
format: email
maxLength: 100
uniqueItems: false
brandName:
type: string
description: Brand name or Doing Business As (DBA). Must be legally associated with the provided legal company name. Not required for create, but required for launch.
minLength: 1
maxLength: 100
uniqueItems: false
brandIndustry:
x-enumDescriptions:
AGRICULTURE: The brand operates within the agriculture sector.
COMMUNICATION: The brand operates within the communication industry.
CONSTRUCTION: The brand operates within the construction sector.
EDUCATION: The brand operates within the education field.
ENERGY: The brand operates within the energy and utilities sector.
ENTERTAINMENT: The brand operates within the entertainment and media industry.
FINANCIAL: The brand operates within the financial services sector.
GAMBLING: The brand operates within the gambling or betting industry.
GOVERNMENT: The brand is a government or public administration entity.
HEALTHCARE: The brand operates within the healthcare and medical sector.
HOSPITALITY: The brand operates within hospitality, tourism, or food services.
HUMAN_RESOURCES: The brand operates within human resources and staffing services.
INSURANCE: The brand operates within the insurance sector.
LEGAL: The brand operates within legal services.
MANUFACTURING: The brand operates within the manufacturing sector.
NON_GOVERNMENTAL_ORGANIZATION: The brand is a non-governmental organization (NGO).
POLITICAL: The brand is a political organization or campaign.
POSTAL: The brand operates within postal, courier, or delivery services.
PROFESSIONAL: The brand provides professional, scientific, or technical services.
REAL_ESTATE: The brand operates within the real estate market.
RETAIL: The brand operates within retail or wholesale commerce.
TECHNOLOGY: The brand operates within the technology and software sector.
TRANSPORTATION: The brand operates within transportation or logistics services.
description: Sector or industry of business. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsUsQuestionnaireBrandIndustriesEnum'
addressLine:
type: string
description: Street address line. Not required for create, but required for launch.
minLength: 1
maxLength: 100
uniqueItems: false
addressCity:
type: string
description: City. Not required for create, but required for launch.
minLength: 1
maxLength: 100
uniqueItems: false
addressCountry:
x-enumDescriptions:
AD: The country code for Andorra.
AE: The country code for the United Arab Emirates.
AF: The country code for Afghanistan.
AG: The country code for Antigua and Barbuda.
AI: The country code for Anguilla.
AL: The country code for Albania.
AM: The country code for Armenia.
AO: The country code for Angola.
AR: The country code for Argentina.
AS: The country code for American Samoa.
AT: The country code for Austria.
AU: The country code for Australia.
AW: The country code for Aruba.
AZ: The country code for Azerbaijan.
BA: The country code for Bosnia and Herzegovina.
BB: The country code for Barbados.
BD: The country code for Bangladesh.
BE: The country code for Belgium.
BF: The country code for Burkina Faso.
BG: The country code for Bulgaria.
BH: The country code for Bahrain.
BI: The country code for Burundi.
BJ: The country code for Benin.
BM: The country code for Bermuda.
BN: The country code for Brunei.
BO: The country code for Bolivia.
BQ: The country code for Bonaire.
BR: The country code for Brazil.
BS: The country code for the Bahamas.
BT: The country code for Bhutan.
BW: The country code for Botswana.
BY: The country code for Belarus.
BZ: The country code for Belize.
CA: The country code for Canada.
CD: The country code for the Democratic Republic of the Congo.
CF: The country code for the Central African Republic.
CG: The country code for the Republic of the Congo.
CH: The country code for Switzerland.
CI: The country code for the Ivory Coast.
CK: The country code for the Cook Islands.
CL: The country code for Chile.
CM: The country code for Cameroon.
CN: The country code for China.
CO: The country code for Colombia.
CR: The country code for Costa Rica.
CU: The country code for Cuba.
CV: The country code for Cape Verde.
CW: The country code for Curaçao.
CY: The country code for Cyprus.
CZ: The country code for the Czech Republic.
DE: The country code for Germany.
DJ: The country code for Djibouti.
DK: The country code for Denmark.
DM: The country code for Dominica.
DO: The country code for the Dominican Republic.
DZ: The country code for Algeria.
EC: The country code for Ecuador.
EE: The country code for Estonia.
EG: The country code for Egypt.
ER: The country code for Eritrea.
ES: The country code for Spain.
ET: The country code for Ethiopia.
FI: The country code for Finland.
FJ: The country code for Fiji.
FK: The country code for the Falkland Islands.
FM: The country code for Micronesia.
FO: The country code for the Faroe Islands.
FR: The country code for France.
GA: The country code for Gabon.
GB: The country code for the United Kingdom of Great Britain.
GD: The country code for Grenada.
GE: The country code for Georgia.
GF: The country code for French Guiana.
GG: The country code for Guernsey.
GH: The country code for Ghana.
GI: The country code for Gibraltar.
GL: The country code for Greenland.
GM: The country code for the Gambia.
GN: The country code for Guinea.
GP: The country code for Guadeloupe.
GQ: The country code for Equatorial Guinea.
GR: The country code for Greece.
GT: The country code for Guatemala.
GU: The country code for Guam.
GW: The country code for Guinea-Bissau.
GY: The country code for Guyana.
HK: The country code for Hong Kong.
HN: The country code for Honduras.
HR: The country code for Croatia.
HT: The country code for Haiti.
HU: The country code for Hungary.
ID: The country code for Indonesia.
IE: The country code for Ireland.
IL: The country code for Israel.
IM: The country code for the Isle of Man.
IN: The country code for India.
IO: The country code for the British Indian Ocean Territory.
IQ: The country code for Iraq.
IR: The country code for Iran.
IS: The country code for Iceland.
IT: The country code for Italy.
JE: The country code for Jersey.
JM: The country code for Jamaica.
JO: The country code for Jordan.
JP: The country code for Japan.
KE: The country code for Kenya.
KG: The country code for Kyrgyzstan.
KH: The country code for Cambodia.
KI: The country code for Kiribati.
KM: The country code for Comoros.
KN: The country code for Saint Kitts and Nevis.
KP: The country code for North Korea.
KR: The country code for South Korea.
KW: The country code for Kuwait.
KY: The country code for the Cayman Islands.
KZ: The country code for Kazakhstan.
LA: The country code for Laos.
LB: The country code for Lebanon.
LC: The country code for Saint Lucia.
LI: The country code for Liechtenstein.
LK: The country code for Sri Lanka.
LR: The country code for Liberia.
LS: The country code for Lesotho.
LT: The country code for Lithuania.
LU: The country code for Luxembourg.
LV: The country code for Latvia.
LY: The country code for Libya.
MA: The country code for Morocco.
MC: The country code for Monaco.
MD: The country code for Moldova.
ME: The country code for Montenegro.
MG: The country code for Madagascar.
MH: The country code for the Marshall Islands.
MK: The country code for North Macedonia.
ML: The country code for Mali.
MM: The country code for Myanmar.
MN: The country code for Mongolia.
MO: The country code for Macao.
MP: The country code for the Northern Mariana Islands.
MQ: The country code for Martinique.
MR: The country code for Mauritania.
MS: The country code for Montserrat.
MT: The country code for Malta.
MU: The country code for Mauritius.
MV: The country code for the Maldives.
MW: The country code for Malawi.
MX: The country code for Mexico.
MY: The country code for Malaysia.
MZ: The country code for Mozambique.
NA: The country code for Namibia.
NC: The country code for New Caledonia.
NE: The country code for Niger.
NF: The country code for Norfolk Island.
NG: The country code for Nigeria.
NI: The country code for Nicaragua.
NL: The country code for the Netherlands.
'NO': The country code for Norway.
NP: The country code for Nepal.
NR: The country code for Nauru.
NU: The country code for Niue.
NZ: The country code for New Zealand.
OM: The country code for Oman.
PA: The country code for Panama.
PE: The country code for Peru.
PF: The country code for French Polynesia.
PG: The country code for Papua New Guinea.
PH: The country code for the Philippines.
PK: The country code for Pakistan.
PL: The country code for Poland.
PM: The country code for Saint Pierre and Miquelon.
PR: The country code for Puerto Rico.
PS: The country code for Palestine.
PT: The country code for Portugal.
PW: The country code for Palau.
PY: The country code for Paraguay.
QA: The country code for Qatar.
RE: The country code for Réunion.
RO: The country code for Romania.
RS: The country code for Serbia.
RU: The country code for Russia.
RW: The country code for Rwanda.
SA: The country code for Saudi Arabia.
SB: The country code for the Solomon Islands.
SC: The country code for Seychelles.
SD: The country code for Sudan.
SE: The country code for Sweden.
SG: The country code for Singapore.
SH: The country code for Saint Helena.
SI: The country code for Slovenia.
SK: The country code for Slovakia.
SL: The country code for Sierra Leone.
SM: The country code for San Marino.
SN: The country code for Senegal.
SO: The country code for Somalia.
SR: The country code for Suriname.
SS: The country code for South Sudan.
ST: The country code for São Tomé and Príncipe.
SV: The country code for El Salvador.
SX: The country code for Sint Maarten.
SY: The country code for Syria.
SZ: The country code for Eswatini.
TC: The country code for the Turks and Caicos Islands.
TD: The country code for Chad.
TG: The country code for Togo.
TH: The country code for Thailand.
TJ: The country code for Tajikistan.
TK: The country code for Tokelau.
TL: The country code for East Timor.
TM: The country code for Turkmenistan.
TN: The country code for Tunisia.
TO: The country code for Tonga.
TR: The country code for Turkey.
TT: The country code for Trinidad and Tobago.
TV: The country code for Tuvalu.
TW: The country code for Taiwan.
TZ: The country code for Tanzania.
UA: The country code for Ukraine.
UG: The country code for Uganda.
UM: The country code for the United States Minor Outlying Islands.
US: The country code for the United States of America.
UY: The country code for Uruguay.
UZ: The country code for Uzbekistan.
VC: The country code for Saint Vincent and the Grenadines.
VE: The country code for Venezuela.
VG: The country code for the British Virgin Islands.
VI: The country code for the United States Virgin Islands.
VN: The country code for Vietnam.
VU: The country code for Vanuatu.
WF: The country code for Wallis and Futuna.
WS: The country code for Samoa.
XK: The country code for Kosovo.
YE: The country code for Yemen.
YT: The country code for Mayotte.
ZA: The country code for South Africa.
ZM: The country code for Zambia.
ZW: The country code for Zimbabwe.
description: Country. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsInputCountryCodesEnum'
addressPostalCode:
type: string
description: Postal code. Not required for create, but required for launch.
minLength: 1
maxLength: 10
uniqueItems: false
websiteUrl:
type: string
description: Primary website URL. Not required for create, but required for launch.
format: url
maxLength: 100
uniqueItems: false
contactFirstName:
type: string
description: First name of the responsible contact person. Not required for create, but required for launch.
minLength: 1
maxLength: 100
uniqueItems: false
contactSurname:
type: string
description: Surname of the responsible contact person. Not required for create, but required for launch.
minLength: 1
maxLength: 100
uniqueItems: false
sampleMessages:
description: Sample messages for each use case or message type sent by the brand. Not required for create, but required for launch.
minItems: 1
maxItems: 5
uniqueItems: false
type: array
items:
type: string
maxLength: 1024
minLength: 20
messagesVolume:
type: number
description: Messages volume. Not required for create, but required for launch.
uniqueItems: false
embeddedLink:
type: boolean
description: Flag indicating if URL links will be embedded within message payloads. Not required for create, but required for launch.
uniqueItems: false
embeddedPhone:
type: boolean
description: Flag indicating if phone numbers will be embedded within message payloads. Not required for create, but required for launch.
uniqueItems: false
ageGatedContent:
type: boolean
description: Indicates if the campaign content is restricted by age (e.g., alcohol, tobacco). Not required for create, but required for launch.
uniqueItems: false
directLending:
type: boolean
description: Indicates if the campaign involves direct financial lending, requiring stricter compliance. Not required for create, but required for launch.
uniqueItems: false
optInConfirmationMessage:
type: string
description: Opt-in confirmation message sent to users. Not required for create, but required for launch.
minLength: 20
maxLength: 1024
uniqueItems: false
helpMessage:
type: string
description: Help message of the campaign. Not required for create, but required for launch.
minLength: 20
maxLength: 1024
uniqueItems: false
callToActionMessage:
type: string
description: Call to action message of the campaign. Not required for create, but required for launch.
minLength: 40
maxLength: 4096
uniqueItems: false
ownershipType:
x-enumDescriptions:
PRIVATE: The brand is a privately owned entity.
description: Ownership type of the company. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsUsQuestionnaireOwnershipTypePrivateEnum'
legalForm:
x-enumDescriptions:
CORPORATION: The company is registered as a Corporation.
LIMITED_LIABILITY_COMPANY: The company is registered as a Limited Liability Company (LLC).
PARTNERSHIP: The company is registered as a Partnership.
S_CORPORATION: The company is registered as an S Corporation.
description: Legal form of the company for private ownership type. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsPrivateUsQuestionnaireBrandLegalFormsEnum'
taxIdCountry:
x-enumDescriptions:
AD: The country code for Andorra.
AE: The country code for the United Arab Emirates.
AF: The country code for Afghanistan.
AG: The country code for Antigua and Barbuda.
AI: The country code for Anguilla.
AL: The country code for Albania.
AM: The country code for Armenia.
AO: The country code for Angola.
AR: The country code for Argentina.
AS: The country code for American Samoa.
AT: The country code for Austria.
AU: The country code for Australia.
AW: The country code for Aruba.
AZ: The country code for Azerbaijan.
BA: The country code for Bosnia and Herzegovina.
BB: The country code for Barbados.
BD: The country code for Bangladesh.
BE: The country code for Belgium.
BF: The country code for Burkina Faso.
BG: The country code for Bulgaria.
BH: The country code for Bahrain.
BI: The country code for Burundi.
BJ: The country code for Benin.
BM: The country code for Bermuda.
BN: The country code for Brunei.
BO: The country code for Bolivia.
BQ: The country code for Bonaire.
BR: The country code for Brazil.
BS: The country code for the Bahamas.
BT: The country code for Bhutan.
BW: The country code for Botswana.
BY: The country code for Belarus.
BZ: The country code for Belize.
CA: The country code for Canada.
CD: The country code for the Democratic Republic of the Congo.
CF: The country code for the Central African Republic.
CG: The country code for the Republic of the Congo.
CH: The country code for Switzerland.
CI: The country code for the Ivory Coast.
CK: The country code for the Cook Islands.
CL: The country code for Chile.
CM: The country code for Cameroon.
CN: The country code for China.
CO: The country code for Colombia.
CR: The country code for Costa Rica.
CU: The country code for Cuba.
CV: The country code for Cape Verde.
CW: The country code for Curaçao.
CY: The country code for Cyprus.
CZ: The country code for the Czech Republic.
DE: The country code for Germany.
DJ: The country code for Djibouti.
DK: The country code for Denmark.
DM: The country code for Dominica.
DO: The country code for the Dominican Republic.
DZ: The country code for Algeria.
EC: The country code for Ecuador.
EE: The country code for Estonia.
EG: The country code for Egypt.
ER: The country code for Eritrea.
ES: The country code for Spain.
ET: The country code for Ethiopia.
FI: The country code for Finland.
FJ: The country code for Fiji.
FK: The country code for the Falkland Islands.
FM: The country code for Micronesia.
FO: The country code for the Faroe Islands.
FR: The country code for France.
GA: The country code for Gabon.
GB: The country code for the United Kingdom of Great Britain.
GD: The country code for Grenada.
GE: The country code for Georgia.
GF: The country code for French Guiana.
GG: The country code for Guernsey.
GH: The country code for Ghana.
GI: The country code for Gibraltar.
GL: The country code for Greenland.
GM: The country code for the Gambia.
GN: The country code for Guinea.
GP: The country code for Guadeloupe.
GQ: The country code for Equatorial Guinea.
GR: The country code for Greece.
GT: The country code for Guatemala.
GU: The country code for Guam.
GW: The country code for Guinea-Bissau.
GY: The country code for Guyana.
HK: The country code for Hong Kong.
HN: The country code for Honduras.
HR: The country code for Croatia.
HT: The country code for Haiti.
HU: The country code for Hungary.
ID: The country code for Indonesia.
IE: The country code for Ireland.
IL: The country code for Israel.
IM: The country code for the Isle of Man.
IN: The country code for India.
IO: The country code for the British Indian Ocean Territory.
IQ: The country code for Iraq.
IR: The country code for Iran.
IS: The country code for Iceland.
IT: The country code for Italy.
JE: The country code for Jersey.
JM: The country code for Jamaica.
JO: The country code for Jordan.
JP: The country code for Japan.
KE: The country code for Kenya.
KG: The country code for Kyrgyzstan.
KH: The country code for Cambodia.
KI: The country code for Kiribati.
KM: The country code for Comoros.
KN: The country code for Saint Kitts and Nevis.
KP: The country code for North Korea.
KR: The country code for South Korea.
KW: The country code for Kuwait.
KY: The country code for the Cayman Islands.
KZ: The country code for Kazakhstan.
LA: The country code for Laos.
LB: The country code for Lebanon.
LC: The country code for Saint Lucia.
LI: The country code for Liechtenstein.
LK: The country code for Sri Lanka.
LR: The country code for Liberia.
LS: The country code for Lesotho.
LT: The country code for Lithuania.
LU: The country code for Luxembourg.
LV: The country code for Latvia.
LY: The country code for Libya.
MA: The country code for Morocco.
MC: The country code for Monaco.
MD: The country code for Moldova.
ME: The country code for Montenegro.
MG: The country code for Madagascar.
MH: The country code for the Marshall Islands.
MK: The country code for North Macedonia.
ML: The country code for Mali.
MM: The country code for Myanmar.
MN: The country code for Mongolia.
MO: The country code for Macao.
MP: The country code for the Northern Mariana Islands.
MQ: The country code for Martinique.
MR: The country code for Mauritania.
MS: The country code for Montserrat.
MT: The country code for Malta.
MU: The country code for Mauritius.
MV: The country code for the Maldives.
MW: The country code for Malawi.
MX: The country code for Mexico.
MY: The country code for Malaysia.
MZ: The country code for Mozambique.
NA: The country code for Namibia.
NC: The country code for New Caledonia.
NE: The country code for Niger.
NF: The country code for Norfolk Island.
NG: The country code for Nigeria.
NI: The country code for Nicaragua.
NL: The country code for the Netherlands.
'NO': The country code for Norway.
NP: The country code for Nepal.
NR: The country code for Nauru.
NU: The country code for Niue.
NZ: The country code for New Zealand.
OM: The country code for Oman.
PA: The country code for Panama.
PE: The country code for Peru.
PF: The country code for French Polynesia.
PG: The country code for Papua New Guinea.
PH: The country code for the Philippines.
PK: The country code for Pakistan.
PL: The country code for Poland.
PM: The country code for Saint Pierre and Miquelon.
PR: The country code for Puerto Rico.
PS: The country code for Palestine.
PT: The country code for Portugal.
PW: The country code for Palau.
PY: The country code for Paraguay.
QA: The country code for Qatar.
RE: The country code for Réunion.
RO: The country code for Romania.
RS: The country code for Serbia.
RU: The country code for Russia.
RW: The country code for Rwanda.
SA: The country code for Saudi Arabia.
SB: The country code for the Solomon Islands.
SC: The country code for Seychelles.
SD: The country code for Sudan.
SE: The country code for Sweden.
SG: The country code for Singapore.
SH: The country code for Saint Helena.
SI: The country code for Slovenia.
SK: The country code for Slovakia.
SL: The country code for Sierra Leone.
SM: The country code for San Marino.
SN: The country code for Senegal.
SO: The country code for Somalia.
SR: The country code for Suriname.
SS: The country code for South Sudan.
ST: The country code for São Tomé and Príncipe.
SV: The country code for El Salvador.
SX: The country code for Sint Maarten.
SY: The country code for Syria.
SZ: The country code for Eswatini.
TC: The country code for the Turks and Caicos Islands.
TD: The country code for Chad.
TG: The country code for Togo.
TH: The country code for Thailand.
TJ: The country code for Tajikistan.
TK: The country code for Tokelau.
TL: The country code for East Timor.
TM: The country code for Turkmenistan.
TN: The country code for Tunisia.
TO: The country code for Tonga.
TR: The country code for Turkey.
TT: The country code for Trinidad and Tobago.
TV: The country code for Tuvalu.
TW: The country code for Taiwan.
TZ: The country code for Tanzania.
UA: The country code for Ukraine.
UG: The country code for Uganda.
UM: The country code for the United States Minor Outlying Islands.
UY: The country code for Uruguay.
UZ: The country code for Uzbekistan.
VC: The country code for Saint Vincent and the Grenadines.
VE: The country code for Venezuela.
VG: The country code for the British Virgin Islands.
VI: The country code for the United States Virgin Islands.
VN: The country code for Vietnam.
VU: The country code for Vanuatu.
WF: The country code for Wallis and Futuna.
WS: The country code for Samoa.
XK: The country code for Kosovo.
YE: The country code for Yemen.
YT: The country code for Mayotte.
ZA: The country code for South Africa.
ZM: The country code for Zambia.
ZW: The country code for Zimbabwe.
description: Country of the company's tax registration for non-US taxId. This value controls conditional validation for taxId and addressState. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsInputCountryCodesNonUsEnum'
taxId:
type: string
description: Tax registration identifier associated with the provided legal company name for non-US taxIdCountry. Validated as a generic string up to 25 characters. Not required for create, but required for launch.
minLength: 1
maxLength: 25
uniqueItems: false
description: 'Documentation schema for US brand campaign answers: taxIdCountry!=US, ownershipType=PRIVATE.'
required:
- companyLegalName
- companyPhoneNumber
- companyEmailAddress
- brandName
- brandIndustry
- addressLine
- addressCity
- addressCountry
- addressPostalCode
- websiteUrl
- contactFirstName
- contactSurname
- sampleMessages
- messagesVolume
- embeddedLink
- embeddedPhone
- ageGatedContent
- directLending
- optInConfirmationMessage
- helpMessage
- callToActionMessage
- ownershipType
- legalForm
- taxIdCountry
- taxId
RcsSenderDetailsQuestionnaireVerificationInputDto:
type: object
properties:
answers:
oneOf:
- $ref: '#/components/schemas/RcsUsSenderDetailsQuestionnaireVerificationAnswersInputDto'
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireVerificationAnswersInputDto'
description: Verification answers. Senders using the US country questionnaire version v2 must also provide phone on launch, all other senders only provide name, email and website.
uniqueItems: false
required:
- answers
RcsSenderSortColumnsEnum:
type: string
enum:
- CREATED
- MODIFIED
- NAME
- STATE
RcsSenderDetailsQuestionnaireGeneralAnswersInputDto:
type: object
properties:
optInDescription:
type: string
minLength: 1
description: How you obtain opt-in to message users.
uniqueItems: false
optInDescriptionMetadata:
description: Metadata for specified answer.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireAnswerMetadataInputDto'
triggerDescription:
type: string
minLength: 1
description: Actions that triggers messages to users.
uniqueItems: false
triggerDescriptionMetadata:
description: Metadata for specified answer.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireAnswerMetadataInputDto'
interactionsDescription:
type: string
minLength: 1
description: Interactions with users.
uniqueItems: false
interactionsDescriptionMetadata:
description: Metadata for specified answer.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireAnswerMetadataInputDto'
optOutDescription:
type: string
minLength: 1
description: The message the sender sends when a user opts out.
uniqueItems: false
optOutDescriptionMetadata:
description: Metadata for specified answer.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireAnswerMetadataInputDto'
videoUris:
minItems: 1
description: Publicly available URIs for videos of the sender, for review purposes only.
uniqueItems: false
type: array
items:
type: string
format: url
screenshotUris:
minItems: 1
description: Publicly available URIs for screenshots of the sender, for review purposes only.
uniqueItems: false
type: array
items:
type: string
format: url
RcsTestNumberCapabilitiesDto:
type: object
properties:
features:
type: array
x-enumDescriptions:
ACTION_COMPOSE: Indicates capability to handle client-side text or message composition triggers.
ACTION_CREATE_CALENDAR_EVENT: Indicates capability to inject localized calendar entry payloads directly into the host device calendar.
ACTION_DIAL: Indicates capability to execute native phone application routing and dialer triggers.
ACTION_OPEN_URL: Indicates capability to route out of the messaging application and open hyperlinks inside the native mobile browser.
ACTION_OPEN_URL_IN_WEBVIEW: Indicates capability to render deep links securely within an internal sandboxed application webview.
ACTION_SHARE_LOCATION: Indicates capability to fetch and transmission coordinate attributes via native geolocational workflows.
ACTION_VIEW_LOCATION: Indicates capability to map coordinates and launch map interfaces natively on the device UI.
REVOCATION: Indicates capability to execute message deletion or recall commands on the target recipient device.
RICHCARD_CAROUSEL: Indicates capability to display interactive multi-card rich layouts with horizontal scrolling loops.
RICHCARD_STANDALONE: Indicates capability to process standalone single-frame rich multimedia cards containing active chips.
FEATURE_UNSPECIFIED: The structural feature and interface capability profile remains unspecified.
UNRECOGNIZED: The value returned by an upstream system is not recognized by this API version.
description: List of RBM features that this device supports.
uniqueItems: false
items:
$ref: '#/components/schemas/RcsTestNumberCapabilitiesFeaturesEnum'
required:
- features
RcsDefaultSenderDetailsQuestionnaireUSQuestionsDto:
type: object
properties:
ownershipType:
readOnly: true
description: Ownership type of the company. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
companyLegalName:
readOnly: true
description: The registered legal name of the company. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
companyPhoneNumber:
readOnly: true
description: The registered phone number of the company. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
companyEmailAddress:
readOnly: true
description: The email address of the company. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
brandName:
readOnly: true
description: Brand name or Doing Business As (DBA). Must be legally associated with the provided legal company name. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
brandIndustry:
readOnly: true
description: Sector or industry of business. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
legalForm:
readOnly: true
description: Legal form of the company.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
taxIdCountry:
readOnly: true
description: Country of the company's tax registration.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
taxId:
readOnly: true
description: Tax registration identifier associated with the provided legal company name.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
addressLine:
readOnly: true
description: Street address line. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
addressCity:
readOnly: true
description: City. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
addressCountry:
readOnly: true
description: Country. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
addressState:
readOnly: true
description: State (US only). Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
addressPostalCode:
readOnly: true
description: Postal code. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
websiteUrl:
readOnly: true
description: Primary website URL. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
contactFirstName:
readOnly: true
description: First name of the responsible contact person. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
contactSurname:
readOnly: true
description: Surname of the responsible contact person. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
stockExchange:
readOnly: true
description: Primary home country stock exchange abbreviation. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
stockSymbol:
readOnly: true
description: Primary home country stock symbol associated with stock exchange. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
sampleMessages:
readOnly: true
description: Sample messages for each use case or message type sent by the brand. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
messagesVolume:
readOnly: true
description: Messages volume. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
embeddedLink:
readOnly: true
description: Flag indicating if URL links will be embedded within message payloads. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
embeddedPhone:
readOnly: true
description: Flag indicating if phone numbers will be embedded within message payloads. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
ageGatedContent:
readOnly: true
description: Indicates if the campaign content is restricted by age (e.g., alcohol, tobacco). Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
directLending:
readOnly: true
description: Indicates if the campaign involves direct financial lending, requiring stricter compliance. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
optInConfirmationMessage:
readOnly: true
description: Opt-in confirmation message sent to users. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
helpMessage:
readOnly: true
description: Help message of the campaign. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
callToActionMessage:
readOnly: true
description: Call to action message of the campaign. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
ein:
readOnly: true
description: Employer Identification Number (EIN).
deprecated: true
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
fullCompanyAddress:
readOnly: true
description: Full company address.
deprecated: true
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
smsCampaign:
readOnly: true
description: US SMS campaign used as fallback.
deprecated: true
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
required:
- ownershipType
- companyLegalName
- companyPhoneNumber
- companyEmailAddress
- brandName
- brandIndustry
- legalForm
- taxIdCountry
- taxId
- addressLine
- addressCity
- addressCountry
- addressState
- addressPostalCode
- websiteUrl
- contactFirstName
- contactSurname
- stockExchange
- stockSymbol
- sampleMessages
- messagesVolume
- embeddedLink
- embeddedPhone
- ageGatedContent
- directLending
- optInConfirmationMessage
- helpMessage
- callToActionMessage
- ein
- fullCompanyAddress
- smsCampaign
RcsUsQuestionnaireOwnershipTypeEnum:
type: string
enum:
- PRIVATE
- PUBLIC
description: Ownership type of the company. Not required for create, but required for launch.
RcsPublicUsQuestionnaireBrandLegalFormsEnum:
type: string
const: CORPORATION
description: Legal form of the company for public ownership type. Not required for create, but required for launch.
RcsSenderListDto:
type: object
properties:
totalSize:
type: number
description: Total size of the entries matching the search query.
uniqueItems: false
pageSize:
type: number
description: Requested size of the page.
uniqueItems: false
previousPageToken:
type: string
description: Encoded token to use in list request to fetch previous batch of entries.
uniqueItems: false
nextPageToken:
type: string
description: Encoded token to use in list request to fetch next batch of entries.
uniqueItems: false
senders:
type: array
items:
$ref: '#/components/schemas/RcsSenderDto'
description: List of senders.
uniqueItems: false
required:
- totalSize
- pageSize
- senders
RcsTestNumberCapabilitiesFeaturesEnum:
type: string
enum:
- ACTION_COMPOSE
- ACTION_CREATE_CALENDAR_EVENT
- ACTION_DIAL
- ACTION_OPEN_URL
- ACTION_OPEN_URL_IN_WEBVIEW
- ACTION_SHARE_LOCATION
- ACTION_VIEW_LOCATION
- REVOCATION
- RICHCARD_CAROUSEL
- RICHCARD_STANDALONE
- FEATURE_UNSPECIFIED
- UNRECOGNIZED
description: List of RBM features that this device supports.
RcsCommentDto:
type: object
properties:
type:
x-enumDescriptions:
CREATED: Indicates the comment has been successfully created and published.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsCommentTypeEnum'
comment:
type: string
uniqueItems: false
created:
type: string
uniqueItems: false
required:
- type
- comment
RcsSenderBillingCategoriesEnum:
type: string
enum:
- CONVERSATIONAL
- NON_CONVERSATIONAL
- BASIC_MESSAGE
- CONVERSATIONAL_LEGACY
- SINGLE_MESSAGE
description: 'Billing category.
Note:
The billing framework distinguishes between two primary categories: non-conversational and conversational.
The non-conversational category includes SINGLE_MESSAGE and BASIC_MESSAGE types which are considered functionally equivalent in the current revision.
The conversational category includes CONVERSATIONAL and CONVERSATIONAL_LEGACY types. Values BASIC_MESSAGE, SINGLE_MESSAGE and CONVERSATIONAL_LEGACY are deprecated and will be removed in a future version.
- CONVERSATIONAL: Designed for longer, more complex sessions where the user and brand exchange a series of messages.
- NON_CONVERSATIONAL: Represents a non-conversational billing category, which replaces the legacy SINGLE_MESSAGE and BASIC_MESSAGE categories. This is for agents that primarily engage in one-way (A2P) communication.
- BASIC_MESSAGE: Billing model is similar to SMS. Deprecated value, use NON_CONVERSATIONAL instead.
- CONVERSATIONAL_LEGACY: Legacy category to support the billing configuration of existing agents. Deprecated value, use CONVERSATIONAL instead.
- SINGLE_MESSAGE: Replaces SMS with a richer messaging experience. Deprecated value, use NON_CONVERSATIONAL instead.'
RcsSenderDto:
type: object
properties:
id:
type: string
description: The unique ID of the sender.
uniqueItems: false
conversationApiApp:
type: string
description: If set, the Conversation API App ID the sender is connected to.
deprecated: true
uniqueItems: false
conversationApiAppDetails:
description: If set, the details of the Conversation API App the sender is connected to.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsConversationApiAppDto'
state:
x-enumDescriptions:
DRAFT: The sender configuration is saved as a draft.
IN_PROGRESS: The sender registration or setup is currently in progress.
IN_TEST: The sender is currently undergoing testing.
LAUNCHED: The sender has been successfully launched.
LAUNCHING: The sender launch sequence is currently executing.
PREPARING_LAUNCH: The sender configuration is being prepared for launch.
UNLAUNCHED: The sender has been unlaunched and is disabled.
UNKNOWN: The current state of the sender cannot be determined.
description: The current state of the sender.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderStatesEnum'
testNumberStates:
type: array
items:
$ref: '#/components/schemas/RcsTestNumberStateDto'
description: Test phone numbers states.
uniqueItems: false
countryStatus:
type: array
items:
$ref: '#/components/schemas/RcsCountryStatusDto'
description: Countries status.
uniqueItems: false
details:
description: Sender details and information.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsDto'
region:
x-enumDescriptions:
BR: The sender is operating within the Brazil region.
EU: The sender is operating within the Europe region.
US: The sender is operating within the United States region.
description: Region sender is provisioned in.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderRegionsEnum'
billingCategory:
x-enumDescriptions:
CONVERSATIONAL: Billing category for conversational messages.
NON_CONVERSATIONAL: Billing category for non-conversational messages.
BASIC_MESSAGE: Billing category for basic messages.
CONVERSATIONAL_LEGACY: Legacy billing category for conversational messages.
SINGLE_MESSAGE: Billing category for single messages.
description: 'Billing category.
Note:
The billing framework distinguishes between two primary categories: non-conversational and conversational.
The non-conversational category includes SINGLE_MESSAGE and BASIC_MESSAGE types which are considered functionally equivalent in the current revision.
The conversational category includes CONVERSATIONAL and CONVERSATIONAL_LEGACY types. Values BASIC_MESSAGE, SINGLE_MESSAGE and CONVERSATIONAL_LEGACY are deprecated and will be removed in a future version.
- CONVERSATIONAL: Designed for longer, more complex sessions where the user and brand exchange a series of messages.
- NON_CONVERSATIONAL: Represents a non-conversational billing category, which replaces the legacy SINGLE_MESSAGE and BASIC_MESSAGE categories. This is for agents that primarily engage in one-way (A2P) communication.
- BASIC_MESSAGE: Billing model is similar to SMS. Deprecated value, use NON_CONVERSATIONAL instead.
- CONVERSATIONAL_LEGACY: Legacy category to support the billing configuration of existing agents. Deprecated value, use CONVERSATIONAL instead.
- SINGLE_MESSAGE: Replaces SMS with a richer messaging experience. Deprecated value, use NON_CONVERSATIONAL instead.'
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderBillingCategoriesEnum'
useCase:
x-enumDescriptions:
MULTIUSE: The sender is configured for multiple types of use cases.
OTP: The sender is used exclusively for one-time passwords.
PROMOTIONAL: The sender is used for marketing and promotional content.
TRANSACTIONAL: The sender is used for functional or transactional communications.
description: Use case.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderUseCasesEnum'
hostingRegion:
x-enumDescriptions:
ASIA_PACIFIC: The sender is hosted within the Asia-Pacific region.
EUROPE: The sender is hosted within the Europe region.
NORTH_AMERICA: The sender is hosted within the North America region.
description: Internal Google hosting region
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderHostingRegionsEnum'
authName:
type: string
description: The name is needed to connect the sender to a Conversation API App.
uniqueItems: false
authToken:
type: string
description: The token is needed to connect the sender to a Conversation API App.
uniqueItems: false
created:
type: string
description: The UTC Date Time in ISO 8601 for when the sender was created.
uniqueItems: false
modified:
type: string
description: The UTC Date Time in ISO 8601 for when the sender was last modified.
uniqueItems: false
supplierDetails:
description: Supplier details.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSupplierDetailsDto'
launched:
type: string
description: The UTC Date Time in ISO 8601 for when the sender was last launched.
uniqueItems: false
brandDetails:
description: Brand registration details.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsBrandRegistrationDto'
campaignDetails:
description: Campaign registration details.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsCampaignRegistrationDto'
required:
- id
- region
- billingCategory
- useCase
- hostingRegion
RcsUsStatesEnum:
type: string
enum:
- AK
- AL
- AR
- AS
- AZ
- CA
- CO
- CT
- DC
- DE
- FL
- GA
- GU
- HI
- IA
- ID
- IL
- IN
- KS
- KY
- LA
- MA
- MD
- ME
- MI
- MN
- MO
- MP
- MS
- MT
- NC
- ND
- NE
- NH
- NJ
- NM
- NV
- NY
- OH
- OK
- OR
- PA
- PR
- RI
- SC
- SD
- TN
- TX
- UT
- VA
- VI
- VT
- WA
- WI
- WV
- WY
description: State (US only). Not required for create, but required for launch.
RcsCampaignRegistrationDto:
type: object
properties:
id:
type: string
description: Unique identifier for the campaign registration (campaign hub).
uniqueItems: false
campaignName:
type: string
description: The user-assigned name of the campaign.
uniqueItems: false
requestId:
type: string
description: Unique request correlation/tracking identifier.
uniqueItems: false
required:
- id
- campaignName
- requestId
RcsUsQuestionnaireBrandLegalFormsEnum:
type: string
enum:
- CORPORATION
- LIMITED_LIABILITY_COMPANY
- PARTNERSHIP
- S_CORPORATION
description: Legal form of the company.
RcsSenderDetailsQuestionnaireVerificationPartnerQuestionsDto:
type: object
properties:
companyName:
readOnly: true
description: Company name of the brand partner.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
contactName:
readOnly: true
description: Name of the contact person of the brand partner.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
contactEmailAddress:
readOnly: true
description: Email of the contact person of the brand partner.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
required:
- companyName
- contactName
- contactEmailAddress
RcsConversationApiAppRegionsEnum:
type: string
enum:
- BR
- EU
- US
- UNRECOGNIZED
description: App region.
RcsUsPrivateBrandCampaignSenderDetailsQuestionnaireUSAnswersInputDto:
type: object
properties:
companyLegalName:
type: string
description: The registered legal name of the company. Not required for create, but required for launch.
minLength: 1
maxLength: 100
uniqueItems: false
companyPhoneNumber:
type: string
description: The registered phone number of the company. Not required for create, but required for launch.
minLength: 1
maxLength: 13
uniqueItems: false
companyEmailAddress:
type: string
format: email
maxLength: 100
uniqueItems: false
brandName:
type: string
description: Brand name or Doing Business As (DBA). Must be legally associated with the provided legal company name. Not required for create, but required for launch.
minLength: 1
maxLength: 100
uniqueItems: false
brandIndustry:
x-enumDescriptions:
AGRICULTURE: The brand operates within the agriculture sector.
COMMUNICATION: The brand operates within the communication industry.
CONSTRUCTION: The brand operates within the construction sector.
EDUCATION: The brand operates within the education field.
ENERGY: The brand operates within the energy and utilities sector.
ENTERTAINMENT: The brand operates within the entertainment and media industry.
FINANCIAL: The brand operates within the financial services sector.
GAMBLING: The brand operates within the gambling or betting industry.
GOVERNMENT: The brand is a government or public administration entity.
HEALTHCARE: The brand operates within the healthcare and medical sector.
HOSPITALITY: The brand operates within hospitality, tourism, or food services.
HUMAN_RESOURCES: The brand operates within human resources and staffing services.
INSURANCE: The brand operates within the insurance sector.
LEGAL: The brand operates within legal services.
MANUFACTURING: The brand operates within the manufacturing sector.
NON_GOVERNMENTAL_ORGANIZATION: The brand is a non-governmental organization (NGO).
POLITICAL: The brand is a political organization or campaign.
POSTAL: The brand operates within postal, courier, or delivery services.
PROFESSIONAL: The brand provides professional, scientific, or technical services.
REAL_ESTATE: The brand operates within the real estate market.
RETAIL: The brand operates within retail or wholesale commerce.
TECHNOLOGY: The brand operates within the technology and software sector.
TRANSPORTATION: The brand operates within transportation or logistics services.
description: Sector or industry of business. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsUsQuestionnaireBrandIndustriesEnum'
addressLine:
type: string
description: Street address line. Not required for create, but required for launch.
minLength: 1
maxLength: 100
uniqueItems: false
addressCity:
type: string
description: City. Not required for create, but required for launch.
minLength: 1
maxLength: 100
uniqueItems: false
addressCountry:
x-enumDescriptions:
AD: The country code for Andorra.
AE: The country code for the United Arab Emirates.
AF: The country code for Afghanistan.
AG: The country code for Antigua and Barbuda.
AI: The country code for Anguilla.
AL: The country code for Albania.
AM: The country code for Armenia.
AO: The country code for Angola.
AR: The country code for Argentina.
AS: The country code for American Samoa.
AT: The country code for Austria.
AU: The country code for Australia.
AW: The country code for Aruba.
AZ: The country code for Azerbaijan.
BA: The country code for Bosnia and Herzegovina.
BB: The country code for Barbados.
BD: The country code for Bangladesh.
BE: The country code for Belgium.
BF: The country code for Burkina Faso.
BG: The country code for Bulgaria.
BH: The country code for Bahrain.
BI: The country code for Burundi.
BJ: The country code for Benin.
BM: The country code for Bermuda.
BN: The country code for Brunei.
BO: The country code for Bolivia.
BQ: The country code for Bonaire.
BR: The country code for Brazil.
BS: The country code for the Bahamas.
BT: The country code for Bhutan.
BW: The country code for Botswana.
BY: The country code for Belarus.
BZ: The country code for Belize.
CA: The country code for Canada.
CD: The country code for the Democratic Republic of the Congo.
CF: The country code for the Central African Republic.
CG: The country code for the Republic of the Congo.
CH: The country code for Switzerland.
CI: The country code for the Ivory Coast.
CK: The country code for the Cook Islands.
CL: The country code for Chile.
CM: The country code for Cameroon.
CN: The country code for China.
CO: The country code for Colombia.
CR: The country code for Costa Rica.
CU: The country code for Cuba.
CV: The country code for Cape Verde.
CW: The country code for Curaçao.
CY: The country code for Cyprus.
CZ: The country code for the Czech Republic.
DE: The country code for Germany.
DJ: The country code for Djibouti.
DK: The country code for Denmark.
DM: The country code for Dominica.
DO: The country code for the Dominican Republic.
DZ: The country code for Algeria.
EC: The country code for Ecuador.
EE: The country code for Estonia.
EG: The country code for Egypt.
ER: The country code for Eritrea.
ES: The country code for Spain.
ET: The country code for Ethiopia.
FI: The country code for Finland.
FJ: The country code for Fiji.
FK: The country code for the Falkland Islands.
FM: The country code for Micronesia.
FO: The country code for the Faroe Islands.
FR: The country code for France.
GA: The country code for Gabon.
GB: The country code for the United Kingdom of Great Britain.
GD: The country code for Grenada.
GE: The country code for Georgia.
GF: The country code for French Guiana.
GG: The country code for Guernsey.
GH: The country code for Ghana.
GI: The country code for Gibraltar.
GL: The country code for Greenland.
GM: The country code for the Gambia.
GN: The country code for Guinea.
GP: The country code for Guadeloupe.
GQ: The country code for Equatorial Guinea.
GR: The country code for Greece.
GT: The country code for Guatemala.
GU: The country code for Guam.
GW: The country code for Guinea-Bissau.
GY: The country code for Guyana.
HK: The country code for Hong Kong.
HN: The country code for Honduras.
HR: The country code for Croatia.
HT: The country code for Haiti.
HU: The country code for Hungary.
ID: The country code for Indonesia.
IE: The country code for Ireland.
IL: The country code for Israel.
IM: The country code for the Isle of Man.
IN: The country code for India.
IO: The country code for the British Indian Ocean Territory.
IQ: The country code for Iraq.
IR: The country code for Iran.
IS: The country code for Iceland.
IT: The country code for Italy.
JE: The country code for Jersey.
JM: The country code for Jamaica.
JO: The country code for Jordan.
JP: The country code for Japan.
KE: The country code for Kenya.
KG: The country code for Kyrgyzstan.
KH: The country code for Cambodia.
KI: The country code for Kiribati.
KM: The country code for Comoros.
KN: The country code for Saint Kitts and Nevis.
KP: The country code for North Korea.
KR: The country code for South Korea.
KW: The country code for Kuwait.
KY: The country code for the Cayman Islands.
KZ: The country code for Kazakhstan.
LA: The country code for Laos.
LB: The country code for Lebanon.
LC: The country code for Saint Lucia.
LI: The country code for Liechtenstein.
LK: The country code for Sri Lanka.
LR: The country code for Liberia.
LS: The country code for Lesotho.
LT: The country code for Lithuania.
LU: The country code for Luxembourg.
LV: The country code for Latvia.
LY: The country code for Libya.
MA: The country code for Morocco.
MC: The country code for Monaco.
MD: The country code for Moldova.
ME: The country code for Montenegro.
MG: The country code for Madagascar.
MH: The country code for the Marshall Islands.
MK: The country code for North Macedonia.
ML: The country code for Mali.
MM: The country code for Myanmar.
MN: The country code for Mongolia.
MO: The country code for Macao.
MP: The country code for the Northern Mariana Islands.
MQ: The country code for Martinique.
MR: The country code for Mauritania.
MS: The country code for Montserrat.
MT: The country code for Malta.
MU: The country code for Mauritius.
MV: The country code for the Maldives.
MW: The country code for Malawi.
MX: The country code for Mexico.
MY: The country code for Malaysia.
MZ: The country code for Mozambique.
NA: The country code for Namibia.
NC: The country code for New Caledonia.
NE: The country code for Niger.
NF: The country code for Norfolk Island.
NG: The country code for Nigeria.
NI: The country code for Nicaragua.
NL: The country code for the Netherlands.
'NO': The country code for Norway.
NP: The country code for Nepal.
NR: The country code for Nauru.
NU: The country code for Niue.
NZ: The country code for New Zealand.
OM: The country code for Oman.
PA: The country code for Panama.
PE: The country code for Peru.
PF: The country code for French Polynesia.
PG: The country code for Papua New Guinea.
PH: The country code for the Philippines.
PK: The country code for Pakistan.
PL: The country code for Poland.
PM: The country code for Saint Pierre and Miquelon.
PR: The country code for Puerto Rico.
PS: The country code for Palestine.
PT: The country code for Portugal.
PW: The country code for Palau.
PY: The country code for Paraguay.
QA: The country code for Qatar.
RE: The country code for Réunion.
RO: The country code for Romania.
RS: The country code for Serbia.
RU: The country code for Russia.
RW: The country code for Rwanda.
SA: The country code for Saudi Arabia.
SB: The country code for the Solomon Islands.
SC: The country code for Seychelles.
SD: The country code for Sudan.
SE: The country code for Sweden.
SG: The country code for Singapore.
SH: The country code for Saint Helena.
SI: The country code for Slovenia.
SK: The country code for Slovakia.
SL: The country code for Sierra Leone.
SM: The country code for San Marino.
SN: The country code for Senegal.
SO: The country code for Somalia.
SR: The country code for Suriname.
SS: The country code for South Sudan.
ST: The country code for São Tomé and Príncipe.
SV: The country code for El Salvador.
SX: The country code for Sint Maarten.
SY: The country code for Syria.
SZ: The country code for Eswatini.
TC: The country code for the Turks and Caicos Islands.
TD: The country code for Chad.
TG: The country code for Togo.
TH: The country code for Thailand.
TJ: The country code for Tajikistan.
TK: The country code for Tokelau.
TL: The country code for East Timor.
TM: The country code for Turkmenistan.
TN: The country code for Tunisia.
TO: The country code for Tonga.
TR: The country code for Turkey.
TT: The country code for Trinidad and Tobago.
TV: The country code for Tuvalu.
TW: The country code for Taiwan.
TZ: The country code for Tanzania.
UA: The country code for Ukraine.
UG: The country code for Uganda.
UM: The country code for the United States Minor Outlying Islands.
US: The country code for the United States of America.
UY: The country code for Uruguay.
UZ: The country code for Uzbekistan.
VC: The country code for Saint Vincent and the Grenadines.
VE: The country code for Venezuela.
VG: The country code for the British Virgin Islands.
VI: The country code for the United States Virgin Islands.
VN: The country code for Vietnam.
VU: The country code for Vanuatu.
WF: The country code for Wallis and Futuna.
WS: The country code for Samoa.
XK: The country code for Kosovo.
YE: The country code for Yemen.
YT: The country code for Mayotte.
ZA: The country code for South Africa.
ZM: The country code for Zambia.
ZW: The country code for Zimbabwe.
description: Country. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsInputCountryCodesEnum'
addressPostalCode:
type: string
description: Postal code. Not required for create, but required for launch.
minLength: 1
maxLength: 10
uniqueItems: false
websiteUrl:
type: string
description: Primary website URL. Not required for create, but required for launch.
format: url
maxLength: 100
uniqueItems: false
contactFirstName:
type: string
description: First name of the responsible contact person. Not required for create, but required for launch.
minLength: 1
maxLength: 100
uniqueItems: false
contactSurname:
type: string
description: Surname of the responsible contact person. Not required for create, but required for launch.
minLength: 1
maxLength: 100
uniqueItems: false
sampleMessages:
description: Sample messages for each use case or message type sent by the brand. Not required for create, but required for launch.
minItems: 1
maxItems: 5
uniqueItems: false
type: array
items:
type: string
maxLength: 1024
minLength: 20
messagesVolume:
type: number
description: Messages volume. Not required for create, but required for launch.
uniqueItems: false
embeddedLink:
type: boolean
description: Flag indicating if URL links will be embedded within message payloads. Not required for create, but required for launch.
uniqueItems: false
embeddedPhone:
type: boolean
description: Flag indicating if phone numbers will be embedded within message payloads. Not required for create, but required for launch.
uniqueItems: false
ageGatedContent:
type: boolean
description: Indicates if the campaign content is restricted by age (e.g., alcohol, tobacco). Not required for create, but required for launch.
uniqueItems: false
directLending:
type: boolean
description: Indicates if the campaign involves direct financial lending, requiring stricter compliance. Not required for create, but required for launch.
uniqueItems: false
optInConfirmationMessage:
type: string
description: Opt-in confirmation message sent to users. Not required for create, but required for launch.
minLength: 20
maxLength: 1024
uniqueItems: false
helpMessage:
type: string
description: Help message of the campaign. Not required for create, but required for launch.
minLength: 20
maxLength: 1024
uniqueItems: false
callToActionMessage:
type: string
description: Call to action message of the campaign. Not required for create, but required for launch.
minLength: 40
maxLength: 4096
uniqueItems: false
ownershipType:
x-enumDescriptions:
PRIVATE: The brand is a privately owned entity.
description: Ownership type of the company. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsUsQuestionnaireOwnershipTypePrivateEnum'
legalForm:
x-enumDescriptions:
CORPORATION: The company is registered as a Corporation.
LIMITED_LIABILITY_COMPANY: The company is registered as a Limited Liability Company (LLC).
PARTNERSHIP: The company is registered as a Partnership.
S_CORPORATION: The company is registered as an S Corporation.
description: Legal form of the company for private ownership type. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsPrivateUsQuestionnaireBrandLegalFormsEnum'
taxIdCountry:
x-enumDescriptions:
US: The country code for the United States of America.
description: Country of the company's tax registration for US taxId. This value controls conditional validation for taxId and addressState. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsInputCountryCodesUsEnum'
taxId:
type: string
description: 'Tax registration identifier associated with the provided legal company name for US taxIdCountry. Must follow format XX-XXXXXXX (example: 12-3456789). Not required for create, but required for launch.'
minLength: 1
maxLength: 25
uniqueItems: false
addressState:
x-enumDescriptions:
AK: The State of Alaska.
AL: The State of Alabama.
AR: The State of Arkansas.
AS: The US territory of American Samoa.
AZ: The State of Arizona.
CA: The State of California.
CO: The State of Colorado.
CT: The State of Connecticut.
DC: The District of Columbia.
DE: The State of Delaware.
FL: The State of Florida.
GA: The State of Georgia.
GU: The US territory of Guam.
HI: The State of Hawaii.
IA: The State of Iowa.
ID: The State of Idaho.
IL: The State of Illinois.
IN: The State of Indiana.
KS: The State of Kansas.
KY: The Commonwealth of Kentucky.
LA: The State of Louisiana.
MA: The Commonwealth of Massachusetts.
MD: The State of Maryland.
ME: The State of Maine.
MI: The State of Michigan.
MN: The State of Minnesota.
MO: The State of Missouri.
MP: The US Commonwealth of the Northern Mariana Islands.
MS: The State of Mississippi.
MT: The State of Montana.
NC: The State of North Carolina.
ND: The State of North Dakota.
NE: The State of Nebraska.
NH: The State of New Hampshire.
NJ: The State of New Jersey.
NM: The State of New Mexico.
NV: The State of Nevada.
NY: The State of New York.
OH: The State of Ohio.
OK: The State of Oklahoma.
OR: The State of Oregon.
PA: The Commonwealth of Pennsylvania.
PR: The US territory of Puerto Rico.
RI: The State of Rhode Island.
SC: The State of South Carolina.
SD: The State of South Dakota.
TN: The State of Tennessee.
TX: The State of Texas.
UT: The State of Utah.
VA: The Commonwealth of Virginia.
VI: The US territory of the Virgin Islands.
VT: The State of Vermont.
WA: The State of Washington.
WI: The State of Wisconsin.
WV: The State of West Virginia.
WY: The State of Wyoming.
description: State (US only). Validated when taxIdCountry=US and ignored for non-US taxIdCountry.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsUsStatesEnum'
description: 'Documentation schema for US brand campaign answers: taxIdCountry=US, ownershipType=PRIVATE.'
required:
- companyLegalName
- companyPhoneNumber
- companyEmailAddress
- brandName
- brandIndustry
- addressLine
- addressCity
- addressCountry
- addressPostalCode
- websiteUrl
- contactFirstName
- contactSurname
- sampleMessages
- messagesVolume
- embeddedLink
- embeddedPhone
- ageGatedContent
- directLending
- optInConfirmationMessage
- helpMessage
- callToActionMessage
- ownershipType
- legalForm
- taxIdCountry
- taxId
- addressState
RcsBrandCampaignUpdateSenderDetailsQuestionnaireUSAnswersInputDto:
type: object
properties:
ownershipType:
x-enumDescriptions:
PRIVATE: The brand is a privately owned entity.
PUBLIC: The brand is a publicly traded company.
description: Ownership type of the company. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsUsQuestionnaireOwnershipTypeEnum'
companyLegalName:
type:
- string
- 'null'
description: The registered legal name of the company. Not required for create, but required for launch.
minLength: 1
maxLength: 100
uniqueItems: false
companyPhoneNumber:
type:
- string
- 'null'
description: The registered phone number of the company. Not required for create, but required for launch.
minLength: 1
maxLength: 13
uniqueItems: false
companyEmailAddress:
type:
- string
- 'null'
format: email
maxLength: 100
uniqueItems: false
brandName:
type:
- string
- 'null'
description: Brand name or Doing Business As (DBA). Must be legally associated with the provided legal company name. Not required for create, but required for launch.
minLength: 1
maxLength: 100
uniqueItems: false
brandIndustry:
x-enumDescriptions:
AGRICULTURE: The brand operates within the agriculture sector.
COMMUNICATION: The brand operates within the communication industry.
CONSTRUCTION: The brand operates within the construction sector.
EDUCATION: The brand operates within the education field.
ENERGY: The brand operates within the energy and utilities sector.
ENTERTAINMENT: The brand operates within the entertainment and media industry.
FINANCIAL: The brand operates within the financial services sector.
GAMBLING: The brand operates within the gambling or betting industry.
GOVERNMENT: The brand is a government or public administration entity.
HEALTHCARE: The brand operates within the healthcare and medical sector.
HOSPITALITY: The brand operates within hospitality, tourism, or food services.
HUMAN_RESOURCES: The brand operates within human resources and staffing services.
INSURANCE: The brand operates within the insurance sector.
LEGAL: The brand operates within legal services.
MANUFACTURING: The brand operates within the manufacturing sector.
NON_GOVERNMENTAL_ORGANIZATION: The brand is a non-governmental organization (NGO).
POLITICAL: The brand is a political organization or campaign.
POSTAL: The brand operates within postal, courier, or delivery services.
PROFESSIONAL: The brand provides professional, scientific, or technical services.
REAL_ESTATE: The brand operates within the real estate market.
RETAIL: The brand operates within retail or wholesale commerce.
TECHNOLOGY: The brand operates within the technology and software sector.
TRANSPORTATION: The brand operates within transportation or logistics services.
description: Sector or industry of business. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsUsQuestionnaireBrandIndustriesEnum'
legalForm:
x-enumDescriptions:
CORPORATION: The company is registered as a Corporation.
LIMITED_LIABILITY_COMPANY: The company is registered as a Limited Liability Company (LLC).
PARTNERSHIP: The company is registered as a Partnership.
S_CORPORATION: The company is registered as an S Corporation.
description: Legal form of the company. For ownershipType=PUBLIC only CORPORATION is allowed. For ownershipType=PRIVATE allowed values are CORPORATION, LIMITED_LIABILITY_COMPANY, PARTNERSHIP, and S_CORPORATION. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsUsQuestionnaireBrandLegalFormsEnum'
taxIdCountry:
x-enumDescriptions:
AD: The country code for Andorra.
AE: The country code for the United Arab Emirates.
AF: The country code for Afghanistan.
AG: The country code for Antigua and Barbuda.
AI: The country code for Anguilla.
AL: The country code for Albania.
AM: The country code for Armenia.
AO: The country code for Angola.
AR: The country code for Argentina.
AS: The country code for American Samoa.
AT: The country code for Austria.
AU: The country code for Australia.
AW: The country code for Aruba.
AZ: The country code for Azerbaijan.
BA: The country code for Bosnia and Herzegovina.
BB: The country code for Barbados.
BD: The country code for Bangladesh.
BE: The country code for Belgium.
BF: The country code for Burkina Faso.
BG: The country code for Bulgaria.
BH: The country code for Bahrain.
BI: The country code for Burundi.
BJ: The country code for Benin.
BM: The country code for Bermuda.
BN: The country code for Brunei.
BO: The country code for Bolivia.
BQ: The country code for Bonaire.
BR: The country code for Brazil.
BS: The country code for the Bahamas.
BT: The country code for Bhutan.
BW: The country code for Botswana.
BY: The country code for Belarus.
BZ: The country code for Belize.
CA: The country code for Canada.
CD: The country code for the Democratic Republic of the Congo.
CF: The country code for the Central African Republic.
CG: The country code for the Republic of the Congo.
CH: The country code for Switzerland.
CI: The country code for the Ivory Coast.
CK: The country code for the Cook Islands.
CL: The country code for Chile.
CM: The country code for Cameroon.
CN: The country code for China.
CO: The country code for Colombia.
CR: The country code for Costa Rica.
CU: The country code for Cuba.
CV: The country code for Cape Verde.
CW: The country code for Curaçao.
CY: The country code for Cyprus.
CZ: The country code for the Czech Republic.
DE: The country code for Germany.
DJ: The country code for Djibouti.
DK: The country code for Denmark.
DM: The country code for Dominica.
DO: The country code for the Dominican Republic.
DZ: The country code for Algeria.
EC: The country code for Ecuador.
EE: The country code for Estonia.
EG: The country code for Egypt.
ER: The country code for Eritrea.
ES: The country code for Spain.
ET: The country code for Ethiopia.
FI: The country code for Finland.
FJ: The country code for Fiji.
FK: The country code for the Falkland Islands.
FM: The country code for Micronesia.
FO: The country code for the Faroe Islands.
FR: The country code for France.
GA: The country code for Gabon.
GB: The country code for the United Kingdom of Great Britain.
GD: The country code for Grenada.
GE: The country code for Georgia.
GF: The country code for French Guiana.
GG: The country code for Guernsey.
GH: The country code for Ghana.
GI: The country code for Gibraltar.
GL: The country code for Greenland.
GM: The country code for the Gambia.
GN: The country code for Guinea.
GP: The country code for Guadeloupe.
GQ: The country code for Equatorial Guinea.
GR: The country code for Greece.
GT: The country code for Guatemala.
GU: The country code for Guam.
GW: The country code for Guinea-Bissau.
GY: The country code for Guyana.
HK: The country code for Hong Kong.
HN: The country code for Honduras.
HR: The country code for Croatia.
HT: The country code for Haiti.
HU: The country code for Hungary.
ID: The country code for Indonesia.
IE: The country code for Ireland.
IL: The country code for Israel.
IM: The country code for the Isle of Man.
IN: The country code for India.
IO: The country code for the British Indian Ocean Territory.
IQ: The country code for Iraq.
IR: The country code for Iran.
IS: The country code for Iceland.
IT: The country code for Italy.
JE: The country code for Jersey.
JM: The country code for Jamaica.
JO: The country code for Jordan.
JP: The country code for Japan.
KE: The country code for Kenya.
KG: The country code for Kyrgyzstan.
KH: The country code for Cambodia.
KI: The country code for Kiribati.
KM: The country code for Comoros.
KN: The country code for Saint Kitts and Nevis.
KP: The country code for North Korea.
KR: The country code for South Korea.
KW: The country code for Kuwait.
KY: The country code for the Cayman Islands.
KZ: The country code for Kazakhstan.
LA: The country code for Laos.
LB: The country code for Lebanon.
LC: The country code for Saint Lucia.
LI: The country code for Liechtenstein.
LK: The country code for Sri Lanka.
LR: The country code for Liberia.
LS: The country code for Lesotho.
LT: The country code for Lithuania.
LU: The country code for Luxembourg.
LV: The country code for Latvia.
LY: The country code for Libya.
MA: The country code for Morocco.
MC: The country code for Monaco.
MD: The country code for Moldova.
ME: The country code for Montenegro.
MG: The country code for Madagascar.
MH: The country code for the Marshall Islands.
MK: The country code for North Macedonia.
ML: The country code for Mali.
MM: The country code for Myanmar.
MN: The country code for Mongolia.
MO: The country code for Macao.
MP: The country code for the Northern Mariana Islands.
MQ: The country code for Martinique.
MR: The country code for Mauritania.
MS: The country code for Montserrat.
MT: The country code for Malta.
MU: The country code for Mauritius.
MV: The country code for the Maldives.
MW: The country code for Malawi.
MX: The country code for Mexico.
MY: The country code for Malaysia.
MZ: The country code for Mozambique.
NA: The country code for Namibia.
NC: The country code for New Caledonia.
NE: The country code for Niger.
NF: The country code for Norfolk Island.
NG: The country code for Nigeria.
NI: The country code for Nicaragua.
NL: The country code for the Netherlands.
'NO': The country code for Norway.
NP: The country code for Nepal.
NR: The country code for Nauru.
NU: The country code for Niue.
NZ: The country code for New Zealand.
OM: The country code for Oman.
PA: The country code for Panama.
PE: The country code for Peru.
PF: The country code for French Polynesia.
PG: The country code for Papua New Guinea.
PH: The country code for the Philippines.
PK: The country code for Pakistan.
PL: The country code for Poland.
PM: The country code for Saint Pierre and Miquelon.
PR: The country code for Puerto Rico.
PS: The country code for Palestine.
PT: The country code for Portugal.
PW: The country code for Palau.
PY: The country code for Paraguay.
QA: The country code for Qatar.
RE: The country code for Réunion.
RO: The country code for Romania.
RS: The country code for Serbia.
RU: The country code for Russia.
RW: The country code for Rwanda.
SA: The country code for Saudi Arabia.
SB: The country code for the Solomon Islands.
SC: The country code for Seychelles.
SD: The country code for Sudan.
SE: The country code for Sweden.
SG: The country code for Singapore.
SH: The country code for Saint Helena.
SI: The country code for Slovenia.
SK: The country code for Slovakia.
SL: The country code for Sierra Leone.
SM: The country code for San Marino.
SN: The country code for Senegal.
SO: The country code for Somalia.
SR: The country code for Suriname.
SS: The country code for South Sudan.
ST: The country code for São Tomé and Príncipe.
SV: The country code for El Salvador.
SX: The country code for Sint Maarten.
SY: The country code for Syria.
SZ: The country code for Eswatini.
TC: The country code for the Turks and Caicos Islands.
TD: The country code for Chad.
TG: The country code for Togo.
TH: The country code for Thailand.
TJ: The country code for Tajikistan.
TK: The country code for Tokelau.
TL: The country code for East Timor.
TM: The country code for Turkmenistan.
TN: The country code for Tunisia.
TO: The country code for Tonga.
TR: The country code for Turkey.
TT: The country code for Trinidad and Tobago.
TV: The country code for Tuvalu.
TW: The country code for Taiwan.
TZ: The country code for Tanzania.
UA: The country code for Ukraine.
UG: The country code for Uganda.
UM: The country code for the United States Minor Outlying Islands.
US: The country code for the United States of America.
UY: The country code for Uruguay.
UZ: The country code for Uzbekistan.
VC: The country code for Saint Vincent and the Grenadines.
VE: The country code for Venezuela.
VG: The country code for the British Virgin Islands.
VI: The country code for the United States Virgin Islands.
VN: The country code for Vietnam.
VU: The country code for Vanuatu.
WF: The country code for Wallis and Futuna.
WS: The country code for Samoa.
XK: The country code for Kosovo.
YE: The country code for Yemen.
YT: The country code for Mayotte.
ZA: The country code for South Africa.
ZM: The country code for Zambia.
ZW: The country code for Zimbabwe.
description: Country of the company's tax registration. This value controls conditional validation for taxId and addressState. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsInputCountryCodesEnum'
taxId:
type:
- string
- 'null'
description: 'Tax registration identifier associated with the provided legal company name. For US taxIdCountry it must follow format XX-XXXXXXX (example: 12-3456789). For non-US taxIdCountry it is validated as a generic string up to 25 characters. Not required for create, but required for launch.'
minLength: 1
maxLength: 25
uniqueItems: false
addressLine:
type:
- string
- 'null'
description: Street address line. Not required for create, but required for launch.
minLength: 1
maxLength: 100
uniqueItems: false
addressCity:
type:
- string
- 'null'
description: City. Not required for create, but required for launch.
minLength: 1
maxLength: 100
uniqueItems: false
addressCountry:
x-enumDescriptions:
AD: The country code for Andorra.
AE: The country code for the United Arab Emirates.
AF: The country code for Afghanistan.
AG: The country code for Antigua and Barbuda.
AI: The country code for Anguilla.
AL: The country code for Albania.
AM: The country code for Armenia.
AO: The country code for Angola.
AR: The country code for Argentina.
AS: The country code for American Samoa.
AT: The country code for Austria.
AU: The country code for Australia.
AW: The country code for Aruba.
AZ: The country code for Azerbaijan.
BA: The country code for Bosnia and Herzegovina.
BB: The country code for Barbados.
BD: The country code for Bangladesh.
BE: The country code for Belgium.
BF: The country code for Burkina Faso.
BG: The country code for Bulgaria.
BH: The country code for Bahrain.
BI: The country code for Burundi.
BJ: The country code for Benin.
BM: The country code for Bermuda.
BN: The country code for Brunei.
BO: The country code for Bolivia.
BQ: The country code for Bonaire.
BR: The country code for Brazil.
BS: The country code for the Bahamas.
BT: The country code for Bhutan.
BW: The country code for Botswana.
BY: The country code for Belarus.
BZ: The country code for Belize.
CA: The country code for Canada.
CD: The country code for the Democratic Republic of the Congo.
CF: The country code for the Central African Republic.
CG: The country code for the Republic of the Congo.
CH: The country code for Switzerland.
CI: The country code for the Ivory Coast.
CK: The country code for the Cook Islands.
CL: The country code for Chile.
CM: The country code for Cameroon.
CN: The country code for China.
CO: The country code for Colombia.
CR: The country code for Costa Rica.
CU: The country code for Cuba.
CV: The country code for Cape Verde.
CW: The country code for Curaçao.
CY: The country code for Cyprus.
CZ: The country code for the Czech Republic.
DE: The country code for Germany.
DJ: The country code for Djibouti.
DK: The country code for Denmark.
DM: The country code for Dominica.
DO: The country code for the Dominican Republic.
DZ: The country code for Algeria.
EC: The country code for Ecuador.
EE: The country code for Estonia.
EG: The country code for Egypt.
ER: The country code for Eritrea.
ES: The country code for Spain.
ET: The country code for Ethiopia.
FI: The country code for Finland.
FJ: The country code for Fiji.
FK: The country code for the Falkland Islands.
FM: The country code for Micronesia.
FO: The country code for the Faroe Islands.
FR: The country code for France.
GA: The country code for Gabon.
GB: The country code for the United Kingdom of Great Britain.
GD: The country code for Grenada.
GE: The country code for Georgia.
GF: The country code for French Guiana.
GG: The country code for Guernsey.
GH: The country code for Ghana.
GI: The country code for Gibraltar.
GL: The country code for Greenland.
GM: The country code for the Gambia.
GN: The country code for Guinea.
GP: The country code for Guadeloupe.
GQ: The country code for Equatorial Guinea.
GR: The country code for Greece.
GT: The country code for Guatemala.
GU: The country code for Guam.
GW: The country code for Guinea-Bissau.
GY: The country code for Guyana.
HK: The country code for Hong Kong.
HN: The country code for Honduras.
HR: The country code for Croatia.
HT: The country code for Haiti.
HU: The country code for Hungary.
ID: The country code for Indonesia.
IE: The country code for Ireland.
IL: The country code for Israel.
IM: The country code for the Isle of Man.
IN: The country code for India.
IO: The country code for the British Indian Ocean Territory.
IQ: The country code for Iraq.
IR: The country code for Iran.
IS: The country code for Iceland.
IT: The country code for Italy.
JE: The country code for Jersey.
JM: The country code for Jamaica.
JO: The country code for Jordan.
JP: The country code for Japan.
KE: The country code for Kenya.
KG: The country code for Kyrgyzstan.
KH: The country code for Cambodia.
KI: The country code for Kiribati.
KM: The country code for Comoros.
KN: The country code for Saint Kitts and Nevis.
KP: The country code for North Korea.
KR: The country code for South Korea.
KW: The country code for Kuwait.
KY: The country code for the Cayman Islands.
KZ: The country code for Kazakhstan.
LA: The country code for Laos.
LB: The country code for Lebanon.
LC: The country code for Saint Lucia.
LI: The country code for Liechtenstein.
LK: The country code for Sri Lanka.
LR: The country code for Liberia.
LS: The country code for Lesotho.
LT: The country code for Lithuania.
LU: The country code for Luxembourg.
LV: The country code for Latvia.
LY: The country code for Libya.
MA: The country code for Morocco.
MC: The country code for Monaco.
MD: The country code for Moldova.
ME: The country code for Montenegro.
MG: The country code for Madagascar.
MH: The country code for the Marshall Islands.
MK: The country code for North Macedonia.
ML: The country code for Mali.
MM: The country code for Myanmar.
MN: The country code for Mongolia.
MO: The country code for Macao.
MP: The country code for the Northern Mariana Islands.
MQ: The country code for Martinique.
MR: The country code for Mauritania.
MS: The country code for Montserrat.
MT: The country code for Malta.
MU: The country code for Mauritius.
MV: The country code for the Maldives.
MW: The country code for Malawi.
MX: The country code for Mexico.
MY: The country code for Malaysia.
MZ: The country code for Mozambique.
NA: The country code for Namibia.
NC: The country code for New Caledonia.
NE: The country code for Niger.
NF: The country code for Norfolk Island.
NG: The country code for Nigeria.
NI: The country code for Nicaragua.
NL: The country code for the Netherlands.
'NO': The country code for Norway.
NP: The country code for Nepal.
NR: The country code for Nauru.
NU: The country code for Niue.
NZ: The country code for New Zealand.
OM: The country code for Oman.
PA: The country code for Panama.
PE: The country code for Peru.
PF: The country code for French Polynesia.
PG: The country code for Papua New Guinea.
PH: The country code for the Philippines.
PK: The country code for Pakistan.
PL: The country code for Poland.
PM: The country code for Saint Pierre and Miquelon.
PR: The country code for Puerto Rico.
PS: The country code for Palestine.
PT: The country code for Portugal.
PW: The country code for Palau.
PY: The country code for Paraguay.
QA: The country code for Qatar.
RE: The country code for Réunion.
RO: The country code for Romania.
RS: The country code for Serbia.
RU: The country code for Russia.
RW: The country code for Rwanda.
SA: The country code for Saudi Arabia.
SB: The country code for the Solomon Islands.
SC: The country code for Seychelles.
SD: The country code for Sudan.
SE: The country code for Sweden.
SG: The country code for Singapore.
SH: The country code for Saint Helena.
SI: The country code for Slovenia.
SK: The country code for Slovakia.
SL: The country code for Sierra Leone.
SM: The country code for San Marino.
SN: The country code for Senegal.
SO: The country code for Somalia.
SR: The country code for Suriname.
SS: The country code for South Sudan.
ST: The country code for São Tomé and Príncipe.
SV: The country code for El Salvador.
SX: The country code for Sint Maarten.
SY: The country code for Syria.
SZ: The country code for Eswatini.
TC: The country code for the Turks and Caicos Islands.
TD: The country code for Chad.
TG: The country code for Togo.
TH: The country code for Thailand.
TJ: The country code for Tajikistan.
TK: The country code for Tokelau.
TL: The country code for East Timor.
TM: The country code for Turkmenistan.
TN: The country code for Tunisia.
TO: The country code for Tonga.
TR: The country code for Turkey.
TT: The country code for Trinidad and Tobago.
TV: The country code for Tuvalu.
TW: The country code for Taiwan.
TZ: The country code for Tanzania.
UA: The country code for Ukraine.
UG: The country code for Uganda.
UM: The country code for the United States Minor Outlying Islands.
US: The country code for the United States of America.
UY: The country code for Uruguay.
UZ: The country code for Uzbekistan.
VC: The country code for Saint Vincent and the Grenadines.
VE: The country code for Venezuela.
VG: The country code for the British Virgin Islands.
VI: The country code for the United States Virgin Islands.
VN: The country code for Vietnam.
VU: The country code for Vanuatu.
WF: The country code for Wallis and Futuna.
WS: The country code for Samoa.
XK: The country code for Kosovo.
YE: The country code for Yemen.
YT: The country code for Mayotte.
ZA: The country code for South Africa.
ZM: The country code for Zambia.
ZW: The country code for Zimbabwe.
description: Country. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsInputCountryCodesEnum'
addressState:
x-enumDescriptions:
AK: The State of Alaska.
AL: The State of Alabama.
AR: The State of Arkansas.
AS: The US territory of American Samoa.
AZ: The State of Arizona.
CA: The State of California.
CO: The State of Colorado.
CT: The State of Connecticut.
DC: The District of Columbia.
DE: The State of Delaware.
FL: The State of Florida.
GA: The State of Georgia.
GU: The US territory of Guam.
HI: The State of Hawaii.
IA: The State of Iowa.
ID: The State of Idaho.
IL: The State of Illinois.
IN: The State of Indiana.
KS: The State of Kansas.
KY: The Commonwealth of Kentucky.
LA: The State of Louisiana.
MA: The Commonwealth of Massachusetts.
MD: The State of Maryland.
ME: The State of Maine.
MI: The State of Michigan.
MN: The State of Minnesota.
MO: The State of Missouri.
MP: The US Commonwealth of the Northern Mariana Islands.
MS: The State of Mississippi.
MT: The State of Montana.
NC: The State of North Carolina.
ND: The State of North Dakota.
NE: The State of Nebraska.
NH: The State of New Hampshire.
NJ: The State of New Jersey.
NM: The State of New Mexico.
NV: The State of Nevada.
NY: The State of New York.
OH: The State of Ohio.
OK: The State of Oklahoma.
OR: The State of Oregon.
PA: The Commonwealth of Pennsylvania.
PR: The US territory of Puerto Rico.
RI: The State of Rhode Island.
SC: The State of South Carolina.
SD: The State of South Dakota.
TN: The State of Tennessee.
TX: The State of Texas.
UT: The State of Utah.
VA: The Commonwealth of Virginia.
VI: The US territory of the Virgin Islands.
VT: The State of Vermont.
WA: The State of Washington.
WI: The State of Wisconsin.
WV: The State of West Virginia.
WY: The State of Wyoming.
description: State (US only). Validated when taxIdCountry=US and ignored for non-US taxIdCountry.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsUsStatesEnum'
addressPostalCode:
type:
- string
- 'null'
description: Postal code. Not required for create, but required for launch.
minLength: 1
maxLength: 10
uniqueItems: false
websiteUrl:
type:
- string
- 'null'
description: Primary website URL. Not required for create, but required for launch.
format: url
maxLength: 100
uniqueItems: false
contactFirstName:
type:
- string
- 'null'
description: First name of the responsible contact person. Not required for create, but required for launch.
minLength: 1
maxLength: 100
uniqueItems: false
contactSurname:
type:
- string
- 'null'
description: Surname of the responsible contact person. Not required for create, but required for launch.
minLength: 1
maxLength: 100
uniqueItems: false
stockExchange:
type:
- string
- 'null'
description: Primary home country stock exchange abbreviation. Validated when ownershipType=PUBLIC.
minLength: 1
maxLength: 10
uniqueItems: false
stockSymbol:
type:
- string
- 'null'
description: Primary home country stock symbol associated with stock exchange. Validated when ownershipType=PUBLIC.
minLength: 1
maxLength: 6
uniqueItems: false
sampleMessages:
description: Sample messages for each use case or message type sent by the brand. Not required for create, but required for launch.
minItems: 1
maxItems: 5
uniqueItems: false
type:
- array
- 'null'
items:
type: string
maxLength: 1024
minLength: 20
messagesVolume:
type:
- number
- 'null'
description: Messages volume. Not required for create, but required for launch.
uniqueItems: false
embeddedLink:
type:
- boolean
- 'null'
description: Flag indicating if URL links will be embedded within message payloads. Not required for create, but required for launch.
uniqueItems: false
embeddedPhone:
type:
- boolean
- 'null'
description: Flag indicating if phone numbers will be embedded within message payloads. Not required for create, but required for launch.
uniqueItems: false
ageGatedContent:
type:
- boolean
- 'null'
description: Indicates if the campaign content is restricted by age (e.g., alcohol, tobacco). Not required for create, but required for launch.
uniqueItems: false
directLending:
type:
- boolean
- 'null'
description: Indicates if the campaign involves direct financial lending, requiring stricter compliance. Not required for create, but required for launch.
uniqueItems: false
optInConfirmationMessage:
type:
- string
- 'null'
description: Opt-in confirmation message sent to users. Not required for create, but required for launch.
minLength: 20
maxLength: 1024
uniqueItems: false
helpMessage:
type:
- string
- 'null'
description: Help message of the campaign. Not required for create, but required for launch.
minLength: 20
maxLength: 1024
uniqueItems: false
callToActionMessage:
type:
- string
- 'null'
description: Call to action message of the campaign. Not required for create, but required for launch.
minLength: 40
maxLength: 4096
uniqueItems: false
RcsUpdateSenderDetailsQuestionnaireGBAnswersInputDto:
type: object
properties:
brandIndustry:
type:
- string
- 'null'
minLength: 1
description: Sector or industry of business. Not required for create, but required for launch. If null the value will be deleted.
uniqueItems: false
companyLegalName:
type:
- string
- 'null'
minLength: 1
description: The registered legal name of the company. Not required for create, but required for launch. If null the value will be deleted.
uniqueItems: false
companyRegistrationNumber:
type:
- string
- 'null'
minLength: 1
description: The company registration number.
uniqueItems: false
fullCompanyAddress:
type:
- string
- 'null'
minLength: 1
description: Full company address. If null the value will be deleted.
uniqueItems: false
fullCompanyAddressMetadata:
description: Metadata for specified answer.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsUpdateSenderDetailsQuestionnaireAnswerMetadataInputDto'
messagesVolume:
type:
- string
- 'null'
minLength: 1
description: Messages volume. Not required for create, but required for launch. If null the value will be deleted.
uniqueItems: false
messagesFrequency:
type:
- string
- 'null'
minLength: 1
description: Messages frequency. If null the value will be deleted.
uniqueItems: false
campaignLength:
type:
- string
- 'null'
minLength: 1
description: Length of campaign. If null the value will be deleted.
deprecated: true
uniqueItems: false
RcsUsQuestionnaireBrandIndustriesEnum:
type: string
enum:
- AGRICULTURE
- COMMUNICATION
- CONSTRUCTION
- EDUCATION
- ENERGY
- ENTERTAINMENT
- FINANCIAL
- GAMBLING
- GOVERNMENT
- HEALTHCARE
- HOSPITALITY
- HUMAN_RESOURCES
- INSURANCE
- LEGAL
- MANUFACTURING
- NON_GOVERNMENTAL_ORGANIZATION
- POLITICAL
- POSTAL
- PROFESSIONAL
- REAL_ESTATE
- RETAIL
- TECHNOLOGY
- TRANSPORTATION
description: Sector or industry of business. Not required for create, but required for launch.
RcsNonUsPublicBrandCampaignSenderDetailsQuestionnaireUSQuestionsDto:
type: object
properties:
ownershipType:
readOnly: true
description: Ownership type of the company. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
companyLegalName:
readOnly: true
description: The registered legal name of the company. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
companyPhoneNumber:
readOnly: true
description: The registered phone number of the company. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
companyEmailAddress:
readOnly: true
description: The email address of the company. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
brandName:
readOnly: true
description: Brand name or Doing Business As (DBA). Must be legally associated with the provided legal company name. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
brandIndustry:
readOnly: true
description: Sector or industry of business. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
legalForm:
readOnly: true
description: Legal form of the company.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
taxIdCountry:
readOnly: true
description: Country of the company's tax registration.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
taxId:
readOnly: true
description: Tax registration identifier associated with the provided legal company name.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
addressLine:
readOnly: true
description: Street address line. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
addressCity:
readOnly: true
description: City. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
addressCountry:
readOnly: true
description: Country. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
addressPostalCode:
readOnly: true
description: Postal code. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
websiteUrl:
readOnly: true
description: Primary website URL. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
contactFirstName:
readOnly: true
description: First name of the responsible contact person. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
contactSurname:
readOnly: true
description: Surname of the responsible contact person. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
stockExchange:
readOnly: true
description: Primary home country stock exchange abbreviation. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
stockSymbol:
readOnly: true
description: Primary home country stock symbol associated with stock exchange. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
sampleMessages:
readOnly: true
description: Sample messages for each use case or message type sent by the brand. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
messagesVolume:
readOnly: true
description: Messages volume. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
embeddedLink:
readOnly: true
description: Flag indicating if URL links will be embedded within message payloads. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
embeddedPhone:
readOnly: true
description: Flag indicating if phone numbers will be embedded within message payloads. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
ageGatedContent:
readOnly: true
description: Indicates if the campaign content is restricted by age (e.g., alcohol, tobacco). Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
directLending:
readOnly: true
description: Indicates if the campaign involves direct financial lending, requiring stricter compliance. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
optInConfirmationMessage:
readOnly: true
description: Opt-in confirmation message sent to users. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
helpMessage:
readOnly: true
description: Help message of the campaign. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
callToActionMessage:
readOnly: true
description: Call to action message of the campaign. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
required:
- ownershipType
- companyLegalName
- companyPhoneNumber
- companyEmailAddress
- brandName
- brandIndustry
- legalForm
- taxIdCountry
- taxId
- addressLine
- addressCity
- addressCountry
- addressPostalCode
- websiteUrl
- contactFirstName
- contactSurname
- stockExchange
- stockSymbol
- sampleMessages
- messagesVolume
- embeddedLink
- embeddedPhone
- ageGatedContent
- directLending
- optInConfirmationMessage
- helpMessage
- callToActionMessage
RcsUpdateSenderDetailsQuestionnaireGBInputDto:
type: object
properties:
answers:
description: Launch answers specific for UK.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsUpdateSenderDetailsQuestionnaireGBAnswersInputDto'
required:
- answers
RcsSenderDetailsQuestionnaireFRAnswersInputDto:
type: object
properties:
fullCompanyAddress:
type: string
minLength: 1
description: Full company address.
uniqueItems: false
fullCompanyAddressMetadata:
description: Metadata for specified answer.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireAnswerMetadataInputDto'
siren:
type: string
pattern: ^\d+$
minLength: 9
maxLength: 9
description: Company directory identification system number.
uniqueItems: false
RcsUsPrivateBrandCampaignSenderDetailsQuestionnaireUSQuestionsDto:
type: object
properties:
ownershipType:
readOnly: true
description: Ownership type of the company. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
companyLegalName:
readOnly: true
description: The registered legal name of the company. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
companyPhoneNumber:
readOnly: true
description: The registered phone number of the company. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
companyEmailAddress:
readOnly: true
description: The email address of the company. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
brandName:
readOnly: true
description: Brand name or Doing Business As (DBA). Must be legally associated with the provided legal company name. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
brandIndustry:
readOnly: true
description: Sector or industry of business. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
legalForm:
readOnly: true
description: Legal form of the company.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
taxIdCountry:
readOnly: true
description: Country of the company's tax registration.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
taxId:
readOnly: true
description: Tax registration identifier associated with the provided legal company name.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
addressLine:
readOnly: true
description: Street address line. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
addressCity:
readOnly: true
description: City. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
addressCountry:
readOnly: true
description: Country. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
addressState:
readOnly: true
description: State (US only). Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
addressPostalCode:
readOnly: true
description: Postal code. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
websiteUrl:
readOnly: true
description: Primary website URL. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
contactFirstName:
readOnly: true
description: First name of the responsible contact person. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
contactSurname:
readOnly: true
description: Surname of the responsible contact person. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
sampleMessages:
readOnly: true
description: Sample messages for each use case or message type sent by the brand. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
messagesVolume:
readOnly: true
description: Messages volume. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
embeddedLink:
readOnly: true
description: Flag indicating if URL links will be embedded within message payloads. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
embeddedPhone:
readOnly: true
description: Flag indicating if phone numbers will be embedded within message payloads. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
ageGatedContent:
readOnly: true
description: Indicates if the campaign content is restricted by age (e.g., alcohol, tobacco). Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
directLending:
readOnly: true
description: Indicates if the campaign involves direct financial lending, requiring stricter compliance. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
optInConfirmationMessage:
readOnly: true
description: Opt-in confirmation message sent to users. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
helpMessage:
readOnly: true
description: Help message of the campaign. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
callToActionMessage:
readOnly: true
description: Call to action message of the campaign. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
required:
- ownershipType
- companyLegalName
- companyPhoneNumber
- companyEmailAddress
- brandName
- brandIndustry
- legalForm
- taxIdCountry
- taxId
- addressLine
- addressCity
- addressCountry
- addressState
- addressPostalCode
- websiteUrl
- contactFirstName
- contactSurname
- sampleMessages
- messagesVolume
- embeddedLink
- embeddedPhone
- ageGatedContent
- directLending
- optInConfirmationMessage
- helpMessage
- callToActionMessage
RcsBrandCampaignSenderDetailsQuestionnaireUSQuestionsDto:
type: object
properties:
ownershipType:
readOnly: true
description: Ownership type of the company. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
companyLegalName:
readOnly: true
description: The registered legal name of the company. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
companyPhoneNumber:
readOnly: true
description: The registered phone number of the company. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
companyEmailAddress:
readOnly: true
description: The email address of the company. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
brandName:
readOnly: true
description: Brand name or Doing Business As (DBA). Must be legally associated with the provided legal company name. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
brandIndustry:
readOnly: true
description: Sector or industry of business. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
legalForm:
readOnly: true
description: Legal form of the company.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
taxIdCountry:
readOnly: true
description: Country of the company's tax registration.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
taxId:
readOnly: true
description: Tax registration identifier associated with the provided legal company name.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
addressLine:
readOnly: true
description: Street address line. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
addressCity:
readOnly: true
description: City. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
addressCountry:
readOnly: true
description: Country. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
addressState:
readOnly: true
description: State (US only). Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
addressPostalCode:
readOnly: true
description: Postal code. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
websiteUrl:
readOnly: true
description: Primary website URL. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
contactFirstName:
readOnly: true
description: First name of the responsible contact person. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
contactSurname:
readOnly: true
description: Surname of the responsible contact person. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
stockExchange:
readOnly: true
description: Primary home country stock exchange abbreviation. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
stockSymbol:
readOnly: true
description: Primary home country stock symbol associated with stock exchange. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
sampleMessages:
readOnly: true
description: Sample messages for each use case or message type sent by the brand. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
messagesVolume:
readOnly: true
description: Messages volume. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
embeddedLink:
readOnly: true
description: Flag indicating if URL links will be embedded within message payloads. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
embeddedPhone:
readOnly: true
description: Flag indicating if phone numbers will be embedded within message payloads. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
ageGatedContent:
readOnly: true
description: Indicates if the campaign content is restricted by age (e.g., alcohol, tobacco). Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
directLending:
readOnly: true
description: Indicates if the campaign involves direct financial lending, requiring stricter compliance. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
optInConfirmationMessage:
readOnly: true
description: Opt-in confirmation message sent to users. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
helpMessage:
readOnly: true
description: Help message of the campaign. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
callToActionMessage:
readOnly: true
description: Call to action message of the campaign. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
required:
- ownershipType
- companyLegalName
- companyPhoneNumber
- companyEmailAddress
- brandName
- brandIndustry
- legalForm
- taxIdCountry
- taxId
- addressLine
- addressCity
- addressCountry
- addressState
- addressPostalCode
- websiteUrl
- contactFirstName
- contactSurname
- stockExchange
- stockSymbol
- sampleMessages
- messagesVolume
- embeddedLink
- embeddedPhone
- ageGatedContent
- directLending
- optInConfirmationMessage
- helpMessage
- callToActionMessage
RcsUsPublicBrandCampaignSenderDetailsQuestionnaireUSQuestionsDto:
type: object
properties:
ownershipType:
readOnly: true
description: Ownership type of the company. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
companyLegalName:
readOnly: true
description: The registered legal name of the company. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
companyPhoneNumber:
readOnly: true
description: The registered phone number of the company. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
companyEmailAddress:
readOnly: true
description: The email address of the company. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
brandName:
readOnly: true
description: Brand name or Doing Business As (DBA). Must be legally associated with the provided legal company name. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
brandIndustry:
readOnly: true
description: Sector or industry of business. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
legalForm:
readOnly: true
description: Legal form of the company.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
taxIdCountry:
readOnly: true
description: Country of the company's tax registration.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
taxId:
readOnly: true
description: Tax registration identifier associated with the provided legal company name.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
addressLine:
readOnly: true
description: Street address line. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
addressCity:
readOnly: true
description: City. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
addressCountry:
readOnly: true
description: Country. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
addressState:
readOnly: true
description: State (US only). Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
addressPostalCode:
readOnly: true
description: Postal code. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
websiteUrl:
readOnly: true
description: Primary website URL. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
contactFirstName:
readOnly: true
description: First name of the responsible contact person. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
contactSurname:
readOnly: true
description: Surname of the responsible contact person. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
stockExchange:
readOnly: true
description: Primary home country stock exchange abbreviation. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
stockSymbol:
readOnly: true
description: Primary home country stock symbol associated with stock exchange. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
sampleMessages:
readOnly: true
description: Sample messages for each use case or message type sent by the brand. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
messagesVolume:
readOnly: true
description: Messages volume. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
embeddedLink:
readOnly: true
description: Flag indicating if URL links will be embedded within message payloads. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
embeddedPhone:
readOnly: true
description: Flag indicating if phone numbers will be embedded within message payloads. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
ageGatedContent:
readOnly: true
description: Indicates if the campaign content is restricted by age (e.g., alcohol, tobacco). Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
directLending:
readOnly: true
description: Indicates if the campaign involves direct financial lending, requiring stricter compliance. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
optInConfirmationMessage:
readOnly: true
description: Opt-in confirmation message sent to users. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
helpMessage:
readOnly: true
description: Help message of the campaign. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
callToActionMessage:
readOnly: true
description: Call to action message of the campaign. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
required:
- ownershipType
- companyLegalName
- companyPhoneNumber
- companyEmailAddress
- brandName
- brandIndustry
- legalForm
- taxIdCountry
- taxId
- addressLine
- addressCity
- addressCountry
- addressState
- addressPostalCode
- websiteUrl
- contactFirstName
- contactSurname
- stockExchange
- stockSymbol
- sampleMessages
- messagesVolume
- embeddedLink
- embeddedPhone
- ageGatedContent
- directLending
- optInConfirmationMessage
- helpMessage
- callToActionMessage
RcsUpdateSenderDetailsInputDto:
type: object
properties:
brand:
description: Brand information.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsUpdateSenderDetailsBrandInputDto'
testNumbers:
maxItems: 200
uniqueItems: true
description: Phone numbers for testing. An agent can send 20 tester requests each day with a total maximum of 200 tester requests. If null the value will be deleted.
type:
- array
- 'null'
items:
type: string
format: e.164 phone number
countries:
type:
- array
- 'null'
x-enumDescriptions:
AT: The country code for Austria.
BE: The country code for Belgium.
BR: The country code for Brazil.
CA: The country code for Canada.
CZ: The country code for the Czech Republic.
DK: The country code for Denmark.
FI: The country code for Finland.
FR: The country code for France.
DE: The country code for Germany.
GR: The country code for Greece.
HU: The country code for Hungary.
IT: The country code for Italy.
LT: The country code for Lithuania.
MX: The country code for Mexico.
NL: The country code for the Netherlands.
'NO': The country code for Norway.
PE: The country code for Peru.
PL: The country code for Poland.
PT: The country code for Portugal.
SG: The country code for Singapore.
SK: The country code for Slovakia.
ES: The country code for Spain.
SE: The country code for Sweden.
US: The country code for the United States of America.
GB: The country code for the United Kingdom of Great Britain.
minItems: 1
uniqueItems: true
description: List of two-letter country codes in ISO 3166 standard, specifying the countries to launch RCS sender in. If null the value will be deleted.
items:
$ref: '#/components/schemas/RcsInputRcsCountryCodesEnum'
questionnaire:
description: "\n Launch questionnaire.\n\n The launch questionnaire is based on information required by different Suppliers and Operators. As such, especially the country specific, may be subject to change.\n "
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsUpdateSenderDetailsQuestionnaireInputDto'
RcsUpdateSenderDetailsQuestionnaireFRAnswersInputDto:
type: object
properties:
fullCompanyAddress:
type:
- string
- 'null'
minLength: 1
description: Full company address.
uniqueItems: false
fullCompanyAddressMetadata:
description: Metadata for specified answer.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsUpdateSenderDetailsQuestionnaireAnswerMetadataInputDto'
siren:
type:
- string
- 'null'
pattern: ^\d+$
minLength: 9
maxLength: 9
description: Company directory identification system number.
uniqueItems: false
RcsSenderInputDto:
type: object
properties:
region:
x-enumDescriptions:
BR: Specifies that the sender operations should be initialized within the Brazil region.
EU: Specifies that the sender operations should be initialized within the Europe region.
US: Specifies that the sender operations should be initialized within the United States region.
description: Region sender is provisioned in.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsInputSenderRegionsEnum'
billingCategory:
x-enumDescriptions:
CONVERSATIONAL: Selects the session-based billing model dedicated to continuous multi-turn interactive conversations.
NON_CONVERSATIONAL: Selects the transactional billing model dedicated to isolated alerts or one-way system messages.
BASIC_MESSAGE: Selects the legacy, text-only communication billing category.
CONVERSATIONAL_LEGACY: Selects the legacy conversational data tier layout for backwards compatibility layers.
SINGLE_MESSAGE: Selects the standalone billing layer dedicated to individual discrete message transmissions.
description: 'Billing category.
Note:
The billing framework distinguishes between two primary categories: non-conversational and conversational.
The non-conversational category includes SINGLE_MESSAGE and BASIC_MESSAGE types which are considered functionally equivalent in the current revision.
The conversational category includes CONVERSATIONAL and CONVERSATIONAL_LEGACY types. Values BASIC_MESSAGE, SINGLE_MESSAGE and CONVERSATIONAL_LEGACY are deprecated and will be removed in a future version.
- CONVERSATIONAL: Designed for longer, more complex sessions where the user and brand exchange a series of messages.
- NON_CONVERSATIONAL: Represents a non-conversational billing category, which replaces the legacy SINGLE_MESSAGE and BASIC_MESSAGE categories. This is for agents that primarily engage in one-way (A2P) communication.
- BASIC_MESSAGE: Billing model is similar to SMS. Deprecated value, use NON_CONVERSATIONAL instead.
- CONVERSATIONAL_LEGACY: Legacy category to support the billing configuration of existing agents. Deprecated value, use CONVERSATIONAL instead.
- SINGLE_MESSAGE: Replaces SMS with a richer messaging experience. Deprecated value, use NON_CONVERSATIONAL instead.'
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsInputSenderBillingCategoriesEnum'
useCase:
x-enumDescriptions:
MULTIUSE: Configures the sender for multiple distinct types of message flows.
OTP: Configures the sender exclusively for one-time passwords and secure tokens.
PROMOTIONAL: Configures the sender for marketing, offers, and promotional broadcasts.
TRANSACTIONAL: Configures the sender for critical, non-marketing customer alerts and account updates.
description: Use case.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsInputSenderUseCasesEnum'
details:
description: Sender details and information.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsInputDto'
required:
- region
- billingCategory
- useCase
RcsInputCountryCodesUsEnum:
type: string
const: US
description: Country of the company's tax registration for US taxId. This value controls conditional validation for taxId and addressState. Not required for create, but required for launch.
RcsInputSenderUseCasesEnum:
type: string
enum:
- MULTIUSE
- OTP
- PROMOTIONAL
- TRANSACTIONAL
description: Use case.
RcsUpdateSenderDetailsBrandInputDto:
type: object
properties:
name:
type: string
minLength: 0
maxLength: 40
description: Brand name.
uniqueItems: false
emails:
minItems: 1
maxItems: 3
description: Contact emails. If null the value will be deleted. Field 'address' must have unique values across items.
uniqueItems: true
type:
- array
- 'null'
items:
$ref: '#/components/schemas/RcsEmailInputDto'
phones:
minItems: 1
maxItems: 3
description: Contact phone numbers. If null the value will be deleted. Field 'number' must have unique values across items.
uniqueItems: true
type:
- array
- 'null'
items:
$ref: '#/components/schemas/RcsPhoneInputDto'
websites:
minItems: 1
maxItems: 3
description: Contact websites. If null the value will be deleted. Field 'url' must have unique values across items.
uniqueItems: true
type:
- array
- 'null'
items:
$ref: '#/components/schemas/RcsWebsiteInputDto'
color:
type: string
format: hex
description: Brand color (HEX code).
uniqueItems: false
description:
type: string
minLength: 0
maxLength: 100
description: Brand description.
uniqueItems: false
bannerUrl:
type: string
format: url
description: 'Brand banner url.
- Supported mime types: `image/jpeg` or `image/png`.
- Maximum file size: 200KB.
- Exact image dimensions: 1440 x 448 px.'
uniqueItems: false
logoUrl:
type: string
format: url
description: 'Brand logo url.
- Supported mime types: `image/jpeg` or `image/png`.
- Maximum file size: 50KB.
- Exact image dimensions: 224 x 224 px.'
uniqueItems: false
privacyPolicyUrl:
type: string
format: url
description: Privacy Policy URL.
uniqueItems: false
termsOfServiceUrl:
type: string
format: url
description: Terms & Conditions URL.
uniqueItems: false
RcsSenderDetailsQuestionnaireAnswerMetadataInputDto:
type: object
properties:
ignore:
type: string
minLength: 1
description: Ignore given string on launch, e.g. custom delimiter.
uniqueItems: false
RcsUpdateSenderDetailsQuestionnaireVerificationPartnerAnswersInputDto:
type: object
properties:
companyName:
type:
- string
- 'null'
minLength: 1
maxLength: 100
description: Company name of the brand partner. If null the value will be deleted.
uniqueItems: false
contactName:
type:
- string
- 'null'
minLength: 1
maxLength: 100
description: Name of the contact person of the brand partner. If null the value will be deleted.
uniqueItems: false
contactEmailAddress:
type:
- string
- 'null'
format: email
maxLength: 100
description: Email of the contact person of the brand partner. If null the value will be deleted.
uniqueItems: false
RcsSenderDetailsQuestionnaireFRInputDto:
type: object
properties:
answers:
description: Launch answers specific for France.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireFRAnswersInputDto'
required:
- answers
RcsSenderNotificationListDto:
type: object
properties:
totalSize:
type: number
description: Total size of the entries matching the search query.
uniqueItems: false
pageSize:
type: number
description: Requested size of the page.
uniqueItems: false
previousPageToken:
type: string
description: Encoded token to use in list request to fetch previous batch of entries.
uniqueItems: false
nextPageToken:
type: string
description: Encoded token to use in list request to fetch next batch of entries.
uniqueItems: false
notifications:
type: array
items:
$ref: '#/components/schemas/RcsSenderNotificationDto'
uniqueItems: false
required:
- totalSize
- pageSize
- notifications
RcsUpdateSenderDetailsQuestionnaireUSInputDto:
type: object
properties:
answers:
oneOf:
- $ref: '#/components/schemas/RcsBrandCampaignUpdateSenderDetailsQuestionnaireUSAnswersInputDto'
- $ref: '#/components/schemas/RcsUpdateSenderDetailsQuestionnaireUSAnswersInputDto'
description: Launch answers specific for US.
uniqueItems: false
required:
- answers
RcsTestNumbersDto:
type: object
properties:
testNumbers:
type: array
items:
$ref: '#/components/schemas/RcsTestNumberStateDto'
description: Test numbers states.
uniqueItems: false
required:
- testNumbers
RcsSenderDetailsQuestionnaireGeneralQuestionsDto:
type: object
properties:
optInDescription:
readOnly: true
description: How you obtain opt-in to message users.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
triggerDescription:
readOnly: true
description: Actions that triggers messages to users.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
interactionsDescription:
readOnly: true
description: Interactions with users.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
optOutDescription:
readOnly: true
description: The message the sender sends when a user opts out.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
videoUris:
readOnly: true
description: Publicly available URIs for videos of the sender, for review purposes only.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
screenshotUris:
readOnly: true
description: Publicly available URIs for screenshots of the sender, for review purposes only.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
required:
- optInDescription
- triggerDescription
- interactionsDescription
- optOutDescription
- videoUris
- screenshotUris
RcsPrivateUsQuestionnaireBrandLegalFormsEnum:
type: string
enum:
- CORPORATION
- LIMITED_LIABILITY_COMPANY
- PARTNERSHIP
- S_CORPORATION
description: Legal form of the company for private ownership type. Not required for create, but required for launch.
RcsInputCountryCodesEnum:
type: string
enum:
- AD
- AE
- AF
- AG
- AI
- AL
- AM
- AO
- AR
- AS
- AT
- AU
- AW
- AZ
- BA
- BB
- BD
- BE
- BF
- BG
- BH
- BI
- BJ
- BM
- BN
- BO
- BQ
- BR
- BS
- BT
- BW
- BY
- BZ
- CA
- CD
- CF
- CG
- CH
- CI
- CK
- CL
- CM
- CN
- CO
- CR
- CU
- CV
- CW
- CY
- CZ
- DE
- DJ
- DK
- DM
- DO
- DZ
- EC
- EE
- EG
- ER
- ES
- ET
- FI
- FJ
- FK
- FM
- FO
- FR
- GA
- GB
- GD
- GE
- GF
- GG
- GH
- GI
- GL
- GM
- GN
- GP
- GQ
- GR
- GT
- GU
- GW
- GY
- HK
- HN
- HR
- HT
- HU
- ID
- IE
- IL
- IM
- IN
- IO
- IQ
- IR
- IS
- IT
- JE
- JM
- JO
- JP
- KE
- KG
- KH
- KI
- KM
- KN
- KP
- KR
- KW
- KY
- KZ
- LA
- LB
- LC
- LI
- LK
- LR
- LS
- LT
- LU
- LV
- LY
- MA
- MC
- MD
- ME
- MG
- MH
- MK
- ML
- MM
- MN
- MO
- MP
- MQ
- MR
- MS
- MT
- MU
- MV
- MW
- MX
- MY
- MZ
- NA
- NC
- NE
- NF
- NG
- NI
- NL
- 'NO'
- NP
- NR
- NU
- NZ
- OM
- PA
- PE
- PF
- PG
- PH
- PK
- PL
- PM
- PR
- PS
- PT
- PW
- PY
- QA
- RE
- RO
- RS
- RU
- RW
- SA
- SB
- SC
- SD
- SE
- SG
- SH
- SI
- SK
- SL
- SM
- SN
- SO
- SR
- SS
- ST
- SV
- SX
- SY
- SZ
- TC
- TD
- TG
- TH
- TJ
- TK
- TL
- TM
- TN
- TO
- TR
- TT
- TV
- TW
- TZ
- UA
- UG
- UM
- US
- UY
- UZ
- VC
- VE
- VG
- VI
- VN
- VU
- WF
- WS
- XK
- YE
- YT
- ZA
- ZM
- ZW
description: Country of the company's tax registration.
RcsCountryStatusDto:
type: object
properties:
country:
x-enumDescriptions:
AD: The country code for Andorra.
AE: The country code for the United Arab Emirates.
AF: The country code for Afghanistan.
AG: The country code for Antigua and Barbuda.
AI: The country code for Anguilla.
AL: The country code for Albania.
AM: The country code for Armenia.
AO: The country code for Angola.
AQ: The country code for Antarctica.
AR: The country code for Argentina.
AS: The country code for American Samoa.
AT: The country code for Austria.
AU: The country code for Australia.
AW: The country code for Aruba.
AZ: The country code for Azerbaijan.
BA: The country code for Bosnia and Herzegovina.
BB: The country code for Barbados.
BD: The country code for Bangladesh.
BE: The country code for Belgium.
BF: The country code for Burkina Faso.
BG: The country code for Bulgaria.
BH: The country code for Bahrain.
BI: The country code for Burundi.
BJ: The country code for Benin.
BM: The country code for Bermuda.
BN: The country code for Brunei.
BO: The country code for Bolivia.
BQ: The country code for Bonaire.
BR: The country code for Brazil.
BS: The country code for the Bahamas.
BT: The country code for Bhutan.
BW: The country code for Botswana.
BY: The country code for Belarus.
BZ: The country code for Belize.
CA: The country code for Canada.
CD: The country code for the Democratic Republic of the Congo.
CF: The country code for the Central African Republic.
CG: The country code for the Republic of the Congo.
CH: The country code for Switzerland.
CI: The country code for the Ivory Coast.
CK: The country code for the Cook Islands.
CL: The country code for Chile.
CM: The country code for Cameroon.
CN: The country code for China.
CO: The country code for Colombia.
CR: The country code for Costa Rica.
CU: The country code for Cuba.
CV: The country code for Cape Verde.
CW: The country code for Curaçao.
CY: The country code for Cyprus.
CZ: The country code for the Czech Republic.
DE: The country code for Germany.
DJ: The country code for Djibouti.
DK: The country code for Denmark.
DM: The country code for Dominica.
DO: The country code for the Dominican Republic.
DZ: The country code for Algeria.
EC: The country code for Ecuador.
EE: The country code for Estonia.
EG: The country code for Egypt.
ER: The country code for Eritrea.
ES: The country code for Spain.
ET: The country code for Ethiopia.
FI: The country code for Finland.
FJ: The country code for Fiji.
FK: The country code for the Falkland Islands.
FM: The country code for Micronesia.
FO: The country code for the Faroe Islands.
FR: The country code for France.
GA: The country code for Gabon.
GB: The country code for the United Kingdom of Great Britain.
GD: The country code for Grenada.
GE: The country code for Georgia.
GF: The country code for French Guiana.
GG: The country code for Guernsey.
GH: The country code for Ghana.
GI: The country code for Gibraltar.
GL: The country code for Greenland.
GM: The country code for the Gambia.
GN: The country code for Guinea.
GP: The country code for Guadeloupe.
GQ: The country code for Equatorial Guinea.
GR: The country code for Greece.
GT: The country code for Guatemala.
GU: The country code for Guam.
GW: The country code for Guinea-Bissau.
GY: The country code for Guyana.
HK: The country code for Hong Kong.
HN: The country code for Honduras.
HR: The country code for Croatia.
HT: The country code for Haiti.
HU: The country code for Hungary.
ID: The country code for Indonesia.
IE: The country code for Ireland.
IL: The country code for Israel.
IM: The country code for the Isle of Man.
IN: The country code for India.
IO: The country code for the British Indian Ocean Territory.
IQ: The country code for Iraq.
IR: The country code for Iran.
IS: The country code for Iceland.
IT: The country code for Italy.
JE: The country code for Jersey.
JM: The country code for Jamaica.
JO: The country code for Jordan.
JP: The country code for Japan.
KE: The country code for Kenya.
KG: The country code for Kyrgyzstan.
KH: The country code for Cambodia.
KI: The country code for Kiribati.
KM: The country code for Comoros.
KN: The country code for Saint Kitts and Nevis.
KP: The country code for North Korea.
KR: The country code for South Korea.
KW: The country code for Kuwait.
KY: The country code for the Cayman Islands.
KZ: The country code for Kazakhstan.
LA: The country code for Laos.
LB: The country code for Lebanon.
LC: The country code for Saint Lucia.
LI: The country code for Liechtenstein.
LK: The country code for Sri Lanka.
LR: The country code for Liberia.
LS: The country code for Lesotho.
LT: The country code for Lithuania.
LU: The country code for Luxembourg.
LV: The country code for Latvia.
LY: The country code for Libya.
MA: The country code for Morocco.
MC: The country code for Monaco.
MD: The country code for Moldova.
ME: The country code for Montenegro.
MG: The country code for Madagascar.
MH: The country code for the Marshall Islands.
MK: The country code for North Macedonia.
ML: The country code for Mali.
MM: The country code for Myanmar.
MN: The country code for Mongolia.
MO: The country code for Macao.
MP: The country code for the Northern Mariana Islands.
MQ: The country code for Martinique.
MR: The country code for Mauritania.
MS: The country code for Montserrat.
MT: The country code for Malta.
MU: The country code for Mauritius.
MV: The country code for the Maldives.
MW: The country code for Malawi.
MX: The country code for Mexico.
MY: The country code for Malaysia.
MZ: The country code for Mozambique.
NA: The country code for Namibia.
NC: The country code for New Caledonia.
NE: The country code for Niger.
NF: The country code for Norfolk Island.
NG: The country code for Nigeria.
NI: The country code for Nicaragua.
NL: The country code for the Netherlands.
'NO': The country code for Norway.
NP: The country code for Nepal.
NR: The country code for Nauru.
NU: The country code for Niue.
NZ: The country code for New Zealand.
OM: The country code for Oman.
PA: The country code for Panama.
PE: The country code for Peru.
PF: The country code for French Polynesia.
PG: The country code for Papua New Guinea.
PH: The country code for the Philippines.
PK: The country code for Pakistan.
PL: The country code for Poland.
PM: The country code for Saint Pierre and Miquelon.
PR: The country code for Puerto Rico.
PS: The country code for Palestine.
PT: The country code for Portugal.
PW: The country code for Palau.
PY: The country code for Paraguay.
QA: The country code for Qatar.
RE: The country code for Réunion.
RO: The country code for Romania.
RS: The country code for Serbia.
RU: The country code for Russia.
RW: The country code for Rwanda.
SA: The country code for Saudi Arabia.
SB: The country code for the Solomon Islands.
SC: The country code for Seychelles.
SD: The country code for Sudan.
SE: The country code for Sweden.
SG: The country code for Singapore.
SH: The country code for Saint Helena.
SI: The country code for Slovenia.
SK: The country code for Slovakia.
SL: The country code for Sierra Leone.
SM: The country code for San Marino.
SN: The country code for Senegal.
SO: The country code for Somalia.
SR: The country code for Suriname.
SS: The country code for South Sudan.
ST: The country code for São Tomé and Príncipe.
SV: The country code for El Salvador.
SX: The country code for Sint Maarten.
SY: The country code for Syria.
SZ: The country code for Eswatini.
TC: The country code for the Turks and Caicos Islands.
TD: The country code for Chad.
TG: The country code for Togo.
TH: The country code for Thailand.
TJ: The country code for Tajikistan.
TK: The country code for Tokelau.
TL: The country code for East Timor.
TM: The country code for Turkmenistan.
TN: The country code for Tunisia.
TO: The country code for Tonga.
TR: The country code for Turkey.
TT: The country code for Trinidad and Tobago.
TV: The country code for Tuvalu.
TW: The country code for Taiwan.
TZ: The country code for Tanzania.
UA: The country code for Ukraine.
UG: The country code for Uganda.
UM: The country code for the United States Minor Outlying Islands.
US: The country code for the United States of America.
UY: The country code for Uruguay.
UZ: The country code for Uzbekistan.
VC: The country code for Saint Vincent and the Grenadines.
VE: The country code for Venezuela.
VG: The country code for the British Virgin Islands.
VI: The country code for the United States Virgin Islands.
VN: The country code for Vietnam.
VU: The country code for Vanuatu.
WF: The country code for Wallis and Futuna.
WS: The country code for Samoa.
XK: The country code for Kosovo.
YE: The country code for Yemen.
YT: The country code for Mayotte.
ZA: The country code for South Africa.
ZM: The country code for Zambia.
ZW: The country code for Zimbabwe.
UNRECOGNIZED: The value returned by an upstream system is not recognized by this API version.
description: Two-letter country code in ISO 3166 standard.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsCountryCodesEnum'
status:
x-enumDescriptions:
LAUNCHED: The operator has been launched and is active.
NOT_LAUNCHED: The operator has not been launched yet.
PENDING: The operator configuration is pending activation.
PENDING_UNLAUNCHED: The operator is pending unlaunch execution.
REJECTED: The operator configuration has been rejected.
SUSPENDED: The operator has been suspended and is temporarily inactive.
UNLAUNCHED: The operator has been unlaunched and is no longer active.
INVALID_IN_GOOGLE_MY_BUSINESS: The operator profile is invalid within Google My Business.
UNRECOGNIZED: The value returned by an upstream system is not recognized by this API version.
description: Country status.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsOperatorStatusEnum'
operators:
type: array
items:
$ref: '#/components/schemas/RcsOperatorDto'
description: Mobile network operators.
uniqueItems: false
required:
- country
- status
- operators
RcsUpdateSenderDetailsQuestionnaireVerificationInputDto:
type: object
properties:
answers:
description: Verification answers. Senders using the US country questionnaire version v2 must also provide phone on launch, all other senders only provide name, email and website.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsUpdateSenderDetailsQuestionnaireVerificationAnswersInputDto'
required:
- answers
RcsEmailDto:
type: object
properties:
label:
type: string
description: Contact email label.
uniqueItems: false
address:
type: string
format: email
description: Contact email address.
uniqueItems: false
required:
- label
- address
RcsSenderDetailsQuestionnaireUSInputDto:
type: object
properties:
answers:
oneOf:
- $ref: '#/components/schemas/RcsUsPublicBrandCampaignSenderDetailsQuestionnaireUSAnswersInputDto'
- $ref: '#/components/schemas/RcsUsPrivateBrandCampaignSenderDetailsQuestionnaireUSAnswersInputDto'
- $ref: '#/components/schemas/RcsNonUsPublicBrandCampaignSenderDetailsQuestionnaireUSAnswersInputDto'
- $ref: '#/components/schemas/RcsNonUsPrivateBrandCampaignSenderDetailsQuestionnaireUSAnswersInputDto'
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireUSAnswersInputDto'
description: Launch answers specific for US.
uniqueItems: false
required:
- answers
RcsSenderDetailsBrandInputDto:
type: object
properties:
name:
type: string
minLength: 0
maxLength: 40
description: Brand name.
default: RCS Sender
uniqueItems: false
emails:
minItems: 1
maxItems: 3
description: Contact emails. Field 'address' must have unique values across items.
uniqueItems: true
type: array
items:
$ref: '#/components/schemas/RcsEmailInputDto'
phones:
minItems: 1
maxItems: 3
description: Contact phone numbers. Field 'number' must have unique values across items.
uniqueItems: true
type: array
items:
$ref: '#/components/schemas/RcsPhoneInputDto'
websites:
minItems: 1
maxItems: 3
description: Contact websites. Field 'url' must have unique values across items.
uniqueItems: true
type: array
items:
$ref: '#/components/schemas/RcsWebsiteInputDto'
color:
type: string
format: hex
description: Brand color (HEX code).
default: '#000000'
uniqueItems: false
description:
type: string
minLength: 0
maxLength: 100
description: Brand description.
uniqueItems: false
bannerUrl:
type: string
format: url
description: 'Brand banner url.
- Supported mime types: `image/jpeg` or `image/png`.
- Maximum file size: 200KB.
- Exact image dimensions: 1440 x 448 px.'
uniqueItems: false
logoUrl:
type: string
format: url
description: 'Brand logo url.
- Supported mime types: `image/jpeg` or `image/png`.
- Maximum file size: 50KB.
- Exact image dimensions: 224 x 224 px.'
uniqueItems: false
privacyPolicyUrl:
type: string
format: url
description: Privacy Policy URL.
uniqueItems: false
termsOfServiceUrl:
type: string
format: url
description: Terms & Conditions URL.
uniqueItems: false
RcsInputSenderRegionsEnum:
type: string
enum:
- BR
- EU
- US
description: Region sender is provisioned in.
RcsTestNumbersInputDto:
type: object
properties:
testNumbers:
maxItems: 200
uniqueItems: true
description: Phone numbers for testing. An agent can send 20 tester requests each day with a total maximum of 200 tester requests.
type: array
items:
type: string
format: e.164 phone number
required:
- testNumbers
RcsUpdateSenderDetailsQuestionnaireGeneralAnswersInputDto:
type: object
properties:
optInDescription:
type:
- string
- 'null'
minLength: 1
description: How you obtain opt-in to message users. If null the value will be deleted.
uniqueItems: false
optInDescriptionMetadata:
description: Metadata for specified answer.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsUpdateSenderDetailsQuestionnaireAnswerMetadataInputDto'
triggerDescription:
type:
- string
- 'null'
minLength: 1
description: Actions that triggers messages to users. If null the value will be deleted.
uniqueItems: false
triggerDescriptionMetadata:
description: Metadata for specified answer.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsUpdateSenderDetailsQuestionnaireAnswerMetadataInputDto'
interactionsDescription:
type:
- string
- 'null'
minLength: 1
description: Interactions with users. If null the value will be deleted.
uniqueItems: false
interactionsDescriptionMetadata:
description: Metadata for specified answer.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsUpdateSenderDetailsQuestionnaireAnswerMetadataInputDto'
optOutDescription:
type:
- string
- 'null'
minLength: 1
description: The message the sender sends when a user opts out. If null the value will be deleted.
uniqueItems: false
optOutDescriptionMetadata:
description: Metadata for specified answer.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsUpdateSenderDetailsQuestionnaireAnswerMetadataInputDto'
videoUris:
minItems: 1
description: Publicly available URIs for videos of the sender, for review purposes only. If null the value will be deleted.
uniqueItems: false
type:
- array
- 'null'
items:
type: string
format: url
screenshotUris:
minItems: 1
description: Publicly available URIs for screenshots of the sender, for review purposes only. If null the value will be deleted.
uniqueItems: false
type:
- array
- 'null'
items:
type: string
format: url
RcsSenderNotificationTypeEnum:
type: string
enum:
- ACTIVE
- COMMENT_ADDED
- CREATED
- DELETED
- EDITED
- INACTIVE
- TEST
RcsUpdateSenderDetailsQuestionnaireUSAnswersInputDto:
type: object
properties:
companyLegalName:
type:
- string
- 'null'
minLength: 0
description: The registered legal name of the company. Not required for create, but required for launch.
uniqueItems: false
ein:
type:
- string
- 'null'
pattern: ^\d{2}-\d{7}$
description: 'For US companies: Employer Identification Number (EIN). Must be a nine-digit number assigned by the IRS, following format: XX-XXXXXXX.'
uniqueItems: false
brandIndustry:
type:
- string
- 'null'
minLength: 0
description: Sector or industry of business. Not required for create, but required for launch.
uniqueItems: false
fullCompanyAddress:
type:
- string
- 'null'
minLength: 0
description: Full company address.
uniqueItems: false
fullCompanyAddressMetadata:
description: Metadata for specified answer.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsUpdateSenderDetailsQuestionnaireAnswerMetadataInputDto'
smsCampaign:
type:
- string
- 'null'
minLength: 0
description: US SMS campaign used as fallback.
uniqueItems: false
messagesVolume:
type:
- string
- 'null'
minLength: 0
description: Messages volume. Not required for create, but required for launch.
uniqueItems: false
description: UpdateSenderDetailsQuestionnaireUSAnswersInputDto is deprecated and will be removed in future versions. Please use BrandCampaignUpdateSenderDetailsQuestionnaireUSAnswersInputDto instead.
RcsSenderDetailsBrandDto:
type: object
properties:
name:
type: string
description: Brand name.
uniqueItems: false
emails:
type: array
items:
$ref: '#/components/schemas/RcsEmailDto'
description: Contact emails.
uniqueItems: false
phones:
type: array
items:
$ref: '#/components/schemas/RcsPhoneDto'
description: Contact phone numbers.
uniqueItems: false
websites:
type: array
items:
$ref: '#/components/schemas/RcsWebsiteDto'
description: Contact websites.
uniqueItems: false
color:
type: string
format: hex
description: Brand color (HEX code).
uniqueItems: false
description:
type: string
description: Brand description.
uniqueItems: false
bannerUrl:
type: string
format: url
description: Brand banner url.
uniqueItems: false
logoUrl:
type: string
format: url
description: Brand logo url.
uniqueItems: false
privacyPolicyUrl:
type: string
format: url
description: Privacy Policy URL.
uniqueItems: false
termsOfServiceUrl:
type: string
format: url
description: Terms & Conditions URL.
uniqueItems: false
RcsSenderUseCasesEnum:
type: string
enum:
- MULTIUSE
- OTP
- PROMOTIONAL
- TRANSACTIONAL
description: Use case.
RcsCountryCodesEnum:
type: string
enum:
- AD
- AE
- AF
- AG
- AI
- AL
- AM
- AO
- AQ
- AR
- AS
- AT
- AU
- AW
- AZ
- BA
- BB
- BD
- BE
- BF
- BG
- BH
- BI
- BJ
- BM
- BN
- BO
- BQ
- BR
- BS
- BT
- BW
- BY
- BZ
- CA
- CD
- CF
- CG
- CH
- CI
- CK
- CL
- CM
- CN
- CO
- CR
- CU
- CV
- CW
- CY
- CZ
- DE
- DJ
- DK
- DM
- DO
- DZ
- EC
- EE
- EG
- ER
- ES
- ET
- FI
- FJ
- FK
- FM
- FO
- FR
- GA
- GB
- GD
- GE
- GF
- GG
- GH
- GI
- GL
- GM
- GN
- GP
- GQ
- GR
- GT
- GU
- GW
- GY
- HK
- HN
- HR
- HT
- HU
- ID
- IE
- IL
- IM
- IN
- IO
- IQ
- IR
- IS
- IT
- JE
- JM
- JO
- JP
- KE
- KG
- KH
- KI
- KM
- KN
- KP
- KR
- KW
- KY
- KZ
- LA
- LB
- LC
- LI
- LK
- LR
- LS
- LT
- LU
- LV
- LY
- MA
- MC
- MD
- ME
- MG
- MH
- MK
- ML
- MM
- MN
- MO
- MP
- MQ
- MR
- MS
- MT
- MU
- MV
- MW
- MX
- MY
- MZ
- NA
- NC
- NE
- NF
- NG
- NI
- NL
- 'NO'
- NP
- NR
- NU
- NZ
- OM
- PA
- PE
- PF
- PG
- PH
- PK
- PL
- PM
- PR
- PS
- PT
- PW
- PY
- QA
- RE
- RO
- RS
- RU
- RW
- SA
- SB
- SC
- SD
- SE
- SG
- SH
- SI
- SK
- SL
- SM
- SN
- SO
- SR
- SS
- ST
- SV
- SX
- SY
- SZ
- TC
- TD
- TG
- TH
- TJ
- TK
- TL
- TM
- TN
- TO
- TR
- TT
- TV
- TW
- TZ
- UA
- UG
- UM
- US
- UY
- UZ
- VC
- VE
- VG
- VI
- VN
- VU
- WF
- WS
- XK
- YE
- YT
- ZA
- ZM
- ZW
- UNRECOGNIZED
description: Two-letter country code in ISO 3166 standard.
RcsPhoneInputDto:
type: object
properties:
label:
type: string
minLength: 0
maxLength: 25
description: Contact phone label.
uniqueItems: false
number:
type: string
pattern: ^\+?[\d+\s]{6,15}$
minLength: 6
maxLength: 15
description: Contact phone number. Must be a phone number without country code and without separators, or a valid e.164 phone number.
uniqueItems: false
required:
- label
- number
RcsSenderDetailsQuestionnaireAnswerMetadataDto:
type: object
properties:
ignore:
type: string
description: Ignore given string on launch, e.g. custom delimiter.
uniqueItems: false
RcsSenderDetailsQuestionnaireGeneralDto:
type: object
properties:
questions:
readOnly: true
description: Launch questions
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireGeneralQuestionsDto'
answers:
description: Launch answers
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireGeneralAnswersDto'
required:
- questions
- answers
RcsSenderStatesEnum:
type: string
enum:
- DRAFT
- IN_PROGRESS
- IN_TEST
- LAUNCHED
- LAUNCHING
- PREPARING_LAUNCH
- UNLAUNCHED
- UNKNOWN
description: The current state of the sender.
RcsConversationApiAppDto:
type: object
properties:
id:
type: string
description: ID of the app
uniqueItems: false
projectId:
type: string
description: ID of the app project
uniqueItems: false
region:
x-enumDescriptions:
BR: The application operates within the Brazil region.
EU: The application operates within the Europe region.
US: The application operates within the United States region.
UNRECOGNIZED: The value returned by an upstream system is not recognized by this API version.
description: App region.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsConversationApiAppRegionsEnum'
channelStatus:
x-enumDescriptions:
ACTIVE: The channel integration is active and operating as expected.
FAILING: The channel integration is failing and requires manual attention or troubleshooting.
PENDING: The channel integration setup or synchronization is pending completion.
UNRECOGNIZED: The value returned by an upstream system is not recognized by this API version.
description: Status of the channel credentials integration.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsConversationAppChannelIntegrationStatusEnum'
required:
- id
- projectId
- region
RcsPhoneDto:
type: object
properties:
label:
type: string
description: Contact phone label.
uniqueItems: false
number:
type: string
description: Contact phone number. A phone number without country code and without separators, or a valid e.164 phone number.
uniqueItems: false
required:
- label
- number
RcsSenderDetailsQuestionnaireFRAnswersDto:
type: object
properties:
fullCompanyAddress:
type: string
description: Full company address.
uniqueItems: false
fullCompanyAddressMetadata:
description: Metadata for specified answer.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireAnswerMetadataDto'
siren:
type: string
description: Company directory identification system number.
uniqueItems: false
RcsBrandRegistrationDto:
type: object
properties:
id:
type: string
description: Unique identifier for the brand registration.
uniqueItems: false
status:
x-enumDescriptions:
ARCHIVED: The brand registration has been archived and is no longer active.
COMPLETED: The brand registration has completed successfully.
DRAFT: The brand registration is saved as a draft and is not yet finalized.
UNRECOGNIZED: The value returned by an upstream system is not recognized by this API version.
UNSPECIFIED: The brand registration status is not specified.
description: Current status of the brand registration.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsBrandRegistrationStatusesEnum'
registration:
description: Details of the channel-specific registration process.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsBrandRegistrationProcessDto'
required:
- id
- status
- registration
RcsSenderHostingRegionsEnum:
type: string
enum:
- ASIA_PACIFIC
- EUROPE
- NORTH_AMERICA
description: Internal Google hosting region
RcsBrandCampaignSenderDetailsQuestionnaireUSDto:
type: object
properties:
questions:
oneOf:
- $ref: '#/components/schemas/RcsUsPublicBrandCampaignSenderDetailsQuestionnaireUSQuestionsDto'
- $ref: '#/components/schemas/RcsUsPrivateBrandCampaignSenderDetailsQuestionnaireUSQuestionsDto'
- $ref: '#/components/schemas/RcsNonUsPublicBrandCampaignSenderDetailsQuestionnaireUSQuestionsDto'
- $ref: '#/components/schemas/RcsNonUsPrivateBrandCampaignSenderDetailsQuestionnaireUSQuestionsDto'
- $ref: '#/components/schemas/RcsBrandCampaignSenderDetailsQuestionnaireUSQuestionsDto'
readOnly: true
description: Launch questions specific for US.
uniqueItems: false
answers:
description: Launch answers specific for US.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsBrandCampaignSenderDetailsQuestionnaireUSAnswersDto'
required:
- questions
- answers
RcsSenderRegionsEnum:
type: string
enum:
- BR
- EU
- US
description: Region sender is provisioned in.
RcsUsPublicBrandCampaignSenderDetailsQuestionnaireUSAnswersInputDto:
type: object
properties:
companyLegalName:
type: string
description: The registered legal name of the company. Not required for create, but required for launch.
minLength: 1
maxLength: 100
uniqueItems: false
companyPhoneNumber:
type: string
description: The registered phone number of the company. Not required for create, but required for launch.
minLength: 1
maxLength: 13
uniqueItems: false
companyEmailAddress:
type: string
format: email
maxLength: 100
uniqueItems: false
brandName:
type: string
description: Brand name or Doing Business As (DBA). Must be legally associated with the provided legal company name. Not required for create, but required for launch.
minLength: 1
maxLength: 100
uniqueItems: false
brandIndustry:
x-enumDescriptions:
AGRICULTURE: The brand operates within the agriculture sector.
COMMUNICATION: The brand operates within the communication industry.
CONSTRUCTION: The brand operates within the construction sector.
EDUCATION: The brand operates within the education field.
ENERGY: The brand operates within the energy and utilities sector.
ENTERTAINMENT: The brand operates within the entertainment and media industry.
FINANCIAL: The brand operates within the financial services sector.
GAMBLING: The brand operates within the gambling or betting industry.
GOVERNMENT: The brand is a government or public administration entity.
HEALTHCARE: The brand operates within the healthcare and medical sector.
HOSPITALITY: The brand operates within hospitality, tourism, or food services.
HUMAN_RESOURCES: The brand operates within human resources and staffing services.
INSURANCE: The brand operates within the insurance sector.
LEGAL: The brand operates within legal services.
MANUFACTURING: The brand operates within the manufacturing sector.
NON_GOVERNMENTAL_ORGANIZATION: The brand is a non-governmental organization (NGO).
POLITICAL: The brand is a political organization or campaign.
POSTAL: The brand operates within postal, courier, or delivery services.
PROFESSIONAL: The brand provides professional, scientific, or technical services.
REAL_ESTATE: The brand operates within the real estate market.
RETAIL: The brand operates within retail or wholesale commerce.
TECHNOLOGY: The brand operates within the technology and software sector.
TRANSPORTATION: The brand operates within transportation or logistics services.
description: Sector or industry of business. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsUsQuestionnaireBrandIndustriesEnum'
addressLine:
type: string
description: Street address line. Not required for create, but required for launch.
minLength: 1
maxLength: 100
uniqueItems: false
addressCity:
type: string
description: City. Not required for create, but required for launch.
minLength: 1
maxLength: 100
uniqueItems: false
addressCountry:
x-enumDescriptions:
AD: The country code for Andorra.
AE: The country code for the United Arab Emirates.
AF: The country code for Afghanistan.
AG: The country code for Antigua and Barbuda.
AI: The country code for Anguilla.
AL: The country code for Albania.
AM: The country code for Armenia.
AO: The country code for Angola.
AR: The country code for Argentina.
AS: The country code for American Samoa.
AT: The country code for Austria.
AU: The country code for Australia.
AW: The country code for Aruba.
AZ: The country code for Azerbaijan.
BA: The country code for Bosnia and Herzegovina.
BB: The country code for Barbados.
BD: The country code for Bangladesh.
BE: The country code for Belgium.
BF: The country code for Burkina Faso.
BG: The country code for Bulgaria.
BH: The country code for Bahrain.
BI: The country code for Burundi.
BJ: The country code for Benin.
BM: The country code for Bermuda.
BN: The country code for Brunei.
BO: The country code for Bolivia.
BQ: The country code for Bonaire.
BR: The country code for Brazil.
BS: The country code for the Bahamas.
BT: The country code for Bhutan.
BW: The country code for Botswana.
BY: The country code for Belarus.
BZ: The country code for Belize.
CA: The country code for Canada.
CD: The country code for the Democratic Republic of the Congo.
CF: The country code for the Central African Republic.
CG: The country code for the Republic of the Congo.
CH: The country code for Switzerland.
CI: The country code for the Ivory Coast.
CK: The country code for the Cook Islands.
CL: The country code for Chile.
CM: The country code for Cameroon.
CN: The country code for China.
CO: The country code for Colombia.
CR: The country code for Costa Rica.
CU: The country code for Cuba.
CV: The country code for Cape Verde.
CW: The country code for Curaçao.
CY: The country code for Cyprus.
CZ: The country code for the Czech Republic.
DE: The country code for Germany.
DJ: The country code for Djibouti.
DK: The country code for Denmark.
DM: The country code for Dominica.
DO: The country code for the Dominican Republic.
DZ: The country code for Algeria.
EC: The country code for Ecuador.
EE: The country code for Estonia.
EG: The country code for Egypt.
ER: The country code for Eritrea.
ES: The country code for Spain.
ET: The country code for Ethiopia.
FI: The country code for Finland.
FJ: The country code for Fiji.
FK: The country code for the Falkland Islands.
FM: The country code for Micronesia.
FO: The country code for the Faroe Islands.
FR: The country code for France.
GA: The country code for Gabon.
GB: The country code for the United Kingdom of Great Britain.
GD: The country code for Grenada.
GE: The country code for Georgia.
GF: The country code for French Guiana.
GG: The country code for Guernsey.
GH: The country code for Ghana.
GI: The country code for Gibraltar.
GL: The country code for Greenland.
GM: The country code for the Gambia.
GN: The country code for Guinea.
GP: The country code for Guadeloupe.
GQ: The country code for Equatorial Guinea.
GR: The country code for Greece.
GT: The country code for Guatemala.
GU: The country code for Guam.
GW: The country code for Guinea-Bissau.
GY: The country code for Guyana.
HK: The country code for Hong Kong.
HN: The country code for Honduras.
HR: The country code for Croatia.
HT: The country code for Haiti.
HU: The country code for Hungary.
ID: The country code for Indonesia.
IE: The country code for Ireland.
IL: The country code for Israel.
IM: The country code for the Isle of Man.
IN: The country code for India.
IO: The country code for the British Indian Ocean Territory.
IQ: The country code for Iraq.
IR: The country code for Iran.
IS: The country code for Iceland.
IT: The country code for Italy.
JE: The country code for Jersey.
JM: The country code for Jamaica.
JO: The country code for Jordan.
JP: The country code for Japan.
KE: The country code for Kenya.
KG: The country code for Kyrgyzstan.
KH: The country code for Cambodia.
KI: The country code for Kiribati.
KM: The country code for Comoros.
KN: The country code for Saint Kitts and Nevis.
KP: The country code for North Korea.
KR: The country code for South Korea.
KW: The country code for Kuwait.
KY: The country code for the Cayman Islands.
KZ: The country code for Kazakhstan.
LA: The country code for Laos.
LB: The country code for Lebanon.
LC: The country code for Saint Lucia.
LI: The country code for Liechtenstein.
LK: The country code for Sri Lanka.
LR: The country code for Liberia.
LS: The country code for Lesotho.
LT: The country code for Lithuania.
LU: The country code for Luxembourg.
LV: The country code for Latvia.
LY: The country code for Libya.
MA: The country code for Morocco.
MC: The country code for Monaco.
MD: The country code for Moldova.
ME: The country code for Montenegro.
MG: The country code for Madagascar.
MH: The country code for the Marshall Islands.
MK: The country code for North Macedonia.
ML: The country code for Mali.
MM: The country code for Myanmar.
MN: The country code for Mongolia.
MO: The country code for Macao.
MP: The country code for the Northern Mariana Islands.
MQ: The country code for Martinique.
MR: The country code for Mauritania.
MS: The country code for Montserrat.
MT: The country code for Malta.
MU: The country code for Mauritius.
MV: The country code for the Maldives.
MW: The country code for Malawi.
MX: The country code for Mexico.
MY: The country code for Malaysia.
MZ: The country code for Mozambique.
NA: The country code for Namibia.
NC: The country code for New Caledonia.
NE: The country code for Niger.
NF: The country code for Norfolk Island.
NG: The country code for Nigeria.
NI: The country code for Nicaragua.
NL: The country code for the Netherlands.
'NO': The country code for Norway.
NP: The country code for Nepal.
NR: The country code for Nauru.
NU: The country code for Niue.
NZ: The country code for New Zealand.
OM: The country code for Oman.
PA: The country code for Panama.
PE: The country code for Peru.
PF: The country code for French Polynesia.
PG: The country code for Papua New Guinea.
PH: The country code for the Philippines.
PK: The country code for Pakistan.
PL: The country code for Poland.
PM: The country code for Saint Pierre and Miquelon.
PR: The country code for Puerto Rico.
PS: The country code for Palestine.
PT: The country code for Portugal.
PW: The country code for Palau.
PY: The country code for Paraguay.
QA: The country code for Qatar.
RE: The country code for Réunion.
RO: The country code for Romania.
RS: The country code for Serbia.
RU: The country code for Russia.
RW: The country code for Rwanda.
SA: The country code for Saudi Arabia.
SB: The country code for the Solomon Islands.
SC: The country code for Seychelles.
SD: The country code for Sudan.
SE: The country code for Sweden.
SG: The country code for Singapore.
SH: The country code for Saint Helena.
SI: The country code for Slovenia.
SK: The country code for Slovakia.
SL: The country code for Sierra Leone.
SM: The country code for San Marino.
SN: The country code for Senegal.
SO: The country code for Somalia.
SR: The country code for Suriname.
SS: The country code for South Sudan.
ST: The country code for São Tomé and Príncipe.
SV: The country code for El Salvador.
SX: The country code for Sint Maarten.
SY: The country code for Syria.
SZ: The country code for Eswatini.
TC: The country code for the Turks and Caicos Islands.
TD: The country code for Chad.
TG: The country code for Togo.
TH: The country code for Thailand.
TJ: The country code for Tajikistan.
TK: The country code for Tokelau.
TL: The country code for East Timor.
TM: The country code for Turkmenistan.
TN: The country code for Tunisia.
TO: The country code for Tonga.
TR: The country code for Turkey.
TT: The country code for Trinidad and Tobago.
TV: The country code for Tuvalu.
TW: The country code for Taiwan.
TZ: The country code for Tanzania.
UA: The country code for Ukraine.
UG: The country code for Uganda.
UM: The country code for the United States Minor Outlying Islands.
US: The country code for the United States of America.
UY: The country code for Uruguay.
UZ: The country code for Uzbekistan.
VC: The country code for Saint Vincent and the Grenadines.
VE: The country code for Venezuela.
VG: The country code for the British Virgin Islands.
VI: The country code for the United States Virgin Islands.
VN: The country code for Vietnam.
VU: The country code for Vanuatu.
WF: The country code for Wallis and Futuna.
WS: The country code for Samoa.
XK: The country code for Kosovo.
YE: The country code for Yemen.
YT: The country code for Mayotte.
ZA: The country code for South Africa.
ZM: The country code for Zambia.
ZW: The country code for Zimbabwe.
description: Country. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsInputCountryCodesEnum'
addressPostalCode:
type: string
description: Postal code. Not required for create, but required for launch.
minLength: 1
maxLength: 10
uniqueItems: false
websiteUrl:
type: string
description: Primary website URL. Not required for create, but required for launch.
format: url
maxLength: 100
uniqueItems: false
contactFirstName:
type: string
description: First name of the responsible contact person. Not required for create, but required for launch.
minLength: 1
maxLength: 100
uniqueItems: false
contactSurname:
type: string
description: Surname of the responsible contact person. Not required for create, but required for launch.
minLength: 1
maxLength: 100
uniqueItems: false
sampleMessages:
description: Sample messages for each use case or message type sent by the brand. Not required for create, but required for launch.
minItems: 1
maxItems: 5
uniqueItems: false
type: array
items:
type: string
maxLength: 1024
minLength: 20
messagesVolume:
type: number
description: Messages volume. Not required for create, but required for launch.
uniqueItems: false
embeddedLink:
type: boolean
description: Flag indicating if URL links will be embedded within message payloads. Not required for create, but required for launch.
uniqueItems: false
embeddedPhone:
type: boolean
description: Flag indicating if phone numbers will be embedded within message payloads. Not required for create, but required for launch.
uniqueItems: false
ageGatedContent:
type: boolean
description: Indicates if the campaign content is restricted by age (e.g., alcohol, tobacco). Not required for create, but required for launch.
uniqueItems: false
directLending:
type: boolean
description: Indicates if the campaign involves direct financial lending, requiring stricter compliance. Not required for create, but required for launch.
uniqueItems: false
optInConfirmationMessage:
type: string
description: Opt-in confirmation message sent to users. Not required for create, but required for launch.
minLength: 20
maxLength: 1024
uniqueItems: false
helpMessage:
type: string
description: Help message of the campaign. Not required for create, but required for launch.
minLength: 20
maxLength: 1024
uniqueItems: false
callToActionMessage:
type: string
description: Call to action message of the campaign. Not required for create, but required for launch.
minLength: 40
maxLength: 4096
uniqueItems: false
ownershipType:
x-enumDescriptions:
PUBLIC: The brand is a publicly traded company.
description: Ownership type of the company. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsUsQuestionnaireOwnershipTypePublicEnum'
legalForm:
x-enumDescriptions:
CORPORATION: The company is registered as a Corporation.
description: Legal form of the company for public ownership type. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsPublicUsQuestionnaireBrandLegalFormsEnum'
taxIdCountry:
x-enumDescriptions:
US: The country code for the United States of America.
description: Country of the company's tax registration for US taxId. This value controls conditional validation for taxId and addressState. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsInputCountryCodesUsEnum'
taxId:
type: string
description: 'Tax registration identifier associated with the provided legal company name for US taxIdCountry. Must follow format XX-XXXXXXX (example: 12-3456789). Not required for create, but required for launch.'
minLength: 1
maxLength: 25
uniqueItems: false
addressState:
x-enumDescriptions:
AK: The State of Alaska.
AL: The State of Alabama.
AR: The State of Arkansas.
AS: The US territory of American Samoa.
AZ: The State of Arizona.
CA: The State of California.
CO: The State of Colorado.
CT: The State of Connecticut.
DC: The District of Columbia.
DE: The State of Delaware.
FL: The State of Florida.
GA: The State of Georgia.
GU: The US territory of Guam.
HI: The State of Hawaii.
IA: The State of Iowa.
ID: The State of Idaho.
IL: The State of Illinois.
IN: The State of Indiana.
KS: The State of Kansas.
KY: The Commonwealth of Kentucky.
LA: The State of Louisiana.
MA: The Commonwealth of Massachusetts.
MD: The State of Maryland.
ME: The State of Maine.
MI: The State of Michigan.
MN: The State of Minnesota.
MO: The State of Missouri.
MP: The US Commonwealth of the Northern Mariana Islands.
MS: The State of Mississippi.
MT: The State of Montana.
NC: The State of North Carolina.
ND: The State of North Dakota.
NE: The State of Nebraska.
NH: The State of New Hampshire.
NJ: The State of New Jersey.
NM: The State of New Mexico.
NV: The State of Nevada.
NY: The State of New York.
OH: The State of Ohio.
OK: The State of Oklahoma.
OR: The State of Oregon.
PA: The Commonwealth of Pennsylvania.
PR: The US territory of Puerto Rico.
RI: The State of Rhode Island.
SC: The State of South Carolina.
SD: The State of South Dakota.
TN: The State of Tennessee.
TX: The State of Texas.
UT: The State of Utah.
VA: The Commonwealth of Virginia.
VI: The US territory of the Virgin Islands.
VT: The State of Vermont.
WA: The State of Washington.
WI: The State of Wisconsin.
WV: The State of West Virginia.
WY: The State of Wyoming.
description: State (US only). Validated when taxIdCountry=US and ignored for non-US taxIdCountry.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsUsStatesEnum'
stockExchange:
type: string
description: Primary home country stock exchange abbreviation. Validated when ownershipType=PUBLIC.
minLength: 1
maxLength: 10
uniqueItems: false
stockSymbol:
type: string
description: Primary home country stock symbol associated with stock exchange. Validated when ownershipType=PUBLIC.
minLength: 1
maxLength: 6
uniqueItems: false
description: 'Documentation schema for US brand campaign answers: taxIdCountry=US, ownershipType=PUBLIC.'
required:
- companyLegalName
- companyPhoneNumber
- companyEmailAddress
- brandName
- brandIndustry
- addressLine
- addressCity
- addressCountry
- addressPostalCode
- websiteUrl
- contactFirstName
- contactSurname
- sampleMessages
- messagesVolume
- embeddedLink
- embeddedPhone
- ageGatedContent
- directLending
- optInConfirmationMessage
- helpMessage
- callToActionMessage
- ownershipType
- legalForm
- taxIdCountry
- taxId
- addressState
- stockExchange
- stockSymbol
RcsSenderDetailsQuestionnaireInputDto:
type: object
properties:
general:
description: General launch questions
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireGeneralInputDto'
verification:
description: Verification questions.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireVerificationInputDto'
gb:
description: Launch questions specific for UK.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireGBInputDto'
fr:
description: Launch questions specific for France.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireFRInputDto'
us:
description: Launch questions specific for US.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireUSInputDto'
RcsSenderDetailsQuestionnaireGBInputDto:
type: object
properties:
answers:
description: Launch answers specific for UK.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireGBAnswersInputDto'
required:
- answers
RcsSenderNotificationDto:
type: object
properties:
type:
x-enumDescriptions:
ACTIVE: The notification configuration is active and enabled.
COMMENT_ADDED: A new comment has been added to the notification trail.
CREATED: The notification configuration has been successfully created.
DELETED: The notification configuration has been deleted.
EDITED: The notification configuration has been edited or updated.
INACTIVE: The notification configuration is inactive or disabled.
TEST: This is an isolated test or sandbox notification.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderNotificationTypeEnum'
created:
type: string
uniqueItems: false
author:
type: string
uniqueItems: false
comment:
type: string
uniqueItems: false
required:
- type
RcsOperatorDto:
type: object
properties:
name:
type: string
description: Operator name.
uniqueItems: false
status:
x-enumDescriptions:
LAUNCHED: The operator has been launched and is active.
NOT_LAUNCHED: The operator has not been launched yet.
PENDING: The operator configuration is pending activation.
PENDING_UNLAUNCHED: The operator is pending unlaunch execution.
REJECTED: The operator configuration has been rejected.
SUSPENDED: The operator has been suspended and is temporarily inactive.
UNLAUNCHED: The operator has been unlaunched and is no longer active.
INVALID_IN_GOOGLE_MY_BUSINESS: The operator profile is invalid within Google My Business.
UNRECOGNIZED: The value returned by an upstream system is not recognized by this API version.
description: Operator status.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsOperatorStatusEnum'
remark:
type: string
description: Any comments or notes to the current state.
uniqueItems: false
modified:
type: string
description: Last date the operator changed state.
uniqueItems: false
required:
- name
- status
RcsUpdateSenderDetailsQuestionnaireVerificationAnswersInputDto:
type: object
properties:
name:
type:
- string
- 'null'
minLength: 1
description: Name of verification contact. Not required for create, but required for launch. If null the value will be deleted.
uniqueItems: false
email:
type:
- string
- 'null'
format: email
maxLength: 100
description: Email of verification contact. Not required for create, but required for launch. If null the value will be deleted.
uniqueItems: false
title:
type:
- string
- 'null'
minLength: 1
maxLength: 100
description: Title of verification contact. If null the value will be deleted.
uniqueItems: false
website:
type:
- string
- 'null'
format: url
description: Website of verification contact. Not required for create, but required for launch. If null the value will be deleted.
uniqueItems: false
phone:
type:
- string
- 'null'
pattern: ^(?:\+|00)\d{6,15}$
minLength: 1
maxLength: 17
description: Phone number of verification contact in E.164 format. Required for launch when the sender uses the US country questionnaire version v2, otherwise optional. If null the value will be deleted.
uniqueItems: false
partner:
description: Brand partner contact details. Only supported for reseller (ASP) accounts; otherwise ignored. If null the value will be deleted.
uniqueItems: false
type:
- object
- 'null'
allOf:
- $ref: '#/components/schemas/RcsUpdateSenderDetailsQuestionnaireVerificationPartnerAnswersInputDto'
RcsSenderDetailsQuestionnaireUSAnswersInputDto:
type: object
properties:
companyLegalName:
type: string
minLength: 0
description: The registered legal name of the company. Not required for create, but required for launch.
uniqueItems: false
ein:
type: string
pattern: ^\d{2}-\d{7}$
description: 'For US companies: Employer Identification Number (EIN). Must be a nine-digit number assigned by the IRS, following format: XX-XXXXXXX.'
uniqueItems: false
brandIndustry:
type: string
minLength: 0
description: Sector or industry of business. Not required for create, but required for launch.
uniqueItems: false
fullCompanyAddress:
type: string
minLength: 0
description: Full company address.
uniqueItems: false
fullCompanyAddressMetadata:
description: Metadata for specified answer.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireAnswerMetadataInputDto'
smsCampaign:
type: string
minLength: 0
description: US SMS campaign used as fallback.
uniqueItems: false
messagesVolume:
type: string
minLength: 0
description: Messages volume. Not required for create, but required for launch.
uniqueItems: false
description: SenderDetailsQuestionnaireUSAnswersInputDto is deprecated and will be removed in future versions. Please use BrandCampaignSenderDetailsQuestionnaireUSAnswersInputDto instead.
RcsDefaultSenderDetailsQuestionnaireUSDto:
type: object
properties:
questions:
readOnly: true
description: Launch questions specific for US.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsDefaultSenderDetailsQuestionnaireUSQuestionsDto'
answers:
description: Launch answers specific for US.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsBrandCampaignSenderDetailsQuestionnaireUSAnswersDto'
required:
- questions
- answers
RcsSenderDetailsDto:
type: object
properties:
brand:
description: Brand information.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsBrandDto'
callbackUrl:
type: string
format: url
description: Use Webhooks instead for sender update events.
deprecated: true
uniqueItems: false
testNumbers:
description: Phone numbers for testing. An agent can send 20 tester requests each day with a total maximum of 200 tester requests.
uniqueItems: false
type: array
items:
type: string
format: e.164 phone number
countries:
type: array
x-enumDescriptions:
AD: The country code for Andorra.
AE: The country code for the United Arab Emirates.
AF: The country code for Afghanistan.
AG: The country code for Antigua and Barbuda.
AI: The country code for Anguilla.
AL: The country code for Albania.
AM: The country code for Armenia.
AO: The country code for Angola.
AQ: The country code for Antarctica.
AR: The country code for Argentina.
AS: The country code for American Samoa.
AT: The country code for Austria.
AU: The country code for Australia.
AW: The country code for Aruba.
AZ: The country code for Azerbaijan.
BA: The country code for Bosnia and Herzegovina.
BB: The country code for Barbados.
BD: The country code for Bangladesh.
BE: The country code for Belgium.
BF: The country code for Burkina Faso.
BG: The country code for Bulgaria.
BH: The country code for Bahrain.
BI: The country code for Burundi.
BJ: The country code for Benin.
BM: The country code for Bermuda.
BN: The country code for Brunei.
BO: The country code for Bolivia.
BQ: The country code for Bonaire.
BR: The country code for Brazil.
BS: The country code for the Bahamas.
BT: The country code for Bhutan.
BW: The country code for Botswana.
BY: The country code for Belarus.
BZ: The country code for Belize.
CA: The country code for Canada.
CD: The country code for the Democratic Republic of the Congo.
CF: The country code for the Central African Republic.
CG: The country code for the Republic of the Congo.
CH: The country code for Switzerland.
CI: The country code for the Ivory Coast.
CK: The country code for the Cook Islands.
CL: The country code for Chile.
CM: The country code for Cameroon.
CN: The country code for China.
CO: The country code for Colombia.
CR: The country code for Costa Rica.
CU: The country code for Cuba.
CV: The country code for Cape Verde.
CW: The country code for Curaçao.
CY: The country code for Cyprus.
CZ: The country code for the Czech Republic.
DE: The country code for Germany.
DJ: The country code for Djibouti.
DK: The country code for Denmark.
DM: The country code for Dominica.
DO: The country code for the Dominican Republic.
DZ: The country code for Algeria.
EC: The country code for Ecuador.
EE: The country code for Estonia.
EG: The country code for Egypt.
ER: The country code for Eritrea.
ES: The country code for Spain.
ET: The country code for Ethiopia.
FI: The country code for Finland.
FJ: The country code for Fiji.
FK: The country code for the Falkland Islands.
FM: The country code for Micronesia.
FO: The country code for the Faroe Islands.
FR: The country code for France.
GA: The country code for Gabon.
GB: The country code for the United Kingdom of Great Britain.
GD: The country code for Grenada.
GE: The country code for Georgia.
GF: The country code for French Guiana.
GG: The country code for Guernsey.
GH: The country code for Ghana.
GI: The country code for Gibraltar.
GL: The country code for Greenland.
GM: The country code for the Gambia.
GN: The country code for Guinea.
GP: The country code for Guadeloupe.
GQ: The country code for Equatorial Guinea.
GR: The country code for Greece.
GT: The country code for Guatemala.
GU: The country code for Guam.
GW: The country code for Guinea-Bissau.
GY: The country code for Guyana.
HK: The country code for Hong Kong.
HN: The country code for Honduras.
HR: The country code for Croatia.
HT: The country code for Haiti.
HU: The country code for Hungary.
ID: The country code for Indonesia.
IE: The country code for Ireland.
IL: The country code for Israel.
IM: The country code for the Isle of Man.
IN: The country code for India.
IO: The country code for the British Indian Ocean Territory.
IQ: The country code for Iraq.
IR: The country code for Iran.
IS: The country code for Iceland.
IT: The country code for Italy.
JE: The country code for Jersey.
JM: The country code for Jamaica.
JO: The country code for Jordan.
JP: The country code for Japan.
KE: The country code for Kenya.
KG: The country code for Kyrgyzstan.
KH: The country code for Cambodia.
KI: The country code for Kiribati.
KM: The country code for Comoros.
KN: The country code for Saint Kitts and Nevis.
KP: The country code for North Korea.
KR: The country code for South Korea.
KW: The country code for Kuwait.
KY: The country code for the Cayman Islands.
KZ: The country code for Kazakhstan.
LA: The country code for Laos.
LB: The country code for Lebanon.
LC: The country code for Saint Lucia.
LI: The country code for Liechtenstein.
LK: The country code for Sri Lanka.
LR: The country code for Liberia.
LS: The country code for Lesotho.
LT: The country code for Lithuania.
LU: The country code for Luxembourg.
LV: The country code for Latvia.
LY: The country code for Libya.
MA: The country code for Morocco.
MC: The country code for Monaco.
MD: The country code for Moldova.
ME: The country code for Montenegro.
MG: The country code for Madagascar.
MH: The country code for the Marshall Islands.
MK: The country code for North Macedonia.
ML: The country code for Mali.
MM: The country code for Myanmar.
MN: The country code for Mongolia.
MO: The country code for Macao.
MP: The country code for the Northern Mariana Islands.
MQ: The country code for Martinique.
MR: The country code for Mauritania.
MS: The country code for Montserrat.
MT: The country code for Malta.
MU: The country code for Mauritius.
MV: The country code for the Maldives.
MW: The country code for Malawi.
MX: The country code for Mexico.
MY: The country code for Malaysia.
MZ: The country code for Mozambique.
NA: The country code for Namibia.
NC: The country code for New Caledonia.
NE: The country code for Niger.
NF: The country code for Norfolk Island.
NG: The country code for Nigeria.
NI: The country code for Nicaragua.
NL: The country code for the Netherlands.
'NO': The country code for Norway.
NP: The country code for Nepal.
NR: The country code for Nauru.
NU: The country code for Niue.
NZ: The country code for New Zealand.
OM: The country code for Oman.
PA: The country code for Panama.
PE: The country code for Peru.
PF: The country code for French Polynesia.
PG: The country code for Papua New Guinea.
PH: The country code for the Philippines.
PK: The country code for Pakistan.
PL: The country code for Poland.
PM: The country code for Saint Pierre and Miquelon.
PR: The country code for Puerto Rico.
PS: The country code for Palestine.
PT: The country code for Portugal.
PW: The country code for Palau.
PY: The country code for Paraguay.
QA: The country code for Qatar.
RE: The country code for Réunion.
RO: The country code for Romania.
RS: The country code for Serbia.
RU: The country code for Russia.
RW: The country code for Rwanda.
SA: The country code for Saudi Arabia.
SB: The country code for the Solomon Islands.
SC: The country code for Seychelles.
SD: The country code for Sudan.
SE: The country code for Sweden.
SG: The country code for Singapore.
SH: The country code for Saint Helena.
SI: The country code for Slovenia.
SK: The country code for Slovakia.
SL: The country code for Sierra Leone.
SM: The country code for San Marino.
SN: The country code for Senegal.
SO: The country code for Somalia.
SR: The country code for Suriname.
SS: The country code for South Sudan.
ST: The country code for São Tomé and Príncipe.
SV: The country code for El Salvador.
SX: The country code for Sint Maarten.
SY: The country code for Syria.
SZ: The country code for Eswatini.
TC: The country code for the Turks and Caicos Islands.
TD: The country code for Chad.
TG: The country code for Togo.
TH: The country code for Thailand.
TJ: The country code for Tajikistan.
TK: The country code for Tokelau.
TL: The country code for East Timor.
TM: The country code for Turkmenistan.
TN: The country code for Tunisia.
TO: The country code for Tonga.
TR: The country code for Turkey.
TT: The country code for Trinidad and Tobago.
TV: The country code for Tuvalu.
TW: The country code for Taiwan.
TZ: The country code for Tanzania.
UA: The country code for Ukraine.
UG: The country code for Uganda.
UM: The country code for the United States Minor Outlying Islands.
US: The country code for the United States of America.
UY: The country code for Uruguay.
UZ: The country code for Uzbekistan.
VC: The country code for Saint Vincent and the Grenadines.
VE: The country code for Venezuela.
VG: The country code for the British Virgin Islands.
VI: The country code for the United States Virgin Islands.
VN: The country code for Vietnam.
VU: The country code for Vanuatu.
WF: The country code for Wallis and Futuna.
WS: The country code for Samoa.
XK: The country code for Kosovo.
YE: The country code for Yemen.
YT: The country code for Mayotte.
ZA: The country code for South Africa.
ZM: The country code for Zambia.
ZW: The country code for Zimbabwe.
UNRECOGNIZED: The value returned by an upstream system is not recognized by this API version.
description: List of two-letter country codes in ISO 3166 standard, specifying the countries to launch RCS sender in.
uniqueItems: false
items:
$ref: '#/components/schemas/RcsCountryCodesEnum'
questionnaire:
description: "\n Launch questionnaire.\n\n The launch questionnaire is based on information required by different Suppliers and Operators. As such, especially the country specific, may be subject to change.\n "
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireDto'
required:
- questionnaire
RcsSenderDetailsQuestionnaireGeneralAnswersDto:
type: object
properties:
optInDescription:
type: string
description: How you obtain opt-in to message users.
uniqueItems: false
optInDescriptionMetadata:
description: Metadata for specified answer.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireAnswerMetadataDto'
triggerDescription:
type: string
description: Actions that triggers messages to users.
uniqueItems: false
triggerDescriptionMetadata:
description: Metadata for specified answer.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireAnswerMetadataDto'
interactionsDescription:
type: string
description: Interactions with users.
uniqueItems: false
interactionsDescriptionMetadata:
description: Metadata for specified answer.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireAnswerMetadataDto'
optOutDescription:
type: string
description: The message the sender sends when a user opts out.
uniqueItems: false
optOutDescriptionMetadata:
description: Metadata for specified answer.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireAnswerMetadataDto'
videoUris:
description: Publicly available URIs for videos of the sender, for review purposes only.
uniqueItems: false
type: array
items:
type: string
format: url
screenshotUris:
description: Publicly available URIs for screenshots of the sender, for review purposes only.
uniqueItems: false
type: array
items:
type: string
format: url
RcsInputSenderBillingCategoriesEnum:
type: string
enum:
- CONVERSATIONAL
- NON_CONVERSATIONAL
- BASIC_MESSAGE
- CONVERSATIONAL_LEGACY
- SINGLE_MESSAGE
description: 'Billing category.
Note:
The billing framework distinguishes between two primary categories: non-conversational and conversational.
The non-conversational category includes SINGLE_MESSAGE and BASIC_MESSAGE types which are considered functionally equivalent in the current revision.
The conversational category includes CONVERSATIONAL and CONVERSATIONAL_LEGACY types. Values BASIC_MESSAGE, SINGLE_MESSAGE and CONVERSATIONAL_LEGACY are deprecated and will be removed in a future version.
- CONVERSATIONAL: Designed for longer, more complex sessions where the user and brand exchange a series of messages.
- NON_CONVERSATIONAL: Represents a non-conversational billing category, which replaces the legacy SINGLE_MESSAGE and BASIC_MESSAGE categories. This is for agents that primarily engage in one-way (A2P) communication.
- BASIC_MESSAGE: Billing model is similar to SMS. Deprecated value, use NON_CONVERSATIONAL instead.
- CONVERSATIONAL_LEGACY: Legacy category to support the billing configuration of existing agents. Deprecated value, use CONVERSATIONAL instead.
- SINGLE_MESSAGE: Replaces SMS with a richer messaging experience. Deprecated value, use NON_CONVERSATIONAL instead.'
RcsSenderDetailsQuestionnaireVerificationPartnerAnswersDto:
type: object
properties:
companyName:
type: string
description: Company name of the brand partner.
uniqueItems: false
contactName:
type: string
description: Name of the contact person of the brand partner.
uniqueItems: false
contactEmailAddress:
type: string
format: email
description: Email of the contact person of the brand partner.
uniqueItems: false
RcsSenderDetailsQuestionnaireUSQuestionsDto:
type: object
properties:
companyLegalName:
readOnly: true
description: The registered legal name of the company. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
ein:
readOnly: true
description: Employer Identification Number (EIN).
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
brandIndustry:
readOnly: true
description: Sector or industry of business. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
fullCompanyAddress:
readOnly: true
description: Full company address.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
smsCampaign:
readOnly: true
description: US SMS campaign used as fallback.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
messagesVolume:
readOnly: true
description: Messages volume. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
description: SenderDetailsQuestionnaireUSQuestionsDto is deprecated and will be removed in future versions. Please use BrandCampaignSenderDetailsQuestionnaireUSQuestionsDto instead.
required:
- companyLegalName
- ein
- brandIndustry
- fullCompanyAddress
- smsCampaign
- messagesVolume
RcsSortDirectionsEnum:
type: string
enum:
- ASC
- DESC
RcsTestNumberStateDto:
type: object
properties:
number:
type: string
format: e.164 phone number
description: Test phone number.
uniqueItems: false
state:
x-enumDescriptions:
DECLINED: The test number registration has been declined by the system or operator.
EXPIRED: The test user did not respond to the verification invite before it expired.
FAILED: The test number could not be added after all attempts were exhausted.
INVALID: The test number configuration or format is invalid.
PENDING: The test number verification is pending backend or operator approval.
REJECTED: The test number verification has been rejected.
UNVERIFIED: The test number has not been verified yet.
VERIFIED: The test number has been successfully verified and is ready for use.
UNRECOGNIZED: The value returned by an upstream system is not recognized by this API version.
description: Test phone state.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsTestNumberStatesEnum'
submitted:
type: string
description: Date of submitting phone number.
uniqueItems: false
required:
- number
- state
- submitted
RcsCommentInputDto:
type: object
properties:
comment:
type: string
minLength: 1
maxLength: 65535
uniqueItems: false
required:
- comment
RcsTestNumberStatesEnum:
type: string
enum:
- DECLINED
- EXPIRED
- FAILED
- INVALID
- PENDING
- REJECTED
- UNVERIFIED
- VERIFIED
- UNRECOGNIZED
description: Test phone state.
RcsNonUsPublicBrandCampaignSenderDetailsQuestionnaireUSAnswersInputDto:
type: object
properties:
companyLegalName:
type: string
description: The registered legal name of the company. Not required for create, but required for launch.
minLength: 1
maxLength: 100
uniqueItems: false
companyPhoneNumber:
type: string
description: The registered phone number of the company. Not required for create, but required for launch.
minLength: 1
maxLength: 13
uniqueItems: false
companyEmailAddress:
type: string
format: email
maxLength: 100
uniqueItems: false
brandName:
type: string
description: Brand name or Doing Business As (DBA). Must be legally associated with the provided legal company name. Not required for create, but required for launch.
minLength: 1
maxLength: 100
uniqueItems: false
brandIndustry:
x-enumDescriptions:
AGRICULTURE: The brand operates within the agriculture sector.
COMMUNICATION: The brand operates within the communication industry.
CONSTRUCTION: The brand operates within the construction sector.
EDUCATION: The brand operates within the education field.
ENERGY: The brand operates within the energy and utilities sector.
ENTERTAINMENT: The brand operates within the entertainment and media industry.
FINANCIAL: The brand operates within the financial services sector.
GAMBLING: The brand operates within the gambling or betting industry.
GOVERNMENT: The brand is a government or public administration entity.
HEALTHCARE: The brand operates within the healthcare and medical sector.
HOSPITALITY: The brand operates within hospitality, tourism, or food services.
HUMAN_RESOURCES: The brand operates within human resources and staffing services.
INSURANCE: The brand operates within the insurance sector.
LEGAL: The brand operates within legal services.
MANUFACTURING: The brand operates within the manufacturing sector.
NON_GOVERNMENTAL_ORGANIZATION: The brand is a non-governmental organization (NGO).
POLITICAL: The brand is a political organization or campaign.
POSTAL: The brand operates within postal, courier, or delivery services.
PROFESSIONAL: The brand provides professional, scientific, or technical services.
REAL_ESTATE: The brand operates within the real estate market.
RETAIL: The brand operates within retail or wholesale commerce.
TECHNOLOGY: The brand operates within the technology and software sector.
TRANSPORTATION: The brand operates within transportation or logistics services.
description: Sector or industry of business. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsUsQuestionnaireBrandIndustriesEnum'
addressLine:
type: string
description: Street address line. Not required for create, but required for launch.
minLength: 1
maxLength: 100
uniqueItems: false
addressCity:
type: string
description: City. Not required for create, but required for launch.
minLength: 1
maxLength: 100
uniqueItems: false
addressCountry:
x-enumDescriptions:
AD: The country code for Andorra.
AE: The country code for the United Arab Emirates.
AF: The country code for Afghanistan.
AG: The country code for Antigua and Barbuda.
AI: The country code for Anguilla.
AL: The country code for Albania.
AM: The country code for Armenia.
AO: The country code for Angola.
AR: The country code for Argentina.
AS: The country code for American Samoa.
AT: The country code for Austria.
AU: The country code for Australia.
AW: The country code for Aruba.
AZ: The country code for Azerbaijan.
BA: The country code for Bosnia and Herzegovina.
BB: The country code for Barbados.
BD: The country code for Bangladesh.
BE: The country code for Belgium.
BF: The country code for Burkina Faso.
BG: The country code for Bulgaria.
BH: The country code for Bahrain.
BI: The country code for Burundi.
BJ: The country code for Benin.
BM: The country code for Bermuda.
BN: The country code for Brunei.
BO: The country code for Bolivia.
BQ: The country code for Bonaire.
BR: The country code for Brazil.
BS: The country code for the Bahamas.
BT: The country code for Bhutan.
BW: The country code for Botswana.
BY: The country code for Belarus.
BZ: The country code for Belize.
CA: The country code for Canada.
CD: The country code for the Democratic Republic of the Congo.
CF: The country code for the Central African Republic.
CG: The country code for the Republic of the Congo.
CH: The country code for Switzerland.
CI: The country code for the Ivory Coast.
CK: The country code for the Cook Islands.
CL: The country code for Chile.
CM: The country code for Cameroon.
CN: The country code for China.
CO: The country code for Colombia.
CR: The country code for Costa Rica.
CU: The country code for Cuba.
CV: The country code for Cape Verde.
CW: The country code for Curaçao.
CY: The country code for Cyprus.
CZ: The country code for the Czech Republic.
DE: The country code for Germany.
DJ: The country code for Djibouti.
DK: The country code for Denmark.
DM: The country code for Dominica.
DO: The country code for the Dominican Republic.
DZ: The country code for Algeria.
EC: The country code for Ecuador.
EE: The country code for Estonia.
EG: The country code for Egypt.
ER: The country code for Eritrea.
ES: The country code for Spain.
ET: The country code for Ethiopia.
FI: The country code for Finland.
FJ: The country code for Fiji.
FK: The country code for the Falkland Islands.
FM: The country code for Micronesia.
FO: The country code for the Faroe Islands.
FR: The country code for France.
GA: The country code for Gabon.
GB: The country code for the United Kingdom of Great Britain.
GD: The country code for Grenada.
GE: The country code for Georgia.
GF: The country code for French Guiana.
GG: The country code for Guernsey.
GH: The country code for Ghana.
GI: The country code for Gibraltar.
GL: The country code for Greenland.
GM: The country code for the Gambia.
GN: The country code for Guinea.
GP: The country code for Guadeloupe.
GQ: The country code for Equatorial Guinea.
GR: The country code for Greece.
GT: The country code for Guatemala.
GU: The country code for Guam.
GW: The country code for Guinea-Bissau.
GY: The country code for Guyana.
HK: The country code for Hong Kong.
HN: The country code for Honduras.
HR: The country code for Croatia.
HT: The country code for Haiti.
HU: The country code for Hungary.
ID: The country code for Indonesia.
IE: The country code for Ireland.
IL: The country code for Israel.
IM: The country code for the Isle of Man.
IN: The country code for India.
IO: The country code for the British Indian Ocean Territory.
IQ: The country code for Iraq.
IR: The country code for Iran.
IS: The country code for Iceland.
IT: The country code for Italy.
JE: The country code for Jersey.
JM: The country code for Jamaica.
JO: The country code for Jordan.
JP: The country code for Japan.
KE: The country code for Kenya.
KG: The country code for Kyrgyzstan.
KH: The country code for Cambodia.
KI: The country code for Kiribati.
KM: The country code for Comoros.
KN: The country code for Saint Kitts and Nevis.
KP: The country code for North Korea.
KR: The country code for South Korea.
KW: The country code for Kuwait.
KY: The country code for the Cayman Islands.
KZ: The country code for Kazakhstan.
LA: The country code for Laos.
LB: The country code for Lebanon.
LC: The country code for Saint Lucia.
LI: The country code for Liechtenstein.
LK: The country code for Sri Lanka.
LR: The country code for Liberia.
LS: The country code for Lesotho.
LT: The country code for Lithuania.
LU: The country code for Luxembourg.
LV: The country code for Latvia.
LY: The country code for Libya.
MA: The country code for Morocco.
MC: The country code for Monaco.
MD: The country code for Moldova.
ME: The country code for Montenegro.
MG: The country code for Madagascar.
MH: The country code for the Marshall Islands.
MK: The country code for North Macedonia.
ML: The country code for Mali.
MM: The country code for Myanmar.
MN: The country code for Mongolia.
MO: The country code for Macao.
MP: The country code for the Northern Mariana Islands.
MQ: The country code for Martinique.
MR: The country code for Mauritania.
MS: The country code for Montserrat.
MT: The country code for Malta.
MU: The country code for Mauritius.
MV: The country code for the Maldives.
MW: The country code for Malawi.
MX: The country code for Mexico.
MY: The country code for Malaysia.
MZ: The country code for Mozambique.
NA: The country code for Namibia.
NC: The country code for New Caledonia.
NE: The country code for Niger.
NF: The country code for Norfolk Island.
NG: The country code for Nigeria.
NI: The country code for Nicaragua.
NL: The country code for the Netherlands.
'NO': The country code for Norway.
NP: The country code for Nepal.
NR: The country code for Nauru.
NU: The country code for Niue.
NZ: The country code for New Zealand.
OM: The country code for Oman.
PA: The country code for Panama.
PE: The country code for Peru.
PF: The country code for French Polynesia.
PG: The country code for Papua New Guinea.
PH: The country code for the Philippines.
PK: The country code for Pakistan.
PL: The country code for Poland.
PM: The country code for Saint Pierre and Miquelon.
PR: The country code for Puerto Rico.
PS: The country code for Palestine.
PT: The country code for Portugal.
PW: The country code for Palau.
PY: The country code for Paraguay.
QA: The country code for Qatar.
RE: The country code for Réunion.
RO: The country code for Romania.
RS: The country code for Serbia.
RU: The country code for Russia.
RW: The country code for Rwanda.
SA: The country code for Saudi Arabia.
SB: The country code for the Solomon Islands.
SC: The country code for Seychelles.
SD: The country code for Sudan.
SE: The country code for Sweden.
SG: The country code for Singapore.
SH: The country code for Saint Helena.
SI: The country code for Slovenia.
SK: The country code for Slovakia.
SL: The country code for Sierra Leone.
SM: The country code for San Marino.
SN: The country code for Senegal.
SO: The country code for Somalia.
SR: The country code for Suriname.
SS: The country code for South Sudan.
ST: The country code for São Tomé and Príncipe.
SV: The country code for El Salvador.
SX: The country code for Sint Maarten.
SY: The country code for Syria.
SZ: The country code for Eswatini.
TC: The country code for the Turks and Caicos Islands.
TD: The country code for Chad.
TG: The country code for Togo.
TH: The country code for Thailand.
TJ: The country code for Tajikistan.
TK: The country code for Tokelau.
TL: The country code for East Timor.
TM: The country code for Turkmenistan.
TN: The country code for Tunisia.
TO: The country code for Tonga.
TR: The country code for Turkey.
TT: The country code for Trinidad and Tobago.
TV: The country code for Tuvalu.
TW: The country code for Taiwan.
TZ: The country code for Tanzania.
UA: The country code for Ukraine.
UG: The country code for Uganda.
UM: The country code for the United States Minor Outlying Islands.
US: The country code for the United States of America.
UY: The country code for Uruguay.
UZ: The country code for Uzbekistan.
VC: The country code for Saint Vincent and the Grenadines.
VE: The country code for Venezuela.
VG: The country code for the British Virgin Islands.
VI: The country code for the United States Virgin Islands.
VN: The country code for Vietnam.
VU: The country code for Vanuatu.
WF: The country code for Wallis and Futuna.
WS: The country code for Samoa.
XK: The country code for Kosovo.
YE: The country code for Yemen.
YT: The country code for Mayotte.
ZA: The country code for South Africa.
ZM: The country code for Zambia.
ZW: The country code for Zimbabwe.
description: Country. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsInputCountryCodesEnum'
addressPostalCode:
type: string
description: Postal code. Not required for create, but required for launch.
minLength: 1
maxLength: 10
uniqueItems: false
websiteUrl:
type: string
description: Primary website URL. Not required for create, but required for launch.
format: url
maxLength: 100
uniqueItems: false
contactFirstName:
type: string
description: First name of the responsible contact person. Not required for create, but required for launch.
minLength: 1
maxLength: 100
uniqueItems: false
contactSurname:
type: string
description: Surname of the responsible contact person. Not required for create, but required for launch.
minLength: 1
maxLength: 100
uniqueItems: false
sampleMessages:
description: Sample messages for each use case or message type sent by the brand. Not required for create, but required for launch.
minItems: 1
maxItems: 5
uniqueItems: false
type: array
items:
type: string
maxLength: 1024
minLength: 20
messagesVolume:
type: number
description: Messages volume. Not required for create, but required for launch.
uniqueItems: false
embeddedLink:
type: boolean
description: Flag indicating if URL links will be embedded within message payloads. Not required for create, but required for launch.
uniqueItems: false
embeddedPhone:
type: boolean
description: Flag indicating if phone numbers will be embedded within message payloads. Not required for create, but required for launch.
uniqueItems: false
ageGatedContent:
type: boolean
description: Indicates if the campaign content is restricted by age (e.g., alcohol, tobacco). Not required for create, but required for launch.
uniqueItems: false
directLending:
type: boolean
description: Indicates if the campaign involves direct financial lending, requiring stricter compliance. Not required for create, but required for launch.
uniqueItems: false
optInConfirmationMessage:
type: string
description: Opt-in confirmation message sent to users. Not required for create, but required for launch.
minLength: 20
maxLength: 1024
uniqueItems: false
helpMessage:
type: string
description: Help message of the campaign. Not required for create, but required for launch.
minLength: 20
maxLength: 1024
uniqueItems: false
callToActionMessage:
type: string
description: Call to action message of the campaign. Not required for create, but required for launch.
minLength: 40
maxLength: 4096
uniqueItems: false
ownershipType:
x-enumDescriptions:
PUBLIC: The brand is a publicly traded company.
description: Ownership type of the company. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsUsQuestionnaireOwnershipTypePublicEnum'
legalForm:
x-enumDescriptions:
CORPORATION: The company is registered as a Corporation.
description: Legal form of the company for public ownership type. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsPublicUsQuestionnaireBrandLegalFormsEnum'
taxIdCountry:
x-enumDescriptions:
AD: The country code for Andorra.
AE: The country code for the United Arab Emirates.
AF: The country code for Afghanistan.
AG: The country code for Antigua and Barbuda.
AI: The country code for Anguilla.
AL: The country code for Albania.
AM: The country code for Armenia.
AO: The country code for Angola.
AR: The country code for Argentina.
AS: The country code for American Samoa.
AT: The country code for Austria.
AU: The country code for Australia.
AW: The country code for Aruba.
AZ: The country code for Azerbaijan.
BA: The country code for Bosnia and Herzegovina.
BB: The country code for Barbados.
BD: The country code for Bangladesh.
BE: The country code for Belgium.
BF: The country code for Burkina Faso.
BG: The country code for Bulgaria.
BH: The country code for Bahrain.
BI: The country code for Burundi.
BJ: The country code for Benin.
BM: The country code for Bermuda.
BN: The country code for Brunei.
BO: The country code for Bolivia.
BQ: The country code for Bonaire.
BR: The country code for Brazil.
BS: The country code for the Bahamas.
BT: The country code for Bhutan.
BW: The country code for Botswana.
BY: The country code for Belarus.
BZ: The country code for Belize.
CA: The country code for Canada.
CD: The country code for the Democratic Republic of the Congo.
CF: The country code for the Central African Republic.
CG: The country code for the Republic of the Congo.
CH: The country code for Switzerland.
CI: The country code for the Ivory Coast.
CK: The country code for the Cook Islands.
CL: The country code for Chile.
CM: The country code for Cameroon.
CN: The country code for China.
CO: The country code for Colombia.
CR: The country code for Costa Rica.
CU: The country code for Cuba.
CV: The country code for Cape Verde.
CW: The country code for Curaçao.
CY: The country code for Cyprus.
CZ: The country code for the Czech Republic.
DE: The country code for Germany.
DJ: The country code for Djibouti.
DK: The country code for Denmark.
DM: The country code for Dominica.
DO: The country code for the Dominican Republic.
DZ: The country code for Algeria.
EC: The country code for Ecuador.
EE: The country code for Estonia.
EG: The country code for Egypt.
ER: The country code for Eritrea.
ES: The country code for Spain.
ET: The country code for Ethiopia.
FI: The country code for Finland.
FJ: The country code for Fiji.
FK: The country code for the Falkland Islands.
FM: The country code for Micronesia.
FO: The country code for the Faroe Islands.
FR: The country code for France.
GA: The country code for Gabon.
GB: The country code for the United Kingdom of Great Britain.
GD: The country code for Grenada.
GE: The country code for Georgia.
GF: The country code for French Guiana.
GG: The country code for Guernsey.
GH: The country code for Ghana.
GI: The country code for Gibraltar.
GL: The country code for Greenland.
GM: The country code for the Gambia.
GN: The country code for Guinea.
GP: The country code for Guadeloupe.
GQ: The country code for Equatorial Guinea.
GR: The country code for Greece.
GT: The country code for Guatemala.
GU: The country code for Guam.
GW: The country code for Guinea-Bissau.
GY: The country code for Guyana.
HK: The country code for Hong Kong.
HN: The country code for Honduras.
HR: The country code for Croatia.
HT: The country code for Haiti.
HU: The country code for Hungary.
ID: The country code for Indonesia.
IE: The country code for Ireland.
IL: The country code for Israel.
IM: The country code for the Isle of Man.
IN: The country code for India.
IO: The country code for the British Indian Ocean Territory.
IQ: The country code for Iraq.
IR: The country code for Iran.
IS: The country code for Iceland.
IT: The country code for Italy.
JE: The country code for Jersey.
JM: The country code for Jamaica.
JO: The country code for Jordan.
JP: The country code for Japan.
KE: The country code for Kenya.
KG: The country code for Kyrgyzstan.
KH: The country code for Cambodia.
KI: The country code for Kiribati.
KM: The country code for Comoros.
KN: The country code for Saint Kitts and Nevis.
KP: The country code for North Korea.
KR: The country code for South Korea.
KW: The country code for Kuwait.
KY: The country code for the Cayman Islands.
KZ: The country code for Kazakhstan.
LA: The country code for Laos.
LB: The country code for Lebanon.
LC: The country code for Saint Lucia.
LI: The country code for Liechtenstein.
LK: The country code for Sri Lanka.
LR: The country code for Liberia.
LS: The country code for Lesotho.
LT: The country code for Lithuania.
LU: The country code for Luxembourg.
LV: The country code for Latvia.
LY: The country code for Libya.
MA: The country code for Morocco.
MC: The country code for Monaco.
MD: The country code for Moldova.
ME: The country code for Montenegro.
MG: The country code for Madagascar.
MH: The country code for the Marshall Islands.
MK: The country code for North Macedonia.
ML: The country code for Mali.
MM: The country code for Myanmar.
MN: The country code for Mongolia.
MO: The country code for Macao.
MP: The country code for the Northern Mariana Islands.
MQ: The country code for Martinique.
MR: The country code for Mauritania.
MS: The country code for Montserrat.
MT: The country code for Malta.
MU: The country code for Mauritius.
MV: The country code for the Maldives.
MW: The country code for Malawi.
MX: The country code for Mexico.
MY: The country code for Malaysia.
MZ: The country code for Mozambique.
NA: The country code for Namibia.
NC: The country code for New Caledonia.
NE: The country code for Niger.
NF: The country code for Norfolk Island.
NG: The country code for Nigeria.
NI: The country code for Nicaragua.
NL: The country code for the Netherlands.
'NO': The country code for Norway.
NP: The country code for Nepal.
NR: The country code for Nauru.
NU: The country code for Niue.
NZ: The country code for New Zealand.
OM: The country code for Oman.
PA: The country code for Panama.
PE: The country code for Peru.
PF: The country code for French Polynesia.
PG: The country code for Papua New Guinea.
PH: The country code for the Philippines.
PK: The country code for Pakistan.
PL: The country code for Poland.
PM: The country code for Saint Pierre and Miquelon.
PR: The country code for Puerto Rico.
PS: The country code for Palestine.
PT: The country code for Portugal.
PW: The country code for Palau.
PY: The country code for Paraguay.
QA: The country code for Qatar.
RE: The country code for Réunion.
RO: The country code for Romania.
RS: The country code for Serbia.
RU: The country code for Russia.
RW: The country code for Rwanda.
SA: The country code for Saudi Arabia.
SB: The country code for the Solomon Islands.
SC: The country code for Seychelles.
SD: The country code for Sudan.
SE: The country code for Sweden.
SG: The country code for Singapore.
SH: The country code for Saint Helena.
SI: The country code for Slovenia.
SK: The country code for Slovakia.
SL: The country code for Sierra Leone.
SM: The country code for San Marino.
SN: The country code for Senegal.
SO: The country code for Somalia.
SR: The country code for Suriname.
SS: The country code for South Sudan.
ST: The country code for São Tomé and Príncipe.
SV: The country code for El Salvador.
SX: The country code for Sint Maarten.
SY: The country code for Syria.
SZ: The country code for Eswatini.
TC: The country code for the Turks and Caicos Islands.
TD: The country code for Chad.
TG: The country code for Togo.
TH: The country code for Thailand.
TJ: The country code for Tajikistan.
TK: The country code for Tokelau.
TL: The country code for East Timor.
TM: The country code for Turkmenistan.
TN: The country code for Tunisia.
TO: The country code for Tonga.
TR: The country code for Turkey.
TT: The country code for Trinidad and Tobago.
TV: The country code for Tuvalu.
TW: The country code for Taiwan.
TZ: The country code for Tanzania.
UA: The country code for Ukraine.
UG: The country code for Uganda.
UM: The country code for the United States Minor Outlying Islands.
UY: The country code for Uruguay.
UZ: The country code for Uzbekistan.
VC: The country code for Saint Vincent and the Grenadines.
VE: The country code for Venezuela.
VG: The country code for the British Virgin Islands.
VI: The country code for the United States Virgin Islands.
VN: The country code for Vietnam.
VU: The country code for Vanuatu.
WF: The country code for Wallis and Futuna.
WS: The country code for Samoa.
XK: The country code for Kosovo.
YE: The country code for Yemen.
YT: The country code for Mayotte.
ZA: The country code for South Africa.
ZM: The country code for Zambia.
ZW: The country code for Zimbabwe.
description: Country of the company's tax registration for non-US taxId. This value controls conditional validation for taxId and addressState. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsInputCountryCodesNonUsEnum'
taxId:
type: string
description: Tax registration identifier associated with the provided legal company name for non-US taxIdCountry. Validated as a generic string up to 25 characters. Not required for create, but required for launch.
minLength: 1
maxLength: 25
uniqueItems: false
stockExchange:
type: string
description: Primary home country stock exchange abbreviation. Validated when ownershipType=PUBLIC.
minLength: 1
maxLength: 10
uniqueItems: false
stockSymbol:
type: string
description: Primary home country stock symbol associated with stock exchange. Validated when ownershipType=PUBLIC.
minLength: 1
maxLength: 6
uniqueItems: false
description: 'Documentation schema for US brand campaign answers: taxIdCountry!=US, ownershipType=PUBLIC.'
required:
- companyLegalName
- companyPhoneNumber
- companyEmailAddress
- brandName
- brandIndustry
- addressLine
- addressCity
- addressCountry
- addressPostalCode
- websiteUrl
- contactFirstName
- contactSurname
- sampleMessages
- messagesVolume
- embeddedLink
- embeddedPhone
- ageGatedContent
- directLending
- optInConfirmationMessage
- helpMessage
- callToActionMessage
- ownershipType
- legalForm
- taxIdCountry
- taxId
- stockExchange
- stockSymbol
RcsBrandRegistrationProcessStatusesEnum:
type: string
enum:
- ARCHIVED
- COMPLETED
- INCOMPLETE
- MANUAL_REVIEW
- NEW
- PENDING
- PENDING_REVIEW
- REJECTED
- UNRECOGNIZED
- UNSPECIFIED
description: Current status of the brand registration process.
RcsSenderDetailsInputDto:
type: object
properties:
brand:
description: Brand information.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsBrandInputDto'
testNumbers:
maxItems: 200
uniqueItems: true
description: Phone numbers for testing. An agent can send 20 tester requests each day with a total maximum of 200 tester requests.
type: array
items:
type: string
format: e.164 phone number
countries:
type: array
x-enumDescriptions:
AT: The country code for Austria.
BE: The country code for Belgium.
BR: The country code for Brazil.
CA: The country code for Canada.
CZ: The country code for the Czech Republic.
DK: The country code for Denmark.
FI: The country code for Finland.
FR: The country code for France.
DE: The country code for Germany.
GR: The country code for Greece.
HU: The country code for Hungary.
IT: The country code for Italy.
LT: The country code for Lithuania.
MX: The country code for Mexico.
NL: The country code for the Netherlands.
'NO': The country code for Norway.
PE: The country code for Peru.
PL: The country code for Poland.
PT: The country code for Portugal.
SG: The country code for Singapore.
SK: The country code for Slovakia.
ES: The country code for Spain.
SE: The country code for Sweden.
US: The country code for the United States of America.
GB: The country code for the United Kingdom of Great Britain.
minItems: 1
uniqueItems: true
description: List of two-letter country codes in ISO 3166 standard, specifying the countries to launch RCS sender in.
items:
$ref: '#/components/schemas/RcsInputRcsCountryCodesEnum'
questionnaire:
description: "\n Launch questionnaire.\n\n The launch questionnaire is based on information required by different Suppliers and Operators. As such, especially the country specific, may be subject to change.\n "
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireInputDto'
RcsSenderDetailsQuestionnaireDto:
type: object
properties:
general:
description: General launch questions
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireGeneralDto'
verification:
description: Verification questions.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireVerificationDto'
gb:
description: Launch questions specific for UK.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireGBDto'
fr:
description: Launch questions specific for France.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireFRDto'
us:
oneOf:
- $ref: '#/components/schemas/RcsBrandCampaignSenderDetailsQuestionnaireUSDto'
- $ref: '#/components/schemas/RcsDefaultSenderDetailsQuestionnaireUSDto'
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireUSDto'
description: Launch questions specific for US.
uniqueItems: false
required:
- general
- verification
RcsInputRcsCountryCodesEnum:
type: string
enum:
- AT
- BE
- BR
- CA
- CZ
- DK
- FI
- FR
- DE
- GR
- HU
- IT
- LT
- MX
- NL
- 'NO'
- PE
- PL
- PT
- SG
- SK
- ES
- SE
- US
- GB
description: List of two-letter country codes in ISO 3166 standard, specifying the countries to launch RCS sender in.
RcsSenderDetailsQuestionnaireFRDto:
type: object
properties:
questions:
readOnly: true
description: Launch questions specific for France.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireFRQuestionsDto'
answers:
description: Launch answers specific for France.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireFRAnswersDto'
required:
- questions
- answers
RcsUpdateSenderDetailsQuestionnaireInputDto:
type: object
properties:
general:
description: General launch questions
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsUpdateSenderDetailsQuestionnaireGeneralInputDto'
verification:
description: Verification questions.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsUpdateSenderDetailsQuestionnaireVerificationInputDto'
gb:
description: Launch questions specific for UK.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsUpdateSenderDetailsQuestionnaireGBInputDto'
fr:
description: Launch questions specific for France.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsUpdateSenderDetailsQuestionnaireFRInputDto'
us:
description: Launch questions specific for US.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsUpdateSenderDetailsQuestionnaireUSInputDto'
RcsSenderDetailsQuestionnaireVerificationAnswersInputDto:
type: object
properties:
name:
type: string
minLength: 1
description: Name of verification contact. Not required for create, but required for launch.
uniqueItems: false
email:
type: string
format: email
maxLength: 100
description: Email of verification contact. Not required for create, but required for launch.
uniqueItems: false
title:
type: string
minLength: 1
maxLength: 100
description: Title of verification contact.
uniqueItems: false
website:
type: string
format: url
description: Website of verification contact. Not required for create, but required for launch.
uniqueItems: false
phone:
type: string
pattern: ^(?:\+|00)\d{6,15}$
minLength: 1
maxLength: 17
description: Phone number of verification contact in E.164 format. Required for launch when the sender uses the US country questionnaire version v2, otherwise optional.
uniqueItems: false
partner:
description: Brand partner contact details. Only supported for reseller (ASP) accounts; otherwise ignored.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireVerificationPartnerAnswersInputDto'
description: Verification answers for senders without the US country questionnaire.
required:
- name
- email
- website
RcsInputCountryCodesNonUsEnum:
type: string
enum:
- AD
- AE
- AF
- AG
- AI
- AL
- AM
- AO
- AR
- AS
- AT
- AU
- AW
- AZ
- BA
- BB
- BD
- BE
- BF
- BG
- BH
- BI
- BJ
- BM
- BN
- BO
- BQ
- BR
- BS
- BT
- BW
- BY
- BZ
- CA
- CD
- CF
- CG
- CH
- CI
- CK
- CL
- CM
- CN
- CO
- CR
- CU
- CV
- CW
- CY
- CZ
- DE
- DJ
- DK
- DM
- DO
- DZ
- EC
- EE
- EG
- ER
- ES
- ET
- FI
- FJ
- FK
- FM
- FO
- FR
- GA
- GB
- GD
- GE
- GF
- GG
- GH
- GI
- GL
- GM
- GN
- GP
- GQ
- GR
- GT
- GU
- GW
- GY
- HK
- HN
- HR
- HT
- HU
- ID
- IE
- IL
- IM
- IN
- IO
- IQ
- IR
- IS
- IT
- JE
- JM
- JO
- JP
- KE
- KG
- KH
- KI
- KM
- KN
- KP
- KR
- KW
- KY
- KZ
- LA
- LB
- LC
- LI
- LK
- LR
- LS
- LT
- LU
- LV
- LY
- MA
- MC
- MD
- ME
- MG
- MH
- MK
- ML
- MM
- MN
- MO
- MP
- MQ
- MR
- MS
- MT
- MU
- MV
- MW
- MX
- MY
- MZ
- NA
- NC
- NE
- NF
- NG
- NI
- NL
- 'NO'
- NP
- NR
- NU
- NZ
- OM
- PA
- PE
- PF
- PG
- PH
- PK
- PL
- PM
- PR
- PS
- PT
- PW
- PY
- QA
- RE
- RO
- RS
- RU
- RW
- SA
- SB
- SC
- SD
- SE
- SG
- SH
- SI
- SK
- SL
- SM
- SN
- SO
- SR
- SS
- ST
- SV
- SX
- SY
- SZ
- TC
- TD
- TG
- TH
- TJ
- TK
- TL
- TM
- TN
- TO
- TR
- TT
- TV
- TW
- TZ
- UA
- UG
- UM
- UY
- UZ
- VC
- VE
- VG
- VI
- VN
- VU
- WF
- WS
- XK
- YE
- YT
- ZA
- ZM
- ZW
description: Country of the company's tax registration for non-US taxId. This value controls conditional validation for taxId and addressState. Not required for create, but required for launch.
RcsBrandCampaignSenderDetailsQuestionnaireUSAnswersDto:
type: object
properties:
ownershipType:
x-enumDescriptions:
PRIVATE: The brand is a privately owned entity.
PUBLIC: The brand is a publicly traded company.
description: Ownership type of the company. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsUsQuestionnaireOwnershipTypeEnum'
companyLegalName:
type: string
description: The registered legal name of the company. Not required for create, but required for launch.
uniqueItems: false
companyPhoneNumber:
type: string
description: The registered phone number of the company. Not required for create, but required for launch.
uniqueItems: false
companyEmailAddress:
type: string
format: email
description: The email address of the company. Not required for create, but required for launch.
uniqueItems: false
brandName:
type: string
description: Brand name or Doing Business As (DBA). Must be legally associated with the provided legal company name. Not required for create, but required for launch.
uniqueItems: false
brandIndustry:
x-enumDescriptions:
AGRICULTURE: The brand operates within the agriculture sector.
COMMUNICATION: The brand operates within the communication industry.
CONSTRUCTION: The brand operates within the construction sector.
EDUCATION: The brand operates within the education field.
ENERGY: The brand operates within the energy and utilities sector.
ENTERTAINMENT: The brand operates within the entertainment and media industry.
FINANCIAL: The brand operates within the financial services sector.
GAMBLING: The brand operates within the gambling or betting industry.
GOVERNMENT: The brand is a government or public administration entity.
HEALTHCARE: The brand operates within the healthcare and medical sector.
HOSPITALITY: The brand operates within hospitality, tourism, or food services.
HUMAN_RESOURCES: The brand operates within human resources and staffing services.
INSURANCE: The brand operates within the insurance sector.
LEGAL: The brand operates within legal services.
MANUFACTURING: The brand operates within the manufacturing sector.
NON_GOVERNMENTAL_ORGANIZATION: The brand is a non-governmental organization (NGO).
POLITICAL: The brand is a political organization or campaign.
POSTAL: The brand operates within postal, courier, or delivery services.
PROFESSIONAL: The brand provides professional, scientific, or technical services.
REAL_ESTATE: The brand operates within the real estate market.
RETAIL: The brand operates within retail or wholesale commerce.
TECHNOLOGY: The brand operates within the technology and software sector.
TRANSPORTATION: The brand operates within transportation or logistics services.
description: Sector or industry of business. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsUsQuestionnaireBrandIndustriesEnum'
legalForm:
x-enumDescriptions:
CORPORATION: The company is registered as a Corporation.
LIMITED_LIABILITY_COMPANY: The company is registered as a Limited Liability Company (LLC).
PARTNERSHIP: The company is registered as a Partnership.
S_CORPORATION: The company is registered as an S Corporation.
description: Legal form of the company.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsUsQuestionnaireBrandLegalFormsEnum'
taxIdCountry:
x-enumDescriptions:
AD: The country code for Andorra.
AE: The country code for the United Arab Emirates.
AF: The country code for Afghanistan.
AG: The country code for Antigua and Barbuda.
AI: The country code for Anguilla.
AL: The country code for Albania.
AM: The country code for Armenia.
AO: The country code for Angola.
AR: The country code for Argentina.
AS: The country code for American Samoa.
AT: The country code for Austria.
AU: The country code for Australia.
AW: The country code for Aruba.
AZ: The country code for Azerbaijan.
BA: The country code for Bosnia and Herzegovina.
BB: The country code for Barbados.
BD: The country code for Bangladesh.
BE: The country code for Belgium.
BF: The country code for Burkina Faso.
BG: The country code for Bulgaria.
BH: The country code for Bahrain.
BI: The country code for Burundi.
BJ: The country code for Benin.
BM: The country code for Bermuda.
BN: The country code for Brunei.
BO: The country code for Bolivia.
BQ: The country code for Bonaire.
BR: The country code for Brazil.
BS: The country code for the Bahamas.
BT: The country code for Bhutan.
BW: The country code for Botswana.
BY: The country code for Belarus.
BZ: The country code for Belize.
CA: The country code for Canada.
CD: The country code for the Democratic Republic of the Congo.
CF: The country code for the Central African Republic.
CG: The country code for the Republic of the Congo.
CH: The country code for Switzerland.
CI: The country code for the Ivory Coast.
CK: The country code for the Cook Islands.
CL: The country code for Chile.
CM: The country code for Cameroon.
CN: The country code for China.
CO: The country code for Colombia.
CR: The country code for Costa Rica.
CU: The country code for Cuba.
CV: The country code for Cape Verde.
CW: The country code for Curaçao.
CY: The country code for Cyprus.
CZ: The country code for the Czech Republic.
DE: The country code for Germany.
DJ: The country code for Djibouti.
DK: The country code for Denmark.
DM: The country code for Dominica.
DO: The country code for the Dominican Republic.
DZ: The country code for Algeria.
EC: The country code for Ecuador.
EE: The country code for Estonia.
EG: The country code for Egypt.
ER: The country code for Eritrea.
ES: The country code for Spain.
ET: The country code for Ethiopia.
FI: The country code for Finland.
FJ: The country code for Fiji.
FK: The country code for the Falkland Islands.
FM: The country code for Micronesia.
FO: The country code for the Faroe Islands.
FR: The country code for France.
GA: The country code for Gabon.
GB: The country code for the United Kingdom of Great Britain.
GD: The country code for Grenada.
GE: The country code for Georgia.
GF: The country code for French Guiana.
GG: The country code for Guernsey.
GH: The country code for Ghana.
GI: The country code for Gibraltar.
GL: The country code for Greenland.
GM: The country code for the Gambia.
GN: The country code for Guinea.
GP: The country code for Guadeloupe.
GQ: The country code for Equatorial Guinea.
GR: The country code for Greece.
GT: The country code for Guatemala.
GU: The country code for Guam.
GW: The country code for Guinea-Bissau.
GY: The country code for Guyana.
HK: The country code for Hong Kong.
HN: The country code for Honduras.
HR: The country code for Croatia.
HT: The country code for Haiti.
HU: The country code for Hungary.
ID: The country code for Indonesia.
IE: The country code for Ireland.
IL: The country code for Israel.
IM: The country code for the Isle of Man.
IN: The country code for India.
IO: The country code for the British Indian Ocean Territory.
IQ: The country code for Iraq.
IR: The country code for Iran.
IS: The country code for Iceland.
IT: The country code for Italy.
JE: The country code for Jersey.
JM: The country code for Jamaica.
JO: The country code for Jordan.
JP: The country code for Japan.
KE: The country code for Kenya.
KG: The country code for Kyrgyzstan.
KH: The country code for Cambodia.
KI: The country code for Kiribati.
KM: The country code for Comoros.
KN: The country code for Saint Kitts and Nevis.
KP: The country code for North Korea.
KR: The country code for South Korea.
KW: The country code for Kuwait.
KY: The country code for the Cayman Islands.
KZ: The country code for Kazakhstan.
LA: The country code for Laos.
LB: The country code for Lebanon.
LC: The country code for Saint Lucia.
LI: The country code for Liechtenstein.
LK: The country code for Sri Lanka.
LR: The country code for Liberia.
LS: The country code for Lesotho.
LT: The country code for Lithuania.
LU: The country code for Luxembourg.
LV: The country code for Latvia.
LY: The country code for Libya.
MA: The country code for Morocco.
MC: The country code for Monaco.
MD: The country code for Moldova.
ME: The country code for Montenegro.
MG: The country code for Madagascar.
MH: The country code for the Marshall Islands.
MK: The country code for North Macedonia.
ML: The country code for Mali.
MM: The country code for Myanmar.
MN: The country code for Mongolia.
MO: The country code for Macao.
MP: The country code for the Northern Mariana Islands.
MQ: The country code for Martinique.
MR: The country code for Mauritania.
MS: The country code for Montserrat.
MT: The country code for Malta.
MU: The country code for Mauritius.
MV: The country code for the Maldives.
MW: The country code for Malawi.
MX: The country code for Mexico.
MY: The country code for Malaysia.
MZ: The country code for Mozambique.
NA: The country code for Namibia.
NC: The country code for New Caledonia.
NE: The country code for Niger.
NF: The country code for Norfolk Island.
NG: The country code for Nigeria.
NI: The country code for Nicaragua.
NL: The country code for the Netherlands.
'NO': The country code for Norway.
NP: The country code for Nepal.
NR: The country code for Nauru.
NU: The country code for Niue.
NZ: The country code for New Zealand.
OM: The country code for Oman.
PA: The country code for Panama.
PE: The country code for Peru.
PF: The country code for French Polynesia.
PG: The country code for Papua New Guinea.
PH: The country code for the Philippines.
PK: The country code for Pakistan.
PL: The country code for Poland.
PM: The country code for Saint Pierre and Miquelon.
PR: The country code for Puerto Rico.
PS: The country code for Palestine.
PT: The country code for Portugal.
PW: The country code for Palau.
PY: The country code for Paraguay.
QA: The country code for Qatar.
RE: The country code for Réunion.
RO: The country code for Romania.
RS: The country code for Serbia.
RU: The country code for Russia.
RW: The country code for Rwanda.
SA: The country code for Saudi Arabia.
SB: The country code for the Solomon Islands.
SC: The country code for Seychelles.
SD: The country code for Sudan.
SE: The country code for Sweden.
SG: The country code for Singapore.
SH: The country code for Saint Helena.
SI: The country code for Slovenia.
SK: The country code for Slovakia.
SL: The country code for Sierra Leone.
SM: The country code for San Marino.
SN: The country code for Senegal.
SO: The country code for Somalia.
SR: The country code for Suriname.
SS: The country code for South Sudan.
ST: The country code for São Tomé and Príncipe.
SV: The country code for El Salvador.
SX: The country code for Sint Maarten.
SY: The country code for Syria.
SZ: The country code for Eswatini.
TC: The country code for the Turks and Caicos Islands.
TD: The country code for Chad.
TG: The country code for Togo.
TH: The country code for Thailand.
TJ: The country code for Tajikistan.
TK: The country code for Tokelau.
TL: The country code for East Timor.
TM: The country code for Turkmenistan.
TN: The country code for Tunisia.
TO: The country code for Tonga.
TR: The country code for Turkey.
TT: The country code for Trinidad and Tobago.
TV: The country code for Tuvalu.
TW: The country code for Taiwan.
TZ: The country code for Tanzania.
UA: The country code for Ukraine.
UG: The country code for Uganda.
UM: The country code for the United States Minor Outlying Islands.
US: The country code for the United States of America.
UY: The country code for Uruguay.
UZ: The country code for Uzbekistan.
VC: The country code for Saint Vincent and the Grenadines.
VE: The country code for Venezuela.
VG: The country code for the British Virgin Islands.
VI: The country code for the United States Virgin Islands.
VN: The country code for Vietnam.
VU: The country code for Vanuatu.
WF: The country code for Wallis and Futuna.
WS: The country code for Samoa.
XK: The country code for Kosovo.
YE: The country code for Yemen.
YT: The country code for Mayotte.
ZA: The country code for South Africa.
ZM: The country code for Zambia.
ZW: The country code for Zimbabwe.
description: Country of the company's tax registration.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsInputCountryCodesEnum'
taxId:
type: string
description: Tax registration identifier associated with the provided legal company name.
uniqueItems: false
addressLine:
type: string
description: Street address line. Not required for create, but required for launch.
uniqueItems: false
addressCity:
type: string
description: City. Not required for create, but required for launch.
uniqueItems: false
addressCountry:
x-enumDescriptions:
AD: The country code for Andorra.
AE: The country code for the United Arab Emirates.
AF: The country code for Afghanistan.
AG: The country code for Antigua and Barbuda.
AI: The country code for Anguilla.
AL: The country code for Albania.
AM: The country code for Armenia.
AO: The country code for Angola.
AR: The country code for Argentina.
AS: The country code for American Samoa.
AT: The country code for Austria.
AU: The country code for Australia.
AW: The country code for Aruba.
AZ: The country code for Azerbaijan.
BA: The country code for Bosnia and Herzegovina.
BB: The country code for Barbados.
BD: The country code for Bangladesh.
BE: The country code for Belgium.
BF: The country code for Burkina Faso.
BG: The country code for Bulgaria.
BH: The country code for Bahrain.
BI: The country code for Burundi.
BJ: The country code for Benin.
BM: The country code for Bermuda.
BN: The country code for Brunei.
BO: The country code for Bolivia.
BQ: The country code for Bonaire.
BR: The country code for Brazil.
BS: The country code for the Bahamas.
BT: The country code for Bhutan.
BW: The country code for Botswana.
BY: The country code for Belarus.
BZ: The country code for Belize.
CA: The country code for Canada.
CD: The country code for the Democratic Republic of the Congo.
CF: The country code for the Central African Republic.
CG: The country code for the Republic of the Congo.
CH: The country code for Switzerland.
CI: The country code for the Ivory Coast.
CK: The country code for the Cook Islands.
CL: The country code for Chile.
CM: The country code for Cameroon.
CN: The country code for China.
CO: The country code for Colombia.
CR: The country code for Costa Rica.
CU: The country code for Cuba.
CV: The country code for Cape Verde.
CW: The country code for Curaçao.
CY: The country code for Cyprus.
CZ: The country code for the Czech Republic.
DE: The country code for Germany.
DJ: The country code for Djibouti.
DK: The country code for Denmark.
DM: The country code for Dominica.
DO: The country code for the Dominican Republic.
DZ: The country code for Algeria.
EC: The country code for Ecuador.
EE: The country code for Estonia.
EG: The country code for Egypt.
ER: The country code for Eritrea.
ES: The country code for Spain.
ET: The country code for Ethiopia.
FI: The country code for Finland.
FJ: The country code for Fiji.
FK: The country code for the Falkland Islands.
FM: The country code for Micronesia.
FO: The country code for the Faroe Islands.
FR: The country code for France.
GA: The country code for Gabon.
GB: The country code for the United Kingdom of Great Britain.
GD: The country code for Grenada.
GE: The country code for Georgia.
GF: The country code for French Guiana.
GG: The country code for Guernsey.
GH: The country code for Ghana.
GI: The country code for Gibraltar.
GL: The country code for Greenland.
GM: The country code for the Gambia.
GN: The country code for Guinea.
GP: The country code for Guadeloupe.
GQ: The country code for Equatorial Guinea.
GR: The country code for Greece.
GT: The country code for Guatemala.
GU: The country code for Guam.
GW: The country code for Guinea-Bissau.
GY: The country code for Guyana.
HK: The country code for Hong Kong.
HN: The country code for Honduras.
HR: The country code for Croatia.
HT: The country code for Haiti.
HU: The country code for Hungary.
ID: The country code for Indonesia.
IE: The country code for Ireland.
IL: The country code for Israel.
IM: The country code for the Isle of Man.
IN: The country code for India.
IO: The country code for the British Indian Ocean Territory.
IQ: The country code for Iraq.
IR: The country code for Iran.
IS: The country code for Iceland.
IT: The country code for Italy.
JE: The country code for Jersey.
JM: The country code for Jamaica.
JO: The country code for Jordan.
JP: The country code for Japan.
KE: The country code for Kenya.
KG: The country code for Kyrgyzstan.
KH: The country code for Cambodia.
KI: The country code for Kiribati.
KM: The country code for Comoros.
KN: The country code for Saint Kitts and Nevis.
KP: The country code for North Korea.
KR: The country code for South Korea.
KW: The country code for Kuwait.
KY: The country code for the Cayman Islands.
KZ: The country code for Kazakhstan.
LA: The country code for Laos.
LB: The country code for Lebanon.
LC: The country code for Saint Lucia.
LI: The country code for Liechtenstein.
LK: The country code for Sri Lanka.
LR: The country code for Liberia.
LS: The country code for Lesotho.
LT: The country code for Lithuania.
LU: The country code for Luxembourg.
LV: The country code for Latvia.
LY: The country code for Libya.
MA: The country code for Morocco.
MC: The country code for Monaco.
MD: The country code for Moldova.
ME: The country code for Montenegro.
MG: The country code for Madagascar.
MH: The country code for the Marshall Islands.
MK: The country code for North Macedonia.
ML: The country code for Mali.
MM: The country code for Myanmar.
MN: The country code for Mongolia.
MO: The country code for Macao.
MP: The country code for the Northern Mariana Islands.
MQ: The country code for Martinique.
MR: The country code for Mauritania.
MS: The country code for Montserrat.
MT: The country code for Malta.
MU: The country code for Mauritius.
MV: The country code for the Maldives.
MW: The country code for Malawi.
MX: The country code for Mexico.
MY: The country code for Malaysia.
MZ: The country code for Mozambique.
NA: The country code for Namibia.
NC: The country code for New Caledonia.
NE: The country code for Niger.
NF: The country code for Norfolk Island.
NG: The country code for Nigeria.
NI: The country code for Nicaragua.
NL: The country code for the Netherlands.
'NO': The country code for Norway.
NP: The country code for Nepal.
NR: The country code for Nauru.
NU: The country code for Niue.
NZ: The country code for New Zealand.
OM: The country code for Oman.
PA: The country code for Panama.
PE: The country code for Peru.
PF: The country code for French Polynesia.
PG: The country code for Papua New Guinea.
PH: The country code for the Philippines.
PK: The country code for Pakistan.
PL: The country code for Poland.
PM: The country code for Saint Pierre and Miquelon.
PR: The country code for Puerto Rico.
PS: The country code for Palestine.
PT: The country code for Portugal.
PW: The country code for Palau.
PY: The country code for Paraguay.
QA: The country code for Qatar.
RE: The country code for Réunion.
RO: The country code for Romania.
RS: The country code for Serbia.
RU: The country code for Russia.
RW: The country code for Rwanda.
SA: The country code for Saudi Arabia.
SB: The country code for the Solomon Islands.
SC: The country code for Seychelles.
SD: The country code for Sudan.
SE: The country code for Sweden.
SG: The country code for Singapore.
SH: The country code for Saint Helena.
SI: The country code for Slovenia.
SK: The country code for Slovakia.
SL: The country code for Sierra Leone.
SM: The country code for San Marino.
SN: The country code for Senegal.
SO: The country code for Somalia.
SR: The country code for Suriname.
SS: The country code for South Sudan.
ST: The country code for São Tomé and Príncipe.
SV: The country code for El Salvador.
SX: The country code for Sint Maarten.
SY: The country code for Syria.
SZ: The country code for Eswatini.
TC: The country code for the Turks and Caicos Islands.
TD: The country code for Chad.
TG: The country code for Togo.
TH: The country code for Thailand.
TJ: The country code for Tajikistan.
TK: The country code for Tokelau.
TL: The country code for East Timor.
TM: The country code for Turkmenistan.
TN: The country code for Tunisia.
TO: The country code for Tonga.
TR: The country code for Turkey.
TT: The country code for Trinidad and Tobago.
TV: The country code for Tuvalu.
TW: The country code for Taiwan.
TZ: The country code for Tanzania.
UA: The country code for Ukraine.
UG: The country code for Uganda.
UM: The country code for the United States Minor Outlying Islands.
US: The country code for the United States of America.
UY: The country code for Uruguay.
UZ: The country code for Uzbekistan.
VC: The country code for Saint Vincent and the Grenadines.
VE: The country code for Venezuela.
VG: The country code for the British Virgin Islands.
VI: The country code for the United States Virgin Islands.
VN: The country code for Vietnam.
VU: The country code for Vanuatu.
WF: The country code for Wallis and Futuna.
WS: The country code for Samoa.
XK: The country code for Kosovo.
YE: The country code for Yemen.
YT: The country code for Mayotte.
ZA: The country code for South Africa.
ZM: The country code for Zambia.
ZW: The country code for Zimbabwe.
description: Country. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsInputCountryCodesEnum'
addressState:
x-enumDescriptions:
AK: The State of Alaska.
AL: The State of Alabama.
AR: The State of Arkansas.
AS: The US territory of American Samoa.
AZ: The State of Arizona.
CA: The State of California.
CO: The State of Colorado.
CT: The State of Connecticut.
DC: The District of Columbia.
DE: The State of Delaware.
FL: The State of Florida.
GA: The State of Georgia.
GU: The US territory of Guam.
HI: The State of Hawaii.
IA: The State of Iowa.
ID: The State of Idaho.
IL: The State of Illinois.
IN: The State of Indiana.
KS: The State of Kansas.
KY: The Commonwealth of Kentucky.
LA: The State of Louisiana.
MA: The Commonwealth of Massachusetts.
MD: The State of Maryland.
ME: The State of Maine.
MI: The State of Michigan.
MN: The State of Minnesota.
MO: The State of Missouri.
MP: The US Commonwealth of the Northern Mariana Islands.
MS: The State of Mississippi.
MT: The State of Montana.
NC: The State of North Carolina.
ND: The State of North Dakota.
NE: The State of Nebraska.
NH: The State of New Hampshire.
NJ: The State of New Jersey.
NM: The State of New Mexico.
NV: The State of Nevada.
NY: The State of New York.
OH: The State of Ohio.
OK: The State of Oklahoma.
OR: The State of Oregon.
PA: The Commonwealth of Pennsylvania.
PR: The US territory of Puerto Rico.
RI: The State of Rhode Island.
SC: The State of South Carolina.
SD: The State of South Dakota.
TN: The State of Tennessee.
TX: The State of Texas.
UT: The State of Utah.
VA: The Commonwealth of Virginia.
VI: The US territory of the Virgin Islands.
VT: The State of Vermont.
WA: The State of Washington.
WI: The State of Wisconsin.
WV: The State of West Virginia.
WY: The State of Wyoming.
description: State (US only). Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsUsStatesEnum'
addressPostalCode:
type: string
description: Postal code. Not required for create, but required for launch.
uniqueItems: false
websiteUrl:
type: string
description: Primary website URL. Not required for create, but required for launch.
uniqueItems: false
contactFirstName:
type: string
description: First name of the responsible contact person. Not required for create, but required for launch.
uniqueItems: false
contactSurname:
type: string
description: Surname of the responsible contact person. Not required for create, but required for launch.
uniqueItems: false
stockExchange:
type: string
description: Primary home country stock exchange abbreviation. Not required for create, but required for launch.
uniqueItems: false
stockSymbol:
type: string
description: Primary home country stock symbol associated with stock exchange. Not required for create, but required for launch.
uniqueItems: false
sampleMessages:
description: Sample messages for each use case or message type sent by the brand. Not required for create, but required for launch.
uniqueItems: false
type: array
items:
type: string
messagesVolume:
type: number
description: Messages volume. Not required for create, but required for launch.
uniqueItems: false
embeddedLink:
type: boolean
description: Flag indicating if URL links will be embedded within message payloads. Not required for create, but required for launch.
uniqueItems: false
embeddedPhone:
type: boolean
description: Flag indicating if phone numbers will be embedded within message payloads. Not required for create, but required for launch.
uniqueItems: false
ageGatedContent:
type: boolean
description: Indicates if the campaign content is restricted by age (e.g., alcohol, tobacco). Not required for create, but required for launch.
uniqueItems: false
directLending:
type: boolean
description: Indicates if the campaign involves direct financial lending, requiring stricter compliance. Not required for create, but required for launch.
uniqueItems: false
optInConfirmationMessage:
type: string
description: Opt-in confirmation message sent to users. Not required for create, but required for launch.
uniqueItems: false
helpMessage:
type: string
description: Help message of the campaign. Not required for create, but required for launch.
uniqueItems: false
callToActionMessage:
type: string
description: Call to action message of the campaign. Not required for create, but required for launch.
uniqueItems: false
RcsUsQuestionnaireVersionsEnum:
type: string
enum:
- v1
- v2
RcsSupplierDetailsDto:
type: object
properties:
google:
description: Google supplier details.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSupplierDetailsGoogleDto'
RcsSupplierDetailsGoogleDto:
type: object
properties:
agentId:
type: string
description: Google agent id.
uniqueItems: false
brandId:
type: string
description: Google brand id.
uniqueItems: false
RcsUpdateSenderDetailsQuestionnaireAnswerMetadataInputDto:
type: object
properties:
ignore:
type:
- string
- 'null'
minLength: 1
description: Ignore given string on launch, e.g. custom delimiter. If null the value will be deleted.
uniqueItems: false
RcsSenderDetailsQuestionnaireVerificationDto:
type: object
properties:
questions:
readOnly: true
description: Verification questions.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireVerificationQuestionsDto'
answers:
description: Verification answers.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireVerificationAnswersDto'
required:
- questions
- answers
RcsSenderDetailsQuestionnaireGBDto:
type: object
properties:
questions:
readOnly: true
description: Launch questions specific for UK.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireGBQuestionsDto'
answers:
description: Launch answers specific for UK.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireGBAnswersDto'
required:
- questions
- answers
RcsSenderDetailsQuestionnaireGBAnswersDto:
type: object
properties:
brandIndustry:
type: string
description: Sector or industry of business. Not required for create, but required for launch.
uniqueItems: false
companyLegalName:
type: string
description: The registered legal name of the company. Not required for create, but required for launch.
uniqueItems: false
companyRegistrationNumber:
type: string
description: The company registration number.
uniqueItems: false
fullCompanyAddress:
type: string
description: Full company address.
uniqueItems: false
fullCompanyAddressMetadata:
description: Metadata for specified answer.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireAnswerMetadataDto'
messagesVolume:
type: string
description: Messages volume. Not required for create, but required for launch.
uniqueItems: false
messagesFrequency:
type: string
description: Messages frequency.
uniqueItems: false
campaignLength:
type: string
description: Length of campaign.
deprecated: true
uniqueItems: false
RcsSenderDetailsQuestionnaireVerificationQuestionsDto:
type: object
properties:
name:
readOnly: true
description: Name of verification contact.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
email:
readOnly: true
description: Email of verification contact.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
title:
readOnly: true
description: Title of verification contact.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
website:
readOnly: true
description: Website of verification contact.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
phone:
readOnly: true
description: Phone number of verification contact in E.164 format.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
partner:
readOnly: true
description: Brand partner contact details. Only supported for reseller (ASP) accounts; otherwise ignored.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireVerificationPartnerQuestionsDto'
required:
- name
- email
- title
- website
- phone
- partner
RcsUpdateSenderDetailsQuestionnaireFRInputDto:
type: object
properties:
answers:
description: Launch answers specific for France.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsUpdateSenderDetailsQuestionnaireFRAnswersInputDto'
required:
- answers
RcsNonUsPrivateBrandCampaignSenderDetailsQuestionnaireUSQuestionsDto:
type: object
properties:
ownershipType:
readOnly: true
description: Ownership type of the company. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
companyLegalName:
readOnly: true
description: The registered legal name of the company. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
companyPhoneNumber:
readOnly: true
description: The registered phone number of the company. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
companyEmailAddress:
readOnly: true
description: The email address of the company. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
brandName:
readOnly: true
description: Brand name or Doing Business As (DBA). Must be legally associated with the provided legal company name. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
brandIndustry:
readOnly: true
description: Sector or industry of business. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
legalForm:
readOnly: true
description: Legal form of the company.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
taxIdCountry:
readOnly: true
description: Country of the company's tax registration.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
taxId:
readOnly: true
description: Tax registration identifier associated with the provided legal company name.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
addressLine:
readOnly: true
description: Street address line. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
addressCity:
readOnly: true
description: City. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
addressCountry:
readOnly: true
description: Country. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
addressPostalCode:
readOnly: true
description: Postal code. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
websiteUrl:
readOnly: true
description: Primary website URL. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
contactFirstName:
readOnly: true
description: First name of the responsible contact person. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
contactSurname:
readOnly: true
description: Surname of the responsible contact person. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
sampleMessages:
readOnly: true
description: Sample messages for each use case or message type sent by the brand. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
messagesVolume:
readOnly: true
description: Messages volume. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
embeddedLink:
readOnly: true
description: Flag indicating if URL links will be embedded within message payloads. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
embeddedPhone:
readOnly: true
description: Flag indicating if phone numbers will be embedded within message payloads. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
ageGatedContent:
readOnly: true
description: Indicates if the campaign content is restricted by age (e.g., alcohol, tobacco). Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
directLending:
readOnly: true
description: Indicates if the campaign involves direct financial lending, requiring stricter compliance. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
optInConfirmationMessage:
readOnly: true
description: Opt-in confirmation message sent to users. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
helpMessage:
readOnly: true
description: Help message of the campaign. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
callToActionMessage:
readOnly: true
description: Call to action message of the campaign. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
required:
- ownershipType
- companyLegalName
- companyPhoneNumber
- companyEmailAddress
- brandName
- brandIndustry
- legalForm
- taxIdCountry
- taxId
- addressLine
- addressCity
- addressCountry
- addressPostalCode
- websiteUrl
- contactFirstName
- contactSurname
- sampleMessages
- messagesVolume
- embeddedLink
- embeddedPhone
- ageGatedContent
- directLending
- optInConfirmationMessage
- helpMessage
- callToActionMessage
RcsSenderDetailsQuestionnaireVerificationAnswersDto:
type: object
properties:
name:
type: string
description: Name of verification contact.
uniqueItems: false
email:
type: string
format: email
description: Email of verification contact.
uniqueItems: false
title:
type: string
description: Title of verification contact.
uniqueItems: false
website:
type: string
format: url
description: Website of verification contact.
uniqueItems: false
phone:
type: string
description: Phone number of verification contact in E.164 format.
uniqueItems: false
partner:
description: Brand partner contact details. Only supported for reseller (ASP) accounts; otherwise ignored.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireVerificationPartnerAnswersDto'
RcsCommentTypeEnum:
type: string
const: CREATED
RcsUpdateSenderInputDto:
type: object
properties:
details:
description: Sender details and information.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsUpdateSenderDetailsInputDto'
required:
- details
RcsWebsiteInputDto:
type: object
properties:
label:
type: string
minLength: 0
maxLength: 25
description: Contact website label.
uniqueItems: false
url:
type: string
format: url
maxLength: 255
description: Contact website address.
uniqueItems: false
required:
- label
- url
RcsWebsiteDto:
type: object
properties:
label:
type: string
description: Contact website label.
uniqueItems: false
url:
type: string
format: url
description: Contact website address.
uniqueItems: false
required:
- label
- url
RcsSenderDetailsQuestionnaireUSAnswersDto:
type: object
properties:
companyLegalName:
type: string
description: The registered legal name of the company. Not required for create, but required for launch.
uniqueItems: false
ein:
type: string
description: Employer Identification Number (EIN).
uniqueItems: false
brandIndustry:
type: string
description: Sector or industry of business. Not required for create, but required for launch.
uniqueItems: false
fullCompanyAddress:
type: string
description: Full company address.
uniqueItems: false
fullCompanyAddressMetadata:
description: Metadata for specified answer.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireAnswerMetadataDto'
smsCampaign:
type: string
description: US SMS campaign used as fallback.
uniqueItems: false
messagesVolume:
type: string
description: Messages volume. Not required for create, but required for launch.
uniqueItems: false
description: SenderDetailsQuestionnaireUSAnswersDto is deprecated and will be removed in future versions. Please use BrandCampaignSenderDetailsQuestionnaireUSAnswersDto instead.
RcsSenderDetailsQuestionnaireGeneralInputDto:
type: object
properties:
answers:
description: Launch answers
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireGeneralAnswersInputDto'
required:
- answers
RcsSenderDetailsQuestionnaireUSDto:
type: object
properties:
questions:
readOnly: true
description: Launch questions specific for US.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireUSQuestionsDto'
answers:
description: Launch answers specific for US.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireUSAnswersDto'
description: SenderDetailsQuestionnaireUSDto is deprecated and will be removed in future versions. Please use BrandCampaignSenderDetailsQuestionnaireUSDto instead.
required:
- questions
- answers
RcsSenderDetailsQuestionnaireGBAnswersInputDto:
type: object
properties:
brandIndustry:
type: string
minLength: 1
description: Sector or industry of business. Not required for create, but required for launch.
uniqueItems: false
companyLegalName:
type: string
minLength: 1
description: The registered legal name of the company. Not required for create, but required for launch.
uniqueItems: false
companyRegistrationNumber:
type: string
minLength: 1
description: The company registration number.
uniqueItems: false
fullCompanyAddress:
type: string
minLength: 1
description: Full company address.
uniqueItems: false
fullCompanyAddressMetadata:
description: Metadata for specified answer.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireAnswerMetadataInputDto'
messagesVolume:
type: string
minLength: 1
description: Messages volume. Not required for create, but required for launch.
uniqueItems: false
messagesFrequency:
type: string
minLength: 1
description: Messages frequency.
uniqueItems: false
campaignLength:
type: string
minLength: 1
description: Length of campaign.
deprecated: true
uniqueItems: false
RcsSenderDetailsQuestionnaireQuestionObjectDto:
type: object
properties:
question:
type: string
readOnly: true
description: Human readable question.
uniqueItems: false
suggestedAnswers:
readOnly: true
description: Suggested answers to the question.
uniqueItems: false
type: array
items:
type: string
required:
- question
- suggestedAnswers
RcsSenderDetailsQuestionnaireFRQuestionsDto:
type: object
properties:
fullCompanyAddress:
readOnly: true
description: Full company address.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
siren:
readOnly: true
description: Company directory identification system number.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
required:
- fullCompanyAddress
- siren
RcsEmailInputDto:
type: object
properties:
label:
type: string
minLength: 0
maxLength: 25
description: Contact email label.
uniqueItems: false
address:
type: string
format: email
description: Contact email address.
uniqueItems: false
required:
- label
- address
RcsUsQuestionnaireOwnershipTypePrivateEnum:
type: string
const: PRIVATE
description: Ownership type of the company. Not required for create, but required for launch.
RcsUpdateSenderDetailsQuestionnaireGeneralInputDto:
type: object
properties:
answers:
description: Launch answers
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsUpdateSenderDetailsQuestionnaireGeneralAnswersInputDto'
required:
- answers
RcsUsSenderDetailsQuestionnaireVerificationAnswersInputDto:
type: object
properties:
name:
type: string
minLength: 1
description: Name of verification contact. Not required for create, but required for launch.
uniqueItems: false
email:
type: string
format: email
maxLength: 100
description: Email of verification contact. Not required for create, but required for launch.
uniqueItems: false
title:
type: string
minLength: 1
maxLength: 100
description: Title of verification contact.
uniqueItems: false
website:
type: string
format: url
description: Website of verification contact. Not required for create, but required for launch.
uniqueItems: false
partner:
description: Brand partner contact details. Only supported for reseller (ASP) accounts; otherwise ignored.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireVerificationPartnerAnswersInputDto'
phone:
type: string
pattern: ^(?:\+|00)\d{6,15}$
minLength: 1
maxLength: 17
description: Phone number of verification contact in E.164 format. Required for launch when the sender uses the US country questionnaire version v2, otherwise optional.
uniqueItems: false
description: Verification answers for senders with the US country questionnaire.
required:
- name
- email
- website
- phone
RcsConversationAppChannelIntegrationStatusEnum:
type: string
enum:
- ACTIVE
- FAILING
- PENDING
- UNRECOGNIZED
description: Status of the channel credentials integration.
RcsPapiErrorDto:
type: object
properties:
errorCode:
type: string
description: Error code identifying the type of error.
uniqueItems: false
message:
type: string
description: Human-readable error message.
uniqueItems: false
resolution:
type: string
description: Suggested resolution for the error.
uniqueItems: false
additionalInformation:
type: object
additionalProperties:
oneOf:
- type: array
items:
type: string
description: Additional context about the error.
uniqueItems: false
required:
- errorCode
- message
- resolution
RcsBrandRegistrationProcessDto:
type: object
properties:
id:
type: string
description: Unique identifier for the brand registration process.
uniqueItems: false
status:
x-enumDescriptions:
ARCHIVED: The brand registration process has been archived.
COMPLETED: The brand registration process has finished successfully.
INCOMPLETE: The brand registration process is missing required information.
MANUAL_REVIEW: The brand registration process requires manual review.
NEW: The brand registration process is created but has not yet started.
PENDING: The brand registration process is waiting for the next action.
PENDING_REVIEW: The brand registration process is currently under review.
REJECTED: The brand registration process has been reviewed and rejected.
UNRECOGNIZED: The value returned by an upstream system is not recognized by this API version.
UNSPECIFIED: The brand registration process status is not specified.
description: Current status of the brand registration process.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsBrandRegistrationProcessStatusesEnum'
required:
- id
- status
RcsSenderDetailsQuestionnaireVerificationPartnerAnswersInputDto:
type: object
properties:
companyName:
type: string
minLength: 1
maxLength: 100
description: Company name of the brand partner.
uniqueItems: false
contactName:
type: string
minLength: 1
maxLength: 100
description: Name of the contact person of the brand partner.
uniqueItems: false
contactEmailAddress:
type: string
format: email
maxLength: 100
description: Email of the contact person of the brand partner.
uniqueItems: false
RcsSenderDetailsQuestionnaireGBQuestionsDto:
type: object
properties:
brandIndustry:
readOnly: true
description: Sector or industry of business. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
companyLegalName:
readOnly: true
description: The registered legal name of the company. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
companyRegistrationNumber:
readOnly: true
description: The company registration number.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
fullCompanyAddress:
readOnly: true
description: Full company address.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
messagesVolume:
readOnly: true
description: Messages volume. Not required for create, but required for launch.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
messagesFrequency:
readOnly: true
description: Messages frequency.
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
campaignLength:
readOnly: true
description: Length of campaign.
deprecated: true
uniqueItems: false
allOf:
- $ref: '#/components/schemas/RcsSenderDetailsQuestionnaireQuestionObjectDto'
required:
- brandIndustry
- companyLegalName
- companyRegistrationNumber
- fullCompanyAddress
- messagesVolume
- messagesFrequency
- campaignLength
RcsBrandRegistrationStatusesEnum:
type: string
enum:
- ARCHIVED
- COMPLETED
- DRAFT
- UNRECOGNIZED
- UNSPECIFIED
description: Current status of the brand registration.
RcsSenderList:
type: object
properties:
senders:
type: array
description: List of RCS senders
items:
$ref: '#/components/schemas/RcsSender'
CreateRcsSenderRequest:
type: object
required:
- displayName
properties:
displayName:
type: string
description: The display name
description:
type: string
description: The sender description
logoUrl:
type: string
format: uri
description: Logo URL
heroImageUrl:
type: string
format: uri
description: Hero image URL
phoneNumber:
type: string
description: Associated phone number
color:
type: string
description: Brand color
website:
type: string
format: uri
description: Website URL
privacyPolicy:
type: string
format: uri
description: Privacy policy URL
termsOfService:
type: string
format: uri
description: Terms of service URL
UpdateRcsSenderRequest:
type: object
properties:
displayName:
type: string
description: Updated display name
description:
type: string
description: Updated description
logoUrl:
type: string
format: uri
description: Updated logo URL
heroImageUrl:
type: string
format: uri
description: Updated hero image URL
RcsSender:
type: object
properties:
id:
type: string
description: The unique sender identifier
displayName:
type: string
description: The display name shown to recipients
description:
type: string
description: The sender description
logoUrl:
type: string
format: uri
description: URL to the sender logo
heroImageUrl:
type: string
format: uri
description: URL to the hero image
phoneNumber:
type: string
description: The associated phone number
color:
type: string
description: Brand color in hex format
website:
type: string
format: uri
description: Brand website URL
privacyPolicy:
type: string
format: uri
description: Privacy policy URL
termsOfService:
type: string
format: uri
description: Terms of service URL
status:
type: string
description: The current sender status
createTime:
type: string
format: date-time
description: When the sender was created
updateTime:
type: string
format: date-time
description: When the sender was last updated
parameters:
ProjectId:
name: project_id
in: path
required: true
description: The unique project identifier
schema:
type: string
SenderId:
name: sender_id
in: path
required: true
description: The unique sender identifier
schema:
type: string
securitySchemes:
BasicAuth:
type: http
scheme: basic
BearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
OAuth2Production:
type: oauth2
description: OAuth2 authorization for production
flows:
clientCredentials:
tokenUrl: https://auth.sinch.com/oauth2/token
scopes:
'-': '-'
oAuth2:
type: oauth2
description: OAuth 2.0 client credentials flow.
flows:
clientCredentials:
tokenUrl: https://auth.sinch.com/oauth2/token
scopes: {}
basicAuth:
type: http
scheme: basic
description: Key ID as username and key secret as password.
externalDocs:
description: Sinch Provisioning API Documentation
url: https://developers.sinch.com/docs/provisioning-api
x-refined-from:
- sinch-provisioning-api-openapi.yaml
- original-sinch-provisioning-openapi.yml
x-explorer-enabled: false
x-samples-languages:
- curl
- java
- csharp
- node
- php
x-original-swagger-version: '2.0'