RCS Senders

The RCS sender endpoint offers a way for you to manage your RCS senders that can be used with the Conversation API.

List all senders in project GA

Returns a paginated list of senders for the specified project. If no page token is supplied then the first `50` will be returned.

SecurityBasic or OAuth2.0

Request

path Parameters

projectId

required

string

The unique ID of the project. You can find this on the Sinch Dashboard.

query Parameters

pageToken	string The page token if retrieving the next page from a previous query.
pageSize	number [ 1 .. 100 ] The page size requested.
filterConversationApiAppId	string Optional query for sender by Conversation API app id.
filterSenderName	string Optional query for sender by name.
filterStates	Array of strings (RcsSenderStatesEnum) Optionally query for sender by states. Items Enum: "DRAFT" "IN_PROGRESS" "IN_TEST" "LAUNCHED" "LAUNCHING" "PREPARING_LAUNCH" "UNLAUNCHED" "UNKNOWN" "UNRECOGNIZED"
sortColumn	string (RcsSenderSortColumnsEnum) Optional query for sender sort column. Enum: "CREATED" "MODIFIED" "NAME" "STATE"
sortDirection	string (RcsSortDirectionsEnum) Optional query for sender sort direction. Enum: "ASC" "DESC"

Responses

200

List of senders

Response Schema: application/json

totalSize required	number Total size of the entries matching the search query.
pageSize required	number Requested size of the page.
required	Array of objects (RcsSenderDto) List of senders.
previousPageToken	string Encoded token to use in list request to fetch previous batch of entries.
nextPageToken	string Encoded token to use in list request to fetch next batch of entries.

400

BadRequest

401

Unauthorized

403

Forbidden

429

TooManyRequests

500

InternalServerError

get/v1/projects/{projectId}/rcs/senders

Request samples

Node.js
C#
Java
Python
curl

Response samples

application/json

Response with senders.

{"totalSize": 2,
"pageSize": 50,
"senders": [{"id": "cf11794a-6a5e-4a12-b103-da79bd378bf1",
"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": "LAUNCHED",
"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": "LAUNCHED",
"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": "EE",
"status": "PENDING",
"modified": "2023-01-19t13:11:08.204Z"
},
{"name": "Three",
"status": "LAUNCHED",
"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"
}
]
}
],
"region": "EU",
"billingCategory": "BASIC_MESSAGE",
"useCase": "OTP",
"hostingRegion": "EUROPE",
"authName": "yurwN6123asd",
"authToken": "ejiiqJtDyurwN6jLze8v",
"conversationApiApp": "4CF9CE97504C4A468F4610919D17ECC1",
"conversationApiAppDetails": {"id": "4CF9CE97504C4A468F4610919D17ECC1",
"projectId": "ea026751-3edf-40a9-ad93-1b382bd60a78",
"region": "EU"
},
"created": "2023-01-19t13:11:08.204Z",
"modified": "2023-01-19t13:11:08.204Z"
},
{"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": "LAUNCHED",
"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": "LAUNCHED",
"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": "EE",
"status": "PENDING",
"modified": "2023-01-19t13:11:08.204Z"
},
{"name": "Three",
"status": "LAUNCHED",
"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"
}
]
}
],
"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": "+48 777-777-777"
},
{"label": "label-1",
"number": "+48 888-888-888"
},
{"label": "label-2",
"number": "+48 999-999-999"
}
],
"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": ["+48 777-777-777"
],
"countries": ["FR",
"GB",
"ES"
],
"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": [ ]
}
},
"answers": {"name": "Exam Ple",
"email": "example@email.com",
"title": "Head Example",
"website": "https://example.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"
]
},
"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",
"messagesVolume": "10K - 100K messages",
"messagesFrequency": "Once per month",
"campaignLength": "6 months"
}
},
"fr": {"questions": {"fullCompanyAddress": {"question": "Full Company Address",
"suggestedAnswers": [ ]
},
"usersAmount": {"question": "How many users are your agent expected to reach?",
"suggestedAnswers": ["0 - 1K users",
"1K - 10K users",
"10k - 100K users",
"100K+ users"
]
},
"startDate": {"question": "When will your agent start sending messages to your users?",
"suggestedAnswers": ["Today",
"In a week",
"In a month",
"Within 3 months"
]
}
},
"answers": {"fullCompanyAddress": "Skeppsbron 1-split-211 20-split-Malmö",
"fullCompanyAddressMetadata": {"ignore": "-split-"
},
"usersAmount": "1K - 10K users",
"startDate": "In a month"
}
},
"es": {"questions": {"firstMessage": {"question": "What is the first message sent from the agent to the user?",
"suggestedAnswers": ["Thank you for opting in.",
"Thank you for subscribing.",
"We have registered your request."
]
}
},
"answers": {"firstMessage": "Hello, it's me I was wondering..."
}
}
}
},
"region": "EU",
"billingCategory": "BASIC_MESSAGE",
"useCase": "OTP",
"hostingRegion": "EUROPE",
"authName": "yurwN6123asd",
"authToken": "ejiiqJtDyurwN6jLze8v",
"conversationApiApp": "4CF9CE97504C4A468F4610919D17ECC1",
"conversationApiAppDetails": {"id": "4CF9CE97504C4A468F4610919D17ECC1",
"projectId": "ea026751-3edf-40a9-ad93-1b382bd60a78",
"region": "EU"
},
"created": "2023-01-19t13:11:08.204Z",
"modified": "2023-01-19t13:11:08.204Z"
}
]
}

