SIsinch
RCS Senders

Begin launch process for sender

Changed on 
  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.
post/v1/projects/{projectId}/rcs/senders/{senderId}/launch

Request

  • Base URL
    https://provisioning.api.sinch.com
  • URL
    https://provisioning.api.sinch.com/v1/projects/{projectId}/rcs/senders/{senderId}/launch
  • Auth
    HTTP basic and HTTP bearer and OAuth 2
    Client credentials
    Token URL: https://auth.sinch.com/oauth2/token

Path parameters

projectIdstring required

The unique ID of the project. You can find this on the <a href="https://dashboard.sinch.com/">Sinch Dashboard</a>.

senderIdstring required

The unique ID of the sender.

Response

Launched sender in project

idstring required

The unique ID of the sender.

conversationApiAppstring

If set, the Conversation API App ID the sender is connected to.

state'DRAFT' | 'IN_PROGRESS' | 'IN_TEST' | 'LAUNCHED' | 'LAUNCHING' | 'PREPARING_LAUNCH' | 'UNLAUNCHED' | 'UNKNOWN'

The current state of the sender.

region'BR' | 'EU' | 'US' required

Region sender is provisioned in.

billingCategory'CONVERSATIONAL' | 'NON_CONVERSATIONAL' | 'BASIC_MESSAGE' | 'CONVERSATIONAL_LEGACY' | 'SINGLE_MESSAGE' required

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.
useCase'MULTIUSE' | 'OTP' | 'PROMOTIONAL' | 'TRANSACTIONAL' required

Use case.

hostingRegion'ASIA_PACIFIC' | 'EUROPE' | 'NORTH_AMERICA' required

Internal Google hosting region

authNamestring

The name is needed to connect the sender to a Conversation API App.

authTokenstring

The token is needed to connect the sender to a Conversation API App.

createdstring

The UTC Date Time in ISO 8601 for when the sender was created.

modifiedstring

The UTC Date Time in ISO 8601 for when the sender was last modified.

launchedstring

The UTC Date Time in ISO 8601 for when the sender was last launched.

Changes

  • 30f63d8c2864Revision changes
    • warning

      added the new EXPIRED enum value to the ////// response property for the response status

    • warning

      added the new FAILED enum value to the ////// response property for the response status

  • cb49a3396ef4Revision changes
    • breaking

      added to the ////////// response property oneOf list for the response status