Create sender for project GA

Returns a sender for a project.

SecurityBasic or OAuth2.0

Request

path Parameters

projectId

required

string

The unique ID of the project. You can find this on the Sinch Dashboard.

Request Body schema: application/json
required

Sender data

region required	string Region sender is provisioned in. Enum: "BR" "EU" "US"
billingCategory required	string Billing category. Enum: "BASIC_MESSAGE" "CONVERSATIONAL" "CONVERSATIONAL_LEGACY" "SINGLE_MESSAGE"
useCase required	string Use case. Enum: "MULTIUSE" "OTP" "PROMOTIONAL" "TRANSACTIONAL"
	object Sender details and information.

Responses

201

Sender

Response Schema: application/json

id required	string The unique ID of the sender.
region required	string Region sender is provisioned in. Enum: "BR" "EU" "IN" "US" "REGION_UNSPECIFIED" "UNRECOGNIZED"
billingCategory required	string Billing category. Enum: "BASIC_MESSAGE" "CONVERSATIONAL" "CONVERSATIONAL_LEGACY" "SINGLE_MESSAGE" "UNRECOGNIZED"
useCase required	string Use case. Enum: "MULTIUSE" "OTP" "PROMOTIONAL" "TRANSACTIONAL" "UNRECOGNIZED"
hostingRegion required	string Internal Google hosting region Enum: "ASIA_PACIFIC" "EUROPE" "NORTH_AMERICA" "UNRECOGNIZED"
conversationApiApp	string Deprecated If set, the Conversation API App ID the sender is connected to.
	object If set, the details of the Conversation API App the sender is connected to.
state	string The current state of the sender. Enum: "DRAFT" "IN_PROGRESS" "IN_TEST" "LAUNCHED" "LAUNCHING" "PREPARING_LAUNCH" "UNLAUNCHED" "UNKNOWN" "UNRECOGNIZED"
	Array of objects (RcsTestNumberStateDto) Test phone numbers states.
	Array of objects (RcsCountryStatusDto) Countries status.
	object Sender details and information.
authName	string The name is needed to connect the sender to a Conversation API App.
authToken	string The token is needed to connect the sender to a Conversation API App.
created	string The UTC Date Time in ISO 8601 for when the sender was created.
modified	string The UTC Date Time in ISO 8601 for when the sender was last modified.

400

BadRequest

401

Unauthorized

403

Forbidden

404

NotFound

409

Conflict

429

TooManyRequests

500

InternalServerError

Callbacks

postSender status updated

postSender operator status updated

postComment on sender

post/v1/projects/{projectId}/rcs/senders

Request samples

application/json

  Example body request to create a sender.

{"region": "EU",
"billingCategory": "BASIC_MESSAGE",
"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": "+48 777-777-777"
},
{"label": "label-1",
"number": "+48 888-888-888"
},
{"label": "label-2",
"number": "+48 999-999-999"
}
],
"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": ["+48 777-777-777"
],
"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": "example@email.com",
"title": "Head Example",
"website": "https://example.com"
}
},
"gb": {"answers": {"brandIndustry": "Automotive",
"messagesVolume": "10K - 100K messages",
"messagesFrequency": "Once per month",
"campaignLength": "6 months"
}
},
"fr": {"answers": {"fullCompanyAddress": "Skeppsbron 1-split-211 20-split-Malmö",
"fullCompanyAddressMetadata": {"ignore": "-split-"
},
"usersAmount": "1K - 10K users",
"startDate": "In a month"
}
},
"es": {"answers": {"firstMessage": "Hello, it's me I was wondering..."
}
}
}
}
}

Response samples

application/json

Response when successfully creating a sender.

{"id": "cf11794a-6a5e-4a12-b103-da79bd378bf1",
"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": "LAUNCHED",
"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": "LAUNCHED",
"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": "EE",
"status": "PENDING",
"modified": "2023-01-19t13:11:08.204Z"
},
{"name": "Three",
"status": "LAUNCHED",
"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"
}
]
}
],
"region": "EU",
"billingCategory": "BASIC_MESSAGE",
"useCase": "OTP",
"hostingRegion": "EUROPE",
"authName": "yurwN6123asd",
"authToken": "ejiiqJtDyurwN6jLze8v",
"conversationApiApp": "4CF9CE97504C4A468F4610919D17ECC1",
"conversationApiAppDetails": {"id": "4CF9CE97504C4A468F4610919D17ECC1",
"projectId": "ea026751-3edf-40a9-ad93-1b382bd60a78",
"region": "EU"
},
"created": "2023-01-19t13:11:08.204Z",
"modified": "2023-01-19t13:11:08.204Z"
}

Callback payload samples

application/json

{"type": "RCS_SENDER_STATUS_UPDATED",
"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": "LAUNCHED",
"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": "LAUNCHED",
"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": "EE",
"status": "PENDING",
"modified": "2023-01-19t13:11:08.204Z"
},
{"name": "Three",
"status": "LAUNCHED",
"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"
}
]
}
],
"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": "+48 777-777-777"
},
{"label": "label-1",
"number": "+48 888-888-888"
},
{"label": "label-2",
"number": "+48 999-999-999"
}
],
"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": ["+48 777-777-777"
],
"countries": ["FR",
"GB",
"ES"
],
"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": [ ]
}
},
"answers": {"name": "Exam Ple",
"email": "example@email.com",
"title": "Head Example",
"website": "https://example.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"
]
},
"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",
"messagesVolume": "10K - 100K messages",
"messagesFrequency": "Once per month",
"campaignLength": "6 months"
}
},
"fr": {"questions": {"fullCompanyAddress": {"question": "Full Company Address",
"suggestedAnswers": [ ]
},
"usersAmount": {"question": "How many users are your agent expected to reach?",
"suggestedAnswers": ["0 - 1K users",
"1K - 10K users",
"10k - 100K users",
"100K+ users"
]
},
"startDate": {"question": "When will your agent start sending messages to your users?",
"suggestedAnswers": ["Today",
"In a week",
"In a month",
"Within 3 months"
]
}
},
"answers": {"fullCompanyAddress": "Skeppsbron 1-split-211 20-split-Malmö",
"fullCompanyAddressMetadata": {"ignore": "-split-"
},
"usersAmount": "1K - 10K users",
"startDate": "In a month"
}
},
"es": {"questions": {"firstMessage": {"question": "What is the first message sent from the agent to the user?",
"suggestedAnswers": ["Thank you for opting in.",
"Thank you for subscribing.",
"We have registered your request."
]
}
},
"answers": {"firstMessage": "Hello, it's me I was wondering..."
}
}
}
},
"region": "EU",
"billingCategory": "BASIC_MESSAGE",
"useCase": "OTP",
"hostingRegion": "EUROPE",
"authName": "yurwN6123asd",
"authToken": "ejiiqJtDyurwN6jLze8v",
"conversationApiApp": "4CF9CE97504C4A468F4610919D17ECC1",
"conversationApiAppDetails": {"id": "4CF9CE97504C4A468F4610919D17ECC1",
"projectId": "ea026751-3edf-40a9-ad93-1b382bd60a78",
"region": "EU"
},
"created": "2023-01-19t13:11:08.204Z",
"modified": "2023-01-19t13:11:08.204Z"
},
"previousState": "IN_PROGRESS",
"currentState": "IN_TEST"
}

Get sender for project GA

Returns a sender for a project.

SecurityBasic or OAuth2.0

Request

path Parameters

projectId required	string The unique ID of the project. You can find this on the Sinch Dashboard.
senderId required	string The unique ID of the sender.

Responses

200

Sender

Response Schema: application/json

id required	string The unique ID of the sender.
region required	string Region sender is provisioned in. Enum: "BR" "EU" "IN" "US" "REGION_UNSPECIFIED" "UNRECOGNIZED"
billingCategory required	string Billing category. Enum: "BASIC_MESSAGE" "CONVERSATIONAL" "CONVERSATIONAL_LEGACY" "SINGLE_MESSAGE" "UNRECOGNIZED"
useCase required	string Use case. Enum: "MULTIUSE" "OTP" "PROMOTIONAL" "TRANSACTIONAL" "UNRECOGNIZED"
hostingRegion required	string Internal Google hosting region Enum: "ASIA_PACIFIC" "EUROPE" "NORTH_AMERICA" "UNRECOGNIZED"
conversationApiApp	string Deprecated If set, the Conversation API App ID the sender is connected to.
	object If set, the details of the Conversation API App the sender is connected to.
state	string The current state of the sender. Enum: "DRAFT" "IN_PROGRESS" "IN_TEST" "LAUNCHED" "LAUNCHING" "PREPARING_LAUNCH" "UNLAUNCHED" "UNKNOWN" "UNRECOGNIZED"
	Array of objects (RcsTestNumberStateDto) Test phone numbers states.
	Array of objects (RcsCountryStatusDto) Countries status.
	object Sender details and information.
authName	string The name is needed to connect the sender to a Conversation API App.
authToken	string The token is needed to connect the sender to a Conversation API App.
created	string The UTC Date Time in ISO 8601 for when the sender was created.
modified	string The UTC Date Time in ISO 8601 for when the sender was last modified.

401

Unauthorized

403

Forbidden

404

NotFound

429

TooManyRequests

500

InternalServerError

get/v1/projects/{projectId}/rcs/senders/{senderId}

Request samples

Node.js
C#
Java
Python
curl

Response samples

application/json

Response with a sender.

{"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": "LAUNCHED",
"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": "LAUNCHED",
"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": "EE",
"status": "PENDING",
"modified": "2023-01-19t13:11:08.204Z"
},
{"name": "Three",
"status": "LAUNCHED",
"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"
}
]
}
],
"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": "+48 777-777-777"
},
{"label": "label-1",
"number": "+48 888-888-888"
},
{"label": "label-2",
"number": "+48 999-999-999"
}
],
"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": ["+48 777-777-777"
],
"countries": ["FR",
"GB",
"ES"
],
"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": [ ]
}
},
"answers": {"name": "Exam Ple",
"email": "example@email.com",
"title": "Head Example",
"website": "https://example.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"
]
},
"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",
"messagesVolume": "10K - 100K messages",
"messagesFrequency": "Once per month",
"campaignLength": "6 months"
}
},
"fr": {"questions": {"fullCompanyAddress": {"question": "Full Company Address",
"suggestedAnswers": [ ]
},
"usersAmount": {"question": "How many users are your agent expected to reach?",
"suggestedAnswers": ["0 - 1K users",
"1K - 10K users",
"10k - 100K users",
"100K+ users"
]
},
"startDate": {"question": "When will your agent start sending messages to your users?",
"suggestedAnswers": ["Today",
"In a week",
"In a month",
"Within 3 months"
]
}
},
"answers": {"fullCompanyAddress": "Skeppsbron 1-split-211 20-split-Malmö",
"fullCompanyAddressMetadata": {"ignore": "-split-"
},
"usersAmount": "1K - 10K users",
"startDate": "In a month"
}
},
"es": {"questions": {"firstMessage": {"question": "What is the first message sent from the agent to the user?",
"suggestedAnswers": ["Thank you for opting in.",
"Thank you for subscribing.",
"We have registered your request."
]
}
},
"answers": {"firstMessage": "Hello, it's me I was wondering..."
}
}
}
},
"region": "EU",
"billingCategory": "BASIC_MESSAGE",
"useCase": "OTP",
"hostingRegion": "EUROPE",
"authName": "yurwN6123asd",
"authToken": "ejiiqJtDyurwN6jLze8v",
"conversationApiApp": "4CF9CE97504C4A468F4610919D17ECC1",
"conversationApiAppDetails": {"id": "4CF9CE97504C4A468F4610919D17ECC1",
"projectId": "ea026751-3edf-40a9-ad93-1b382bd60a78",
"region": "EU"
},
"created": "2023-01-19t13:11:08.204Z",
"modified": "2023-01-19t13:11:08.204Z"
}

Update sender for project GA

Returns updated sender for a project.

SecurityBasic or OAuth2.0

Request

path Parameters

projectId required	string The unique ID of the project. You can find this on the Sinch Dashboard.
senderId required	string

Request Body schema: application/json
required

Sender data update

required

object

Sender details and information.

	object Brand information.
testNumbers	Array of strings or null <e.164 phone number> <= 20 items unique Phone numbers for testing. If null the value will be deleted.
countries	Array of strings or null (RcsInputCountryCodes) non-empty unique 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. Enum: "AT" "BE" "BR" "CA" "CZ" "DK" "FR" "DE" "IT" "MX" "NL" "NO" "PT" "SG" "SK" "ES" "SE" "US" "GB"
	object Launch questionnaire

Responses

200

Sender

Response Schema: application/json

id required	string The unique ID of the sender.
region required	string Region sender is provisioned in. Enum: "BR" "EU" "IN" "US" "REGION_UNSPECIFIED" "UNRECOGNIZED"
billingCategory required	string Billing category. Enum: "BASIC_MESSAGE" "CONVERSATIONAL" "CONVERSATIONAL_LEGACY" "SINGLE_MESSAGE" "UNRECOGNIZED"
useCase required	string Use case. Enum: "MULTIUSE" "OTP" "PROMOTIONAL" "TRANSACTIONAL" "UNRECOGNIZED"
hostingRegion required	string Internal Google hosting region Enum: "ASIA_PACIFIC" "EUROPE" "NORTH_AMERICA" "UNRECOGNIZED"
conversationApiApp	string Deprecated If set, the Conversation API App ID the sender is connected to.
	object If set, the details of the Conversation API App the sender is connected to.
state	string The current state of the sender. Enum: "DRAFT" "IN_PROGRESS" "IN_TEST" "LAUNCHED" "LAUNCHING" "PREPARING_LAUNCH" "UNLAUNCHED" "UNKNOWN" "UNRECOGNIZED"
	Array of objects (RcsTestNumberStateDto) Test phone numbers states.
	Array of objects (RcsCountryStatusDto) Countries status.
	object Sender details and information.
authName	string The name is needed to connect the sender to a Conversation API App.
authToken	string The token is needed to connect the sender to a Conversation API App.
created	string The UTC Date Time in ISO 8601 for when the sender was created.
modified	string The UTC Date Time in ISO 8601 for when the sender was last modified.

400

BadRequest

401

Unauthorized

403

Forbidden

404

NotFound

429

TooManyRequests

500

InternalServerError

patch/v1/projects/{projectId}/rcs/senders/{senderId}

Request samples

application/json

  Example body request to update a sender.

{"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": "+48 777-777-777"
},
{"label": "label-1",
"number": "+48 888-888-888"
},
{"label": "label-2",
"number": "+48 999-999-999"
}
],
"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": ["+48 777-777-777"
],
"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": "example@email.com",
"title": "Head Example",
"website": "https://example.com"
}
},
"gb": {"answers": {"brandIndustry": "Automotive",
"messagesVolume": "10K - 100K messages",
"messagesFrequency": "Once per month",
"campaignLength": "6 months"
}
},
"fr": {"answers": {"fullCompanyAddress": "Skeppsbron 1-split-211 20-split-Malmö",
"fullCompanyAddressMetadata": {"ignore": "-split-"
},
"usersAmount": "1K - 10K users",
"startDate": "In a month"
}
},
"es": {"answers": {"firstMessage": "Hello, it's me I was wondering..."
}
}
}
}
}

Response samples

application/json

Response when successfully updated a sender.

{"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": "LAUNCHED",
"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": "LAUNCHED",
"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": "EE",
"status": "PENDING",
"modified": "2023-01-19t13:11:08.204Z"
},
{"name": "Three",
"status": "LAUNCHED",
"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"
}
]
}
],
"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": "+48 777-777-777"
},
{"label": "label-1",
"number": "+48 888-888-888"
},
{"label": "label-2",
"number": "+48 999-999-999"
}
],
"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": ["+48 777-777-777"
],
"countries": ["FR",
"GB",
"ES"
],
"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": [ ]
}
},
"answers": {"name": "Exam Ple",
"email": "example@email.com",
"title": "Head Example",
"website": "https://example.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"
]
},
"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",
"messagesVolume": "10K - 100K messages",
"messagesFrequency": "Once per month",
"campaignLength": "6 months"
}
},
"fr": {"questions": {"fullCompanyAddress": {"question": "Full Company Address",
"suggestedAnswers": [ ]
},
"usersAmount": {"question": "How many users are your agent expected to reach?",
"suggestedAnswers": ["0 - 1K users",
"1K - 10K users",
"10k - 100K users",
"100K+ users"
]
},
"startDate": {"question": "When will your agent start sending messages to your users?",
"suggestedAnswers": ["Today",
"In a week",
"In a month",
"Within 3 months"
]
}
},
"answers": {"fullCompanyAddress": "Skeppsbron 1-split-211 20-split-Malmö",
"fullCompanyAddressMetadata": {"ignore": "-split-"
},
"usersAmount": "1K - 10K users",
"startDate": "In a month"
}
},
"es": {"questions": {"firstMessage": {"question": "What is the first message sent from the agent to the user?",
"suggestedAnswers": ["Thank you for opting in.",
"Thank you for subscribing.",
"We have registered your request."
]
}
},
"answers": {"firstMessage": "Hello, it's me I was wondering..."
}
}
}
},
"region": "EU",
"billingCategory": "BASIC_MESSAGE",
"useCase": "OTP",
"hostingRegion": "EUROPE",
"authName": "yurwN6123asd",
"authToken": "ejiiqJtDyurwN6jLze8v",
"conversationApiApp": "4CF9CE97504C4A468F4610919D17ECC1",
"conversationApiAppDetails": {"id": "4CF9CE97504C4A468F4610919D17ECC1",
"projectId": "ea026751-3edf-40a9-ad93-1b382bd60a78",
"region": "EU"
},
"created": "2023-01-19t13:11:08.204Z",
"modified": "2023-01-19t13:11:08.204Z"
}

Lists activities on sender GA

Paginated list of activities for sender. Ordered from the most recent one to the oldest one.

SecurityBasic or OAuth2.0

Request

path Parameters

projectId required	string The unique ID of the project. You can find this on the Sinch Dashboard.
senderId required	string The unique ID of the sender.

query Parameters

pageToken	string The page token if retrieving the next page from a previous query.
pageSize	number [ 1 .. 100 ] The page size requested.

Responses

200

Recent activities on sender

Response Schema: application/json

totalSize required	number Total size of the entries matching the search query.
pageSize required	number Requested size of the page.
required	Array of objects (RcsSenderNotificationDto)
previousPageToken	string Encoded token to use in list request to fetch previous batch of entries.
nextPageToken	string Encoded token to use in list request to fetch next batch of entries.

400

BadRequest

401

Unauthorized

404

NotFound

500

InternalServerError

get/v1/projects/{projectId}/rcs/senders/{senderId}/activities

Request samples

Node.js
C#
Java
Python
curl

Response samples

application/json

Response for all sender activities.

{"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"
}
]
}

Creates a comment for a sender in project GA

Creates a comment for a sender in project.

SecurityBasic or OAuth2.0

Request

path Parameters

projectId required	string The unique ID of the project. You can find this on the Sinch Dashboard.
senderId required	string The unique ID of the sender.

Request Body schema: application/json
required

Comment data.

comment

required

string [ 1 .. 65535 ] characters

Responses

201

Created comment for a sender in project

Response Schema: application/json

type required	string Value: "CREATED"
comment required	string
created	string

400

BadRequest

401

Unauthorized

404

NotFound

500

InternalServerError

post/v1/projects/{projectId}/rcs/senders/{senderId}/comments

Request samples

application/json

  Example body request to create a comment.

{"comment": "Example comment."
}

Response samples

application/json

Response when successfully creating a comment.

{"type": "CREATED",
"comment": "Example comment",
"created": "2023-01-19T13:11:08.204Z"
}

Begin launch process for sender GA

  Begins launch process for a sender in project.

  Requirements to begin launch process:
    - Questionnaire needs to be completed;
    - 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.

SecurityBasic or OAuth2.0

Request

path Parameters

projectId required	string The unique ID of the project. You can find this on the Sinch Dashboard.
senderId required	string The unique ID of the sender.

Responses

200

Launched sender in project

Response Schema: application/json

id required	string The unique ID of the sender.
region required	string Region sender is provisioned in. Enum: "BR" "EU" "IN" "US" "REGION_UNSPECIFIED" "UNRECOGNIZED"
billingCategory required	string Billing category. Enum: "BASIC_MESSAGE" "CONVERSATIONAL" "CONVERSATIONAL_LEGACY" "SINGLE_MESSAGE" "UNRECOGNIZED"
useCase required	string Use case. Enum: "MULTIUSE" "OTP" "PROMOTIONAL" "TRANSACTIONAL" "UNRECOGNIZED"
hostingRegion required	string Internal Google hosting region Enum: "ASIA_PACIFIC" "EUROPE" "NORTH_AMERICA" "UNRECOGNIZED"
conversationApiApp	string Deprecated If set, the Conversation API App ID the sender is connected to.
	object If set, the details of the Conversation API App the sender is connected to.
state	string The current state of the sender. Enum: "DRAFT" "IN_PROGRESS" "IN_TEST" "LAUNCHED" "LAUNCHING" "PREPARING_LAUNCH" "UNLAUNCHED" "UNKNOWN" "UNRECOGNIZED"
	Array of objects (RcsTestNumberStateDto) Test phone numbers states.
	Array of objects (RcsCountryStatusDto) Countries status.
	object Sender details and information.
authName	string The name is needed to connect the sender to a Conversation API App.
authToken	string The token is needed to connect the sender to a Conversation API App.
created	string The UTC Date Time in ISO 8601 for when the sender was created.
modified	string The UTC Date Time in ISO 8601 for when the sender was last modified.

400

BadRequest

401

Unauthorized

403

Forbidden

404

NotFound

409

Conflict

412

PreconditionFailed

429

TooManyRequests

500

InternalServerError

post/v1/projects/{projectId}/rcs/senders/{senderId}/launch

Request samples

Node.js
C#
Java
Python
curl

Response samples

application/json

Response when successfully launching a sender with all required attributes.

{"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": "LAUNCHED",
"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": "LAUNCHED",
"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": "EE",
"status": "PENDING",
"modified": "2023-01-19t13:11:08.204Z"
},
{"name": "Three",
"status": "LAUNCHED",
"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"
}
]
}
],
"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": "+48 777-777-777"
},
{"label": "label-1",
"number": "+48 888-888-888"
},
{"label": "label-2",
"number": "+48 999-999-999"
}
],
"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": ["+48 777-777-777"
],
"countries": ["FR",
"GB",
"ES"
],
"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": [ ]
}
},
"answers": {"name": "Exam Ple",
"email": "example@email.com",
"title": "Head Example",
"website": "https://example.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"
]
},
"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",
"messagesVolume": "10K - 100K messages",
"messagesFrequency": "Once per month",
"campaignLength": "6 months"
}
},
"fr": {"questions": {"fullCompanyAddress": {"question": "Full Company Address",
"suggestedAnswers": [ ]
},
"usersAmount": {"question": "How many users are your agent expected to reach?",
"suggestedAnswers": ["0 - 1K users",
"1K - 10K users",
"10k - 100K users",
"100K+ users"
]
},
"startDate": {"question": "When will your agent start sending messages to your users?",
"suggestedAnswers": ["Today",
"In a week",
"In a month",
"Within 3 months"
]
}
},
"answers": {"fullCompanyAddress": "Skeppsbron 1-split-211 20-split-Malmö",
"fullCompanyAddressMetadata": {"ignore": "-split-"
},
"usersAmount": "1K - 10K users",
"startDate": "In a month"
}
},
"es": {"questions": {"firstMessage": {"question": "What is the first message sent from the agent to the user?",
"suggestedAnswers": ["Thank you for opting in.",
"Thank you for subscribing.",
"We have registered your request."
]
}
},
"answers": {"firstMessage": "Hello, it's me I was wondering..."
}
}
}
},
"region": "EU",
"billingCategory": "BASIC_MESSAGE",
"useCase": "OTP",
"hostingRegion": "EUROPE",
"authName": "yurwN6123asd",
"authToken": "ejiiqJtDyurwN6jLze8v",
"conversationApiApp": "4CF9CE97504C4A468F4610919D17ECC1",
"conversationApiAppDetails": {"id": "4CF9CE97504C4A468F4610919D17ECC1",
"projectId": "ea026751-3edf-40a9-ad93-1b382bd60a78",
"region": "EU"
},
"created": "2023-01-19t13:11:08.204Z",
"modified": "2023-01-19t13:11:08.204Z"
}

Add test numbers to sender for project GA

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.

SecurityBasic or OAuth2.0

Request

path Parameters

projectId required	string The unique ID of the project. You can find this on the Sinch Dashboard.
senderId required	string

Request Body schema: application/json
required

Test numbers to add

testNumbers

required

Array of strings <e.164 phone number> <= 20 items unique

Phone numbers for testing.

Responses

200

Test number states

Response Schema: application/json

required

Array of objects (RcsTestNumberStateDto)

Test numbers states.

Array

number required	string <e.164 phone number> Test phone number.
state required	string Test phone state. Enum: "DECLINED" "INVALID" "PENDING" "UNVERIFIED" "VERIFIED" "UNRECOGNIZED"
submitted required	string Date of submitting phone number.

400

BadRequest

401

Unauthorized

404

NotFound

429

TooManyRequests

500

InternalServerError

post/v1/projects/{projectId}/rcs/senders/{senderId}/testNumbers

Request samples

application/json

  Example body request to add test numbers.

{"testNumbers": ["+48 777-777-777"
]
}

Response samples

application/json

Test number states.

{"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"
}
]
}

Deletes test number for the sender GA

Deletes test number for the sender.

Please note that this method is only able to delete test number for the sender in Sinch database, in order to delete it from Google agent you need to use Google console.

SecurityBasic or OAuth2.0

Request

path Parameters

projectId required	string The unique ID of the project. You can find this on the Sinch Dashboard.
senderId required	string The unique ID of the sender.
testNumber required	string 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'.

Responses

204

Test number deleted

400

BadRequest

401

Unauthorized

404

NotFound

429

TooManyRequests

500

InternalServerError

delete/v1/projects/{projectId}/rcs/senders/{senderId}/testNumbers/{testNumber}

Request samples

Node.js
C#
Java
Python
curl

Response samples

application/json

{"errorCode": "no_google_supplier",
"message": "No google supplier in sender.",
"resolution": "Verify that the sender has google supplier."
}

Get test number capabilities of sender for project GA

Returns test number capabilities of sender for a project.

SecurityBasic or OAuth2.0

Request

path Parameters

projectId required	string The unique ID of the project. You can find this on the Sinch Dashboard.
senderId required	string The unique ID of the sender.
testNumber required	string 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'.

Responses

200

test number capabilities

Response Schema: application/json

features

required

Array of strings (RcsTestNumberFeatures)

List of RBM features that this device supports.

Items 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"

400

BadRequest

401

Unauthorized

404

NotFound

429

TooManyRequests

500

InternalServerError

get/v1/projects/{projectId}/rcs/senders/{senderId}/testNumbers/{testNumber}/capabilities

Request samples

Node.js
C#
Java
Python
curl

Response samples

application/json

Response with test number capabilities.

{"features": ["REVOCATION",
"ACTION_DIAL"
]
}

Resend an invite to test number of sender for project GA

Resend an invite and returns state for test number of sender for a project.

SecurityBasic or OAuth2.0

Request

path Parameters

projectId required	string The unique ID of the project. You can find this on the Sinch Dashboard.
senderId required	string The unique ID of the sender.
testNumber required	string 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'.

Responses

200

test number state

Response Schema: application/json

number required	string <e.164 phone number> Test phone number.
state required	string Test phone state. Enum: "DECLINED" "INVALID" "PENDING" "UNVERIFIED" "VERIFIED" "UNRECOGNIZED"
submitted required	string Date of submitting phone number.

400

BadRequest

401

Unauthorized

404

NotFound

429

TooManyRequests

500

InternalServerError

get/v1/projects/{projectId}/rcs/senders/{senderId}/testNumbers/{testNumber}/retry

Request samples

Node.js
C#
Java
Python
curl

Response samples

application/json

Response with test number state.

Please note that if you send an invite to verified number, state will be changed to unverified.

{"number": "+46123123111",
"state": "UNVERIFIED",
"submitted": "2023-01-19t13:11:08.204Z"
}

Security Privacy Legal & Compliance Cookie Statement

RCS Senders

List all senders in project GA

path Parameters

query Parameters

Response Schema: application/json

Create sender for project GA

path Parameters

Request Body schema: application/jsonrequired

Response Schema: application/json

Get sender for project GA

path Parameters

Response Schema: application/json

Update sender for project GA

path Parameters

Request Body schema: application/jsonrequired

Response Schema: application/json

Lists activities on sender GA

path Parameters

query Parameters

Response Schema: application/json

Creates a comment for a sender in project GA

path Parameters

Request Body schema: application/jsonrequired

Response Schema: application/json

Begin launch process for sender GA

path Parameters

Response Schema: application/json

Add test numbers to sender for project GA

path Parameters

Request Body schema: application/jsonrequired

Response Schema: application/json

Deletes test number for the sender GA

path Parameters

Get test number capabilities of sender for project GA

path Parameters

Response Schema: application/json

Resend an invite to test number of sender for project GA

path Parameters

Response Schema: application/json

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required