openapi: 3.0.0 info: version: 2.1.0 title: Route Mobile Rich Communication Services (RCS) API Documentation description: |- Welcome to the Route Mobile developer hub. You will find comprehensive RCS API documentation to help you start working with Route Mobile as quickly as possible and support if you get stuck. Let's jump right in! For more information, see the [Route Mobile Open API Specifications](https://routemobile.github.io/RCS-Business-Messaging-API/RCS.html) contact: url: https://developers.routemobile.com/ name: Route Mobile Development email: support@routemobile.com license: name: Proprietary url: https://www.routemobile.com/terms-and-conditions/ x-logo: url: https://www.routemobile.com/wp-content/uploads/2021/07/RM-Logo.png altText: Route Mobile Logo x-readme: samples-languages: - curl - python - node - java - php servers: - url: https://apis.rmlconnect.net security: - jwt: [] paths: /auth/v1/login/: post: tags: - Login summary: Login API description: |- Login APIs provide a secure and standardized way for end users to add user authentication to their applications. Only authorized users can access sensitive resources or perform specific actions within the application after entering the user authentication details. **By default, the JSON Web Token (JWT) validity periods are set to one hour.** operationId: loginApi2 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/v1_login_body' examples: Example 1: value: password: password username: username responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/inline_response_201_2' examples: Authentication successful: value: JWTAUTH: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoiZGVtbyIsInVzZXJuYW1lIjoiZGVtbyIsImV4cCI6MTY4Mzg4OTI0MSwiZW1haWwiOiJwcm9kdWN0LWRlc2tAcm91dGVtb2JpbGUuY29tIiwib3JpZ19pYXQiOjE2ODM4ODU2NDEsImN1c3RvbWVyX2lkIjoiOWlyNURnN2J2c0NBIn0.gu2LO-bDVPqa35v_MnyO1KKeZzhDHHWLta5Gxxxxxx user_data: username: demo first_name: RML last_name: Product email: product-desk@routemobile.com phone_number: '{phone}' password_reset: false is_active: true is_staff: false ip: 1stepauth child_user: false parent_username: '' '403': description: Forbidden content: application/json: schema: type: object properties: status: type: string description: The user login status. examples: User is set inactive: value: status: invalid credentials or the account has been deactivated '429': description: Too Many Requests content: application/json: schema: type: object properties: message: type: string description: Rate limit exceeded message. retry_after: type: integer description: Number of seconds to wait before retrying. examples: Rate Limit Exceeded: value: message: Rate limit exceeded. Please retry after the specified time. retry_after: 60 '500': description: Internal Server Error content: application/json: schema: type: object properties: status: type: string description: The user login status. examples: Unhandled Exception: value: status: security: [] /rcs/v1/message: post: tags: - RCS Messages API summary: RCS Messages API description: "The Rich Communication Services (RCS) Business Messaging API is a communication protocol\ \ that allows businesses to send different types of messages beyond traditional text messages.\ \ \n\nThe RCS Business Messaging API allows businesses to send different types of messages that\ \ include:\n\n- **Notification API:** Standard messages that send plain text or media content.\ \ \n- **Session API:** Standard text messages that send plain text content as part of a campaign.\ \ \n- **India Template API:** Create interactive and visually rich content to engage customers." operationId: textTemplate requestBody: description: "\n \n " required: true content: application/json: schema: anyOf: - title: Notification Message APIs oneOf: - $ref: '#/components/schemas/rcs_notification_common_msg' - $ref: '#/components/schemas/rcs_notification_text_msg' - $ref: '#/components/schemas/rcs_notification_media_imagemp4_msg' - $ref: '#/components/schemas/rcs_notification_videothumbnailurl_msg' - $ref: '#/components/schemas/rcs_notification_videothumbnailid_msg' - $ref: '#/components/schemas/rcs_notification_richcrdstdalone_msg' - $ref: '#/components/schemas/rcs_notification_richcrdcarousel_msg' - $ref: '#/components/schemas/rcs_notification_urlsugg_msg' - $ref: '#/components/schemas/rcs_notification_textsugg_msg' - $ref: '#/components/schemas/rcs_notification_dialsugg_msg' - $ref: '#/components/schemas/rcs_notification_locationsugg_msg' - $ref: '#/components/schemas/rcs_notification_calendarsugg_msg' - $ref: '#/components/schemas/rcs_notification_mediaid_msg' - $ref: '#/components/schemas/rcs_notification_carslwithids_msg' - title: Session Message APIs oneOf: - $ref: '#/components/schemas/rcs_session_common_msg' - $ref: '#/components/schemas/rcs_session_text_msg' - $ref: '#/components/schemas/rcs_session_mediaimagemp4_msg' - $ref: '#/components/schemas/rcs_session_videothumbnailurl_msg' - $ref: '#/components/schemas/rcs_session_videothumbnailid_msg' - $ref: '#/components/schemas/rcs_session_richcrdstdalone_msg' - $ref: '#/components/schemas/rcs_session_richcrdcarousel_msg' - $ref: '#/components/schemas/rcs_session_urlsugg_msg' - $ref: '#/components/schemas/rcs_session_textsugg_msg' - $ref: '#/components/schemas/rcs_session_dialsugg_msg' - $ref: '#/components/schemas/rcs_session_locationsugg_msg' - $ref: '#/components/schemas/rcs_session_calendarsugg_msg' - $ref: '#/components/schemas/rcs_session_mediaid_msg' - $ref: '#/components/schemas/rcs_session_carslwithids_msg' - title: India Template Message APIs oneOf: - $ref: '#/components/schemas/rcs_template_text_msg' - $ref: '#/components/schemas/rcs_template_richcrdstdalone_msg' - $ref: '#/components/schemas/rcs_template_richcrdcarousel_msg' - $ref: '#/components/schemas/rcs_template_fallback_api_msg' - $ref: '#/components/schemas/rcs_template_whatsapp_fallback_api_msg' - $ref: '#/components/schemas/rcs_template_sms_fallback_api_msg' examples: Notification - Common: value: type: text/media/card/multiple_cards phone_no: '{mobile number with country code}' bot_name: '{RML agent name}' text: '{plain text}' url: '{sample (image/pdf/video mp4) url starting with https://}' extra: '{extra value}' suggestions: - type: '{label name}' text: '{plain text}' url: '{url with http://}' latitude: latitude value longitude: longitude value call_to: '{your number}' postback: '{postback text}' - type: dial text: '{label}' postback: '{postback label}' - type: calendar postback: '{postback text}' text: Save to calendar start: '{start time}' end: '{end time}' title: '{title name}' description: '{Description of the calendar event}' card: title: '{label}' description: '{plain text}' url: '{sample (image/pdf/video mp4) url starting with https://}' suggestions: - type: '{label name}' text: '{plain text}' latitude: latitude value longitude: longitude value postback: '{postback text}' - type: calendar postback: '{postback text}' text: Save to calendar start: '{start time}' end: '{end time}' title: '{title name}' description: '{Description of the calendar event}' cards: - card: title: '{label}' description: '{plain text}' url: '{sample (image/pdf/video mp4) url starting with https://}' suggestions: - type: message text: '{text}' postback: '{postback text}' - type: message text: '{text}' postback: '{postback text}' - card: title: '{label}' description: '{plain text}' url: '{sample (image/pdf/video mp4) url starting with https://}' suggestions: - type: dial text: '{label}' call_to: '{your number}' postback: '{postback label}' - card: title: '{label}' description: '{plain text}' url: '{sample (image/pdf/video mp4) url starting with https://}' suggestions: - type: url text: '{label}' url: '{url with http://}' postback: '{postback label}' Notification - Text: value: type: text phone_no: '{mobile number with country code}' bot_name: '{RML agent name}' ttl: '{number of seconds for response}' expire_time: '2024-03-15 13:00:00' text: '{plain text}' extra: '{extra value}' suggestions: - type: '{label name}' text: '{plain text}' latitude: '{latitude value}' longitude: '{longitude value}' postback: '{postback text}' - type: calendar postback: '{postback text}' text: Save to calendar start: '{start time}' end: '{end time}' title: '{title name}' description: '{Description of the calendar event}' fallback_text: '{value {#var#} value}' Notification - Media: value: type: media phone_no: '{mobile number with country code}' bot_name: '{RML agent name}' url: '{sample (image/pdf/video mp4) url starting with https://}' thumbnail_url: '{sample (image/pdf/video mp4) url starting with https://}' id: '{media id}' thumbnail_id: '{media id}' extra: '{extra value}' suggestions: - type: '{label name}' text: '{plain text}' latitude: '{latitude value}' longitude: '{longitude value}' postback: '{postback text}' - type: calendar postback: '{postback text}' text: Save to calendar start: '{start time}' end: '{end time}' title: '{title name}' description: '{Description of the calendar event}' fallback_text: '{value {#var#} value}' Notification - Video With Thumbnail URL: value: type: card phone_no: '{mobile number with country code}' bot_name: '{RML agent name}' card: title: '{plain text}' description: '{description for card}' url: '{sample (image/video mp4) url starting with https://}' thumbnail_url: '{sample (image/video mp4) thumbnail url starting with https://}' suggestions: - type: message postback: '{postback text}' text: '{plain text}' - type: message postback: '{postback text}' text: '{plain text}' Notification - Video With Thumbnail ID: value: type: card phone_no: '{mobile number with country code}' bot_name: '{RML agent name}' card: title: '{plain text}' description: '{description for card}' id: '{sample (image/video mp4) media id}' thumbnail_id: '{sample (image/video mp4) thumbnail media id}' suggestions: - type: message postback: '{postback text}' text: '{plain text}' - type: message postback: '{postback text}' text: '{plain text}' Notification - Rich Card Standalone: value: type: card phone_no: '{mobile number with country code}' bot_name: '{RML agent name}' url: '{sample (image/pdf/video mp4) url starting with https://}' extra: '{extra value}' card: title: '{label}' description: '{plain text}' url: '{sample (image/pdf/video mp4) url starting with https://}' suggestions: - type: '{label name}' text: '{plain text}' latitude: '{latitude value}' longitude: '{longitude value}' postback: '{postback text}' - type: calendar postback: '{postback text}' text: Save to calendar start: '{start time}' end: '{end time}' title: '{title name}' description: '{Description of the calendar event}' fallback_text: '{value {#var#} value}' Notification - Rich Card Carousel: value: type: multiple_cards phone_no: '{mobile number with country code}' bot_name: '{RML agent name}' extra: '{extra value}' cards: - card: title: '{label}' description: '{plain text}' url: '{sample (image/pdf/video mp4) url starting with https://}' suggestions: - type: message text: '{text}' postback: '{postback text}' - type: message text: '{text}' postback: '{postback text}' - type: calendar postback: '{postback text}' text: Save to calendar start: '{start time}' end: '{end time}' title: '{title name}' description: '{Description of the calendar event}' - card: title: '{label}' description: '{plain text}' url: '{sample (image/pdf/video mp4) url starting with https://}' suggestions: - type: dial text: '{label}' call_to: '{your number}' postback: '{postback label}' - card: title: '{label}' description: '{plain text}' url: '{sample (image/pdf/video mp4) url starting with https://}' suggestions: - type: url text: '{label}' url: '{url with http://}' postback: '{postback label}' fallback_text: '{value {#var#} value}' Notification - URL Suggestion: value: type: media phone_no: '{mobile number with country code}' bot_name: '{RML agent name}' url: '{sample (image/pdf/video mp4) url starting with https://}' suggestions: - type: url text: '{label}' url: '{url with http://}' postback: '{postback label}' fallback_text: '{value {#var#} value}' Notification - Text Suggestion: value: type: text phone_no: '{mobile number with country code}' bot_name: '{RML agent name}' text: '{plain text}' suggestions: - type: message text: '{text}' postback: '{postback text}' - type: message text: '{text}' postback: '{postback text}' fallback_text: '{value {#var#} value}' Notification - Dial Suggestion: value: type: media phone_no: '{mobile number with country code}' bot_name: '{RML agent name}' url: '{sample (image/pdf/video mp4) url starting with https://}' extra: '{extra value}' suggestions: - type: dial text: '{label}' call_to: '{your number}' postback: '{postback label}' fallback_text: '{value {#var#} value}' Notification - Location Suggestion: value: type: text phone_no: '{mobile number with country code}' bot_name: '{RML agent name}' text: '{plain text}' extra: '{extra value}' suggestions: - type: '{label name}' text: '{plain text}' latitude: '{latitude value}' longitude: '{longitude value}' postback: '{postback text}' fallback_text: '{value {#var#} value}' Notification - Calendar Suggestion: value: type: text bot_name: '{bot name}' text: '{plain text}' phone_no: '{mobile number with country code}' suggestions: - type: calendar postback: '{postback text}' text: '{plain text}' start: '{start time}' end: '{end time}' title: '{label}' description: '{Description of the calendar event}' Notification - Rich Card Carousel With IDS: value: type: multiple_cards country_code: '+91' file_url: http:///v1/download/Misc/e260e874-831c-11eb-af5c-0242ac12xxxx.txt campaign_name: Testing bulk APIs scheduled_time: '2021-03-13 11:30:00' bot_name: '{RML agent name}' cards: - card: title: '{label}' description: '{plain text}' id: '{media id}' thumbnail_id: '{media id}' - card: title: '{label}' description: '{plain text}' url: '{sample (image/pdf/video mp4) url starting with https://}' - card: title: '{label}' description: '{plain text}' url: '{sample (image/pdf/video mp4) url starting with https://}' India Template - Text: value: type: template phone_no: '{mobile number}' bot_name: '{RML agent name}' ttl: '{number of seconds for response}' expire_time: '2024-03-15 13:00:00' extra: '{extra value}' template: name: '{template name}' variables: '{var1}': '{value}' '{var2}': '{value}' fallback_text: '{value {#var#} value}' India Template - Rich Card Standalone: value: type: template phone_no: '{mobile number}' bot_name: '{RML agent name}' ttl: '{number of seconds for response}' expire_time: '2024-03-15 13:00:00' extra: '{extra value}' template: name: '{template name}' variables: '{var1}': '{value}' '{var2}': '{value}' fallback_text: '{value {#var#} value}' India Template - Rich Card Carousel: value: type: template phone_no: '{mobile number}' bot_name: '{RML agent name}' ttl: '{number of seconds for response}' expire_time: '2024-03-15 13:00:00' extra: '{extra value}' template: name: '{template name}' variables: '{var1}': '{value}' '{var2}': '{value}' fallback_text: '{value {#var#} value}' India Template - Fallback API: value: type: text phone_no: '{mobile number with country code}' bot_name: Routemobile ttl: '{number of seconds for response}' expire_time: '2024-03-15 13:00:00' text: Hi fallback_text: Your test OTP is {#var#}- 29 Three India Template - Whatsapp Fallback API: value: type: template phone_no: '{mobile number with country code}' bot_name: '{RML agent name}' ttl: '{number of seconds for response}' expire_time: '2024-03-15 13:00:00' extra: '{extra value}' template: name: '{template name}' fallback_channel: whatsapp whatsapp: media: type: '{media type/template}' template_name: '{template name}' lang_code: '{language code}' India Template - SMS Fallback API: value: type: template phone_no: '{mobile number with country code}' bot_name: '{RML agent name}' ttl: '{number of seconds for response}' expire_time: '2024-03-15 13:00:00' extra: '{extra value}' template: name: '{template name}' fallback_channel: sms sms: fallback_text: '{fallback text}' Session - Common: value: type: text/media/card/multiple_cards phone_no: '{mobile number with country code}' bot_name: '{RML agent name}' text: '{plain text}' url: '{sample (image/pdf/video mp4) url starting with https://}' extra: '{extra value}' suggestions: - type: '{label name}' text: '{plain text}' url: '{url with http://}' latitude: latitude value longitude: longitude value call_to: '{your number}' postback: '{postback text}' - type: dial text: '{label}' postback: '{postback label}' - type: calendar postback: '{postback text}' text: Save to calendar start: '{start time}' end: '{end time}' title: '{title name}' description: '{Description of the calendar event}' card: title: '{label}' description: '{plain text}' url: '{sample (image/pdf/video mp4) url starting with https://}' suggestions: - type: '{label name}' text: '{plain text}' latitude: latitude value longitude: longitude value postback: '{postback text}' - type: calendar postback: '{postback text}' text: Save to calendar start: '{start time}' end: '{end time}' title: '{title name}' description: '{Description of the calendar event}' cards: - card: title: '{label}' description: '{plain text}' url: '{sample (image/pdf/video mp4) url starting with https://}' suggestions: - type: message text: '{text}' postback: '{postback text}' - type: message text: '{text}' postback: '{postback text}' - card: title: '{label}' description: '{plain text}' url: '{sample (image/pdf/video mp4) url starting with https://}' suggestions: - type: dial text: '{label}' call_to: '{your number}' postback: '{postback label}' - card: title: '{label}' description: '{plain text}' url: '{sample (image/pdf/video mp4) url starting with https://}' suggestions: - type: url text: '{label}' url: '{url with http://}' postback: '{postback label}' Session - Text: value: type: text phone_no: '{mobile number with country code}' bot_name: '{RML agent name}' ttl: '{number of seconds for response}' expire_time: '2024-03-15 13:00:00' text: '{plain text}' extra: '{extra value}' suggestions: - type: '{label name}' text: '{plain text}' latitude: '{latitude value}' longitude: '{longitude value}' postback: '{postback text}' - type: calendar postback: '{postback text}' text: Save to calendar start: '{start time}' end: '{end time}' title: '{title name}' description: '{Description of the calendar event}' fallback_text: '{value {#var#} value}' Session - Media: value: type: media phone_no: '{mobile number with country code}' bot_name: '{RML agent name}' url: '{sample (image/pdf/video mp4) url starting with https://}' extra: '{extra value}' thumbnail_url: '{sample (image/pdf/video mp4) url starting with https://}' id: '{media id}' thumbnail_id: '{media id}' suggestions: - type: '{label name}' text: '{plain text}' latitude: '{latitude value}' longitude: '{longitude value}' postback: '{postback text}' - type: calendar postback: '{postback text}' text: Save to calendar start: '{start time}' end: '{end time}' title: '{title name}' description: '{Description of the calendar event}' fallback_text: '{value {#var#} value}' Session - Video With Thumbnail URL: value: type: card phone_no: '{mobile number with country code}' bot_name: '{RML agent name}' card: title: '{plain text}' description: '{description for card}' url: '{sample (image/video mp4) url starting with https://}' thumbnail_url: '{sample (image/video mp4) thumbnail url starting with https://}' suggestions: - type: message postback: '{postback text}' text: '{plain text}' - type: message postback: '{postback text}' text: '{plain text}' Session - Video With Thumbnail ID: value: type: card phone_no: '{mobile number with country code}' bot_name: '{RML agent name}' card: title: '{plain text}' description: '{description for card}' id: '{sample (image/video mp4) media id}' thumbnail_id: '{sample (image/video mp4) thumbnail media id}' suggestions: - type: message postback: '{postback text}' text: '{plain text}' - type: message postback: '{postback text}' text: '{plain text}' Session - Rich Card Standalone: value: type: card phone_no: '{mobile number with country code}' bot_name: '{RML agent name}' url: '{sample (image/pdf/video mp4) url starting with https://}' extra: '{extra value}' card: title: '{label}' description: '{plain text}' url: '{sample (image/pdf/video mp4) url starting with https://}' suggestions: - type: '{label name}' text: '{plain text}' latitude: '{latitude value}' longitude: '{longitude value}' postback: '{postback text}' - type: calendar postback: '{postback text}' text: Save to calendar start: '{start time}' end: '{end time}' title: '{title name}' description: '{Description of the calendar event}' fallback_text: '{value {#var#} value}' Session - Rich Card Carousel: value: type: multiple_cards phone_no: '{mobile number with country code}' bot_name: '{RML agent name}' extra: '{extra value}' cards: - card: title: '{label}' description: '{plain text}' url: '{sample (image/pdf/video mp4) url starting with https://}' suggestions: - type: message text: '{text}' postback: '{postback text}' - type: message text: '{text}' postback: '{postback text}' - type: calendar postback: '{postback text}' text: Save to calendar start: '{start time}' end: '{end time}' title: '{title name}' description: '{Description of the calendar event}' - card: title: '{label}' description: '{plain text}' url: '{sample (image/pdf/video mp4) url starting with https://}' suggestions: - type: dial text: '{label}' call_to: '{your number}' postback: '{postback label}' - card: title: '{label}' description: '{plain text}' url: '{sample (image/pdf/video mp4) url starting with https://}' suggestions: - type: url text: '{label}' url: '{url with http://}' postback: '{postback label}' - type: calendar postback: '{postback text}' text: Save to calendar start: '{start time}' end: '{end time}' title: '{title name}' description: '{Description of the calendar event}' fallback_text: '{value {#var#} value}' Session - URL Suggestion: value: type: media phone_no: '{mobile number with country code}' bot_name: '{RML agent name}' url: '{sample (image/pdf/video mp4) url starting with https://}' extra: '{extra value}' suggestions: - type: url text: '{label}' url: '{url with http://}' postback: '{postback label}' fallback_text: '{value {#var#} value}' Session - Text Suggestion: value: type: text phone_no: '{mobile number with country code}' bot_name: '{RML agent name}' text: '{plain text}' extra: '{extra value}' suggestions: - type: message text: '{text}' postback: '{postback text}' - type: message text: '{text}' postback: '{postback text}' fallback_text: '{value {#var#} value}' Session - Location Suggestion: value: type: text phone_no: '{mobile number with country code}' bot_name: '{RML agent name}' text: '{plain text}' extra: '{extra value}' suggestions: - type: '{label name}' text: '{plain text}' latitude: '{latitude value}' longitude: '{longitude value}' postback: '{postback text}' fallback_text: '{value {#var#} value}' Session - Dial Suggestion: value: type: media phone_no: '{mobile number with country code}' bot_name: '{RML agent name}' url: '{sample (image/pdf/video mp4) url starting with https://}' extra: '{extra value}' suggestions: - type: dial text: '{label}' call_to: '{your number}' postback: '{postback label}' fallback_text: '{value {#var#} value}' Session - Calendar Suggestion: value: type: text bot_name: '{bot name}' text: '{plain text}' phone_no: '{mobile number with country code}' suggestions: - type: calendar postback: '{postback text}' text: '{plain text}' start: '{start time}' end: '{end time}' title: '{label}' description: '{Description of the calendar event}' Session - Media ID: value: type: media phone_no: '{mobile number with country code}' bot_name: '{bot name}' id: '{media id}' Session - Rich Card Carousel With IDS: value: type: multiple_cards country_code: '+91' file_url: http:///v1/download/Misc/e260e874-831c-11eb-af5c-0242ac12xxxx.txt campaign_name: Testing bulk APIs scheduled_time: '2021-03-13 11:30:00' bot_name: '{RML agent name}' cards: - card: title: '{label}' description: '{plain text}' id: '{media id}' thumbnail_id: '{media id}' - card: title: '{label}' description: '{plain text}' url: '{sample (image/pdf/video mp4) url starting with https://}' - card: title: '{label}' description: '{plain text}' url: '{sample (image/pdf/ video mp4) url starting with https://}' responses: '202': description: Accepted content: application/json: schema: type: object properties: message: type: string description: The response message. id: type: string description: The request id of the message. examples: Example 1: value: message: Message request has been created id: 167de12a-fe0e-11ed-a253-0a58a9fxxxxx '400': description: Bad Request content: application/json: schema: type: object properties: status: type: string description: "The status of the message delivery.\r\n\r\n" errors: type: object description: "The error for not processing the request.\r\n\r\n" properties: text: type: array description: Error message description. items: type: string examples: Example 1: value: status: failed errors: text: - Unknown field. '401': description: Authentication Failure content: application/json: schema: type: object properties: status: type: string description: The response message. examples: Example 1: value: status: Unauthorized application/xml: schema: type: object '403': description: Forbidden content: application/json: schema: type: object properties: status: type: string description: The response message. examples: Example 1: value: status: Please input a valid/authorized bot name '404': description: Page Not Found content: application/json: schema: type: object properties: message: type: string description: The message response. '429': description: Too Many Requests content: application/json: schema: type: object properties: message: type: string description: Rate limit exceeded message. retry_after: type: integer description: Number of seconds to wait before retrying. examples: Rate Limit Exceeded: value: message: Rate limit exceeded. Please retry after the specified time. retry_after: 60 '500': description: Internal Server Error content: application/json: schema: type: object properties: status: type: string description: The status of the message delivery. errors: type: string description: "The error for not processing the request.\r\n\r\n" examples: Example 1: value: status: failed errors: Contact administration for more info security: - jwt: [] /rcs/v1/bulk_message: post: tags: - Bulk Upload Campaign API summary: Bulk Upload Campaign description: 'Bulk Upload Campaign APIs send messages to many recipients simultaneously using a batch upload process. It allows businesses to efficiently send personalized and interactive messages to their customers at scale. ' operationId: bulkCampaignUploadRCS requestBody: description: '' required: true content: application/json: schema: oneOf: - $ref: '#/components/schemas/rcs_bulkcamp_text_msg' - $ref: '#/components/schemas/rcs_bulkcamp_media_msg' - $ref: '#/components/schemas/rcs_bulkcamp_richcrdstd_msg' - $ref: '#/components/schemas/rcs_bulkcamp_richcardcarsl_msg' - $ref: '#/components/schemas/rcs_bulkcamp_urlsugg_msg' - $ref: '#/components/schemas/rcs_bulkcamp_textsugg_msg' - $ref: '#/components/schemas/rcs_bulkcamp_dialsugg_msg' - $ref: '#/components/schemas/rcs_bulkcamp_locsugg_msg' - $ref: '#/components/schemas/rcs_bulkcamp_calendarsugg_msg' examples: Text: value: type: text country_code: '+91' file_url: http:///v1/download/Misc/e260e874-831c-11eb-af5c-0242ac12xxx.txt campaign_name: Testing bulk APIs scheduled_time: '2021-03-13 11:30:00' ttl: '{Time in seconds}' expire_time: '2024-03-15 13:00:00' bot_name: '{RML agent name}' text: '{plain text}' suggestions: - type: '{label name}' text: '{plain text}' latitude: '{latitude value}' longitude: '{longitude value}' postback: '{postback text}' fallback_text: '{value {#var#} value}' Media: value: type: media country_code: '+91' file_url: http:///v1/download/Misc/e260e874-831c-11eb-af5c-0242ac12xxxx.txt campaign_name: Testing bulk APIs scheduled_time: '2021-03-13 11:30:00' bot_name: '{RML agent name}' url: '{sample (image/pdf/video mp4) url starting with https://}' suggestions: - type: '{label name}' text: '{plain text}' latitude: '{latitude value}' longitude: '{longitude value}' postback: '{postback text}' fallback_text: '{value {#var#} value}' Rich Card Standalone: value: type: card country_code: '+91' file_url: http:///v1/download/Misc/e260e874-831c-11eb-af5c-0242ac12xxxx.txt campaign_name: Testing bulk APIs scheduled_time: '2021-03-13 11:30:00' bot_name: '{RML agent name}' url: '{sample (image/pdf/video mp4) url starting with https://}' card: title: '{label}' description: '{plain text}' url: '{sample (image/pdf/video mp4) url starting with https://}' suggestions: - type: '{label name}' text: '{plain text}' latitude: '{latitude value}' longitude: '{longitude value}' postback: '{postback text}' fallback_text: '{value {#var#} value}' Rich Card Carousel: value: type: multiple_cards country_code: '+91' file_url: http:///v1/download/Misc/e260e874-831c-11eb-af5c-0242ac12xxxx.txt campaign_name: Testing bulk APIs scheduled_time: '2021-03-13 11:30:00' bot_name: '{RML agent name}' cards: - card: title: '{label}' description: '{plain text}' url: '{sample (image/pdf/video mp4) url starting with https://}' suggestions: - type: message text: '{text}' postback: '{postback text}' - type: message text: '{text}' postback: '{postback text}' - card: title: '{label}' description: '{plain text}' url: '{sample (image/pdf/video mp4) url starting with https://}' suggestions: - type: dial text: '{label}' call_to: '{your number}' postback: '{postback label}' - card: title: '{label}' description: '{plain text}' url: '{sample (image/pdf/video mp4) url starting with https://}' suggestions: - type: url text: '{label}' url: '{url with http://}' postback: '{postback label}' fallback_text: '{value {#var#} value}' URL Suggestion: value: type: media country_code: '+91' file_url: http:///v1/download/Misc/e260e874-831c-11eb-af5c-0242ac12xxxx.txt campaign_name: Testing bulk APIs scheduled_time: '2021-03-13 11:30:00' bot_name: '{RML agent name}' url: '{sample (image/pdf/video mp4) url starting with https://}' suggestions: - type: url text: '{label}' url: '{url with http://}' postback: '{postback label}' fallback_text: '{value {#var#} value}' Text Suggestion: value: type: text country_code: '+91' file_url: http:///v1/download/Misc/e260e874-831c-11eb-af5c-0242ac12xxxx.txt campaign_name: Testing bulk APIs scheduled_time: '2021-03-13 11:30:00' bot_name: '{RML agent name}' text: '{plain text}' suggestions: - type: message text: '{text}' postback: '{postback text}' - type: message text: '{text}' postback: '{postback text}' fallback_text: '{value {#var#} value}' Dial Suggestion: value: type: media country_code: '+91' file_url: http:///v1/download/Misc/e260e874-831c-11eb-af5c-0242ac12xxxx.txt campaign_name: Testing bulk APIs scheduled_time: '2021-03-13 11:30:00' bot_name: '{RML agent name}' url: '{sample (image/pdf/video mp4) url starting with https://}' suggestions: - type: dial text: '{label}' call_to: '{your number}' postback: '{postback label}' fallback_text: '{value {#var#} value}' Location Suggestion: value: type: text country_code: '+91' file_url: http:///v1/download/Misc/e260e874-831c-11eb-af5c-0242ac12xxxx.txt campaign_name: Testing bulk APIs scheduled_time: '2021-03-13 11:30:00' bot_name: '{RML agent name}' text: '{plain text}' suggestions: - type: '{label name}' text: '{plain text}' latitude: '{latitude value}' longitude: '{longitude value}' postback: '{postback text}' fallback_text: '{value {#var#} value}' Calendar Suggestion: value: type: text country_code: '+91' file_url: http:///v1/download/Misc/e260e874-831c-11eb-af5c-0242ac12xxxx.txt campaign_name: Testing bulk APIs scheduled_time: '2021-03-13 11:30:00' bot_name: '{RML agent name}' text: '{plain text}' suggestions: - type: calendar postback: '{postback text}' text: '{plain text}' start: '{start time}' end: '{end time}' title: '{label}' description: '{Description of the calendar event}' fallback_text: '{value {#var#} value}' responses: '202': description: Accepted content: application/json: schema: type: object properties: message: type: string description: The response message. campaign_id: type: string description: The unique ID of the campaign. examples: Example 1: value: message: Message request has been created campaign_id: 1xx application/xml: schema: type: object '400': description: Bad Request content: application/json: schema: type: object properties: status: type: string description: The status of the message delivery. errors: type: object description: "The error for not processing the request.\r\n\r\n" properties: text: type: array description: The error description. items: type: string examples: Example 1: value: status: string errors: text: - string '401': description: Unauthorized content: application/json: schema: type: object properties: status: type: string description: The status of the message delivery. examples: Example 1: value: status: string '403': description: Forbidden content: application/json: schema: type: object properties: status: type: string description: The status of the message delivery. examples: Example 1: value: status: string '404': description: Not Found content: application/json: schema: type: object properties: message: type: string description: The message response. '429': description: Too Many Requests content: application/json: schema: type: object properties: message: type: string description: Rate limit exceeded message. retry_after: type: integer description: Number of seconds to wait before retrying. examples: Rate Limit Exceeded: value: message: Rate limit exceeded. Please retry after the specified time. retry_after: 60 '500': description: Internal Server Error content: application/json: schema: type: object properties: status: type: string description: The status of the message delivery. errors: type: string description: "The error for not processing the request.\r\n\r\n" examples: Example 1: value: status: string errors: string security: - jwt: [] /payments/v1/send_bill: post: tags: - Payment API summary: Payment API description: |- The Payment Template API allows businesses to integrate payment functionality into their RCS messages. With this API, businesses can create payment templates that enable users to make secure payments directly within the RCS messaging experience. The API will use the provided phone number to send the payment template message to the recipient via RCS. The template will include the specified variables and their corresponding values, allowing you to customize the payment details for each recipient. operationId: sendBillToUserRcs requestBody: required: true content: application/json: schema: oneOf: - $ref: '#/components/schemas/rcs_payments_india_template' - $ref: '#/components/schemas/rcs_payments_text_template' - $ref: '#/components/schemas/rcs_payments_media_template' - $ref: '#/components/schemas/rcs_payments_richcrdstdle_template' - $ref: '#/components/schemas/rcs_payments_richcrdcarousel_template' - $ref: '#/components/schemas/rcs_payments_urlsugg_template' examples: India Template: value: payment: amount: value: '{Amount in paise}' currency: INR mode: ALL region: INDIA merchant_name: Routemobile extra: some: key channels: - rcs rcs: type: template phone_no: '{Phone number with county code}' bot_name: Routemobile template: name: '{Template name}' variables: '{var1}': '{Name}' '{var2}': Text: value: payment: amount: value: '{Amount in paise}' currency: INR mode: ALL region: INDIA merchant_name: Routemobile extra: some: key channels: - rcs rcs: type: text phone_no: '{mobile number with country code}' bot_name: '{RML agent name}' text: '{plain text}' suggestions: - type: url text: '{label}' url: postback: '{postback label}' fallback_text: '{value {#var#} value}' Media: value: payment: amount: value: '{Amount in paise}' currency: INR mode: ALL region: INDIA merchant_name: Routemobile extra: some: key channels: - rcs rcs: type: media phone_no: '{mobile number with country code}' bot_name: '{RML agent name}' url: '{sample (image/video mp4) url starting with https://}' suggestions: - type: url text: '{label}' url: postback: '{postback label}' fallback_text: '{value {#var#} value}' Rich Card Standalone: value: payment: amount: value: '{Amount in paise}' currency: INR mode: ALL region: INDIA merchant_name: Routemobile extra: some: key channels: - rcs rcs: type: card phone_no: '{mobile number with country code}' bot_name: '{RML agent name}' url: '{sample (image/video mp4) url starting with https://}' card: title: '{label}' description: '{plain text}' url: '{sample (image/video mp4) url starting with https://}' suggestions: - type: url text: '{label}' url: postback: '{postback label}' fallback_text: '{value {#var#} value}' Rich Card Carousel: value: payment: amount: value: '{Amount in paise}' currency: INR mode: ALL region: INDIA merchant_name: Routemobile extra: some: key channels: - rcs rcs: type: multiple_cards phone_no: '{mobile number with country code}' bot_name: '{RML agent name}' cards: - card: title: '{label}' description: '{plain text}' url: '{sample (image/video mp4) url starting with https://}' suggestions: - type: url text: '{label}' url: postback: '{postback label}' - card: title: '{label}' description: '{plain text}' url: '{sample (image/video mp4) url starting with https://}' suggestions: - type: dial text: '{label}' call_to: '{your number}' postback: '{postback label}' - card: title: '{label}' description: '{plain text}' url: '{sample (image/video mp4) url starting with https://}' suggestions: - type: url text: '{label}' url: '{url with http://}' postback: '{postback label}' fallback_text: '{value {#var#} value}' URL Suggestion: value: payment: amount: value: '{Amount in paise}' currency: INR mode: ALL region: INDIA merchant_name: Routemobile extra: some: key channels: - rcs rcs: type: media phone_no: '{mobile number with country code}' bot_name: '{RML agent name}' url: '{sample (image/video mp4) url starting with https://}' suggestions: - type: url text: '{label}' url: postback: '{postback label}' fallback_text: '{value {#var#} value}' responses: '202': description: Accepted content: application/json: schema: type: object properties: request_id: type: string description: "The unique identifier for the original request or message.\r\n" status: type: string description: The status of the message delivery. timestamp: type: string description: "The timestamp of when the message was received or sent.\r\n" '400': description: Bad Request content: application/json: schema: type: object properties: status: type: string description: The status of the message delivery. errors: type: object description: The error message. properties: payment: type: object description: The payment amount. properties: region: type: array description: 'The region for the payment. ' items: type: string '401': description: Unauthorized content: application/json: schema: type: object properties: status: type: string description: The status of the message delivery. '403': description: Forbidden content: application/json: schema: type: object properties: status: type: string description: The status of the message delivery. '404': description: Page Not Found content: application/json: schema: type: object properties: detail: type: string description: The page not found message. '429': description: Too Many Requests content: application/json: schema: type: object properties: message: type: string description: Rate limit exceeded message. retry_after: type: integer description: Number of seconds to wait before retrying. examples: Rate Limit Exceeded: value: message: Rate limit exceeded. Please retry after the specified time. retry_after: 60 '500': description: Internal Server Error content: application/json: schema: type: object properties: status: type: string description: The status of the message delivery. errors: type: string description: The error message. security: - jwt: [] /rcs/v1/typing_event: post: tags: - RCS Messages Request API summary: Typing Indicator description: 'The Typing Indicator API indicates to the recipient that the bot or sender is typing a response. ' operationId: typingIndicator requestBody: description: '' required: true content: application/json: schema: type: object properties: request_id: type: string description: The ID of the request, which can be generated by the client. phone_no: type: string description: The phone number of the recipient, including the country code. bot_name: type: string description: The name of the bot associated with the message request. required: - request_id - phone_no - bot_name examples: Example 1: value: request_id: MxZBgOG-VMSraf8Py-C0xxxx phone_no: Number with country code bot_name: Routemobile responses: '200': description: Success content: application/json: schema: type: object properties: status: type: string description: The status of the message delivery. message: type: string description: The response message. examples: Example 1: value: status: success message: Is Typing request sent successfully '400': description: Bad Request content: application/json: schema: type: object properties: status: type: string description: The status of the message delivery. message: type: string description: The response message. examples: Example 1: value: status: failed message: Is Typing request could not be sent, please contact administration '401': description: Authentication Failure content: application/json: schema: type: object properties: status: type: string description: The status of the message delivery. message: type: string description: The response message. examples: Example 1: value: status: failed message: Unauthorised '404': description: Page Not Found content: application/json: schema: type: object properties: message: type: string description: The response message. '429': description: Too Many Requests content: application/json: schema: type: object properties: message: type: string description: Rate limit exceeded message. retry_after: type: integer description: Number of seconds to wait before retrying. examples: Rate Limit Exceeded: value: message: Rate limit exceeded. Please retry after the specified time. retry_after: 60 '500': description: Internal Server Error content: application/json: schema: type: object properties: status: type: string description: The status of the response message. errors: type: string description: "The error for not processing the request.\r\n\r\n" examples: Example 1: value: status: failed errors: Contact administration for more info security: - jwt: [] /rcs/file_server/v2/uploadfile: post: tags: - File Server API summary: File Upload API description: 'File Upload API is used to upload files for a given called bot name which is usually supported for a file server. ' operationId: fileUploadRCS requestBody: description: Upload a binary media file along with the bot name. required: true content: multipart/form-data: schema: $ref: '#/components/schemas/rcs_upload_file_text_msg' examples: File Upload: value: file: bot_name: '{RML agent name}' responses: '202': description: Accepted content: application/json: schema: type: object properties: message: type: string description: The response message. file_id: type: string description: The unique ID of the campaign. examples: Example 1: value: file_id: file id with alphanumerical values: null message: File uploaded successfully '400': description: Bad Request content: application/json: schema: type: object properties: status: type: string description: The status of the message delivery. errors: type: object description: "The error for not processing the request.\r\n\r\n" properties: text: type: array description: The error description. items: type: string examples: Example 1: value: status: string errors: text: - string '401': description: Unauthorized content: application/json: schema: type: object properties: status: type: string description: The status of the message delivery. examples: Example 1: value: status: string '403': description: Forbidden content: application/json: schema: type: object properties: status: type: string description: The status of the message delivery. examples: Example 1: value: status: string '404': description: Not Found content: application/json: schema: type: object properties: message: type: string description: The message response. '429': description: Too Many Requests content: application/json: schema: type: object properties: message: type: string description: Rate limit exceeded message. retry_after: type: integer description: Number of seconds to wait before retrying. examples: Rate Limit Exceeded: value: message: Rate limit exceeded. Please retry after the specified time. retry_after: 60 '500': description: Internal Server Error content: application/json: schema: type: object properties: status: type: string description: The status of the message delivery. errors: type: string description: "The error for not processing the request.\r\n\r\n" examples: Example 1: value: status: string errors: string security: - jwt: [] /rcs/management/v1/add_tester: post: tags: - Management API summary: Make a Tester description: 'Add Tester is a Management API used to add a bot for testing purpose for all RCS Components ' operationId: ManagementRCS requestBody: description: '' required: true content: application/json: schema: $ref: '#/components/schemas/rcs_management_add_tester' examples: Form Data: value: phone_no: '{phone_number}' bot_name: '{RML agent name}' responses: '202': description: Accepted content: application/json: schema: type: object properties: response: type: string description: The response message. status: type: string description: The unique ID of the campaign. examples: Example 1: value: response: Submitted, Tester Invite Sent status: status application/xml: schema: type: object '400': description: Bad Request content: application/json: schema: type: object properties: status: type: string description: The status of the message delivery. errors: type: object description: "The error for not processing the request.\r\n\r\n" properties: text: type: array description: The error description. items: type: string examples: Example 1: value: status: string errors: text: - string '401': description: Unauthorized content: application/json: schema: type: object properties: response: type: string description: The response of the message delivery. examples: Example 1: value: response: string '403': description: Forbidden content: application/json: schema: type: object properties: status: type: string description: The status of the message delivery. examples: Example 1: value: status: string '404': description: Not Found content: application/json: schema: type: object properties: message: type: string description: The message response. '429': description: Too Many Requests content: application/json: schema: type: object properties: message: type: string description: Rate limit exceeded message. retry_after: type: integer description: Number of seconds to wait before retrying. examples: Rate Limit Exceeded: value: message: Rate limit exceeded. Please retry after the specified time. retry_after: 60 '500': description: Internal Server Error content: application/json: schema: type: object properties: status: type: string description: The status of the message delivery. errors: type: string description: "The error for not processing the request.\r\n\r\n" examples: Example 1: value: status: string errors: string security: - jwt: [] /rcs/management/v1/get_testers: get: tags: - Management API summary: List all Testers description: 'List all Testers is a Management API used to retrieve all bot number for testing purpose for all RCS Components ' operationId: managementRCS responses: '202': description: Accepted content: application/json: schema: type: object properties: response: type: string description: The response message. status: type: string description: The unique ID of the campaign. examples: Example 1: value: response: Submitted, Tester Invite Sent status: status application/xml: schema: type: object '400': description: Bad Request content: application/json: schema: type: object properties: status: type: string description: The status of the message delivery. errors: type: object description: "The error for not processing the request.\r\n\r\n" properties: text: type: array description: The error description. items: type: string examples: Example 1: value: status: string errors: text: - string '401': description: Unauthorized content: application/json: schema: type: object properties: response: type: string description: The response of the message delivery. examples: Example 1: value: response: string '403': description: Forbidden content: application/json: schema: type: object properties: status: type: string description: The status of the message delivery. examples: Example 1: value: status: string '404': description: Not Found content: application/json: schema: type: object properties: message: type: string description: The message response. '429': description: Too Many Requests content: application/json: schema: type: object properties: message: type: string description: Rate limit exceeded message. retry_after: type: integer description: Number of seconds to wait before retrying. examples: Rate Limit Exceeded: value: message: Rate limit exceeded. Please retry after the specified time. retry_after: 60 '500': description: Internal Server Error content: application/json: schema: type: object properties: status: type: string description: The status of the message delivery. errors: type: string description: "The error for not processing the request.\r\n\r\n" examples: Example 1: value: status: string errors: string security: - jwt: [] /rcs/optins/v1/create_optin: post: tags: - RCS Optin API summary: Create Optin API description: 'Create Optin API is used to create optin for a given called bot name which is usually supported along with channel. ' operationId: optinRCS requestBody: description: '' required: true content: application/json: schema: $ref: '#/components/schemas/rcs_create_optin' examples: Create Optin: value: mobile_number: '+917045345285' bot_name: Routemobile channel: third_party responses: '202': description: Accepted content: application/json: schema: type: object properties: message: type: string description: The response message. file_id: type: string description: The unique ID of the campaign. examples: Example 1: value: file_id: file id with alphanumerical values: null message: File uploaded successfully '400': description: Bad Request content: application/json: schema: type: object properties: status: type: string description: The status of the message delivery. errors: type: object description: "The error for not processing the request.\r\n\r\n" properties: text: type: array description: The error description. items: type: string examples: Example 1: value: status: string errors: text: - string '401': description: Unauthorized content: application/json: schema: type: object properties: status: type: string description: The status of the message delivery. examples: Example 1: value: status: string '403': description: Forbidden content: application/json: schema: type: object properties: status: type: string description: The status of the message delivery. examples: Example 1: value: status: string '404': description: Not Found content: application/json: schema: type: object properties: message: type: string description: The message response. '429': description: Too Many Requests content: application/json: schema: type: object properties: message: type: string description: Rate limit exceeded message. retry_after: type: integer description: Number of seconds to wait before retrying. examples: Rate Limit Exceeded: value: message: Rate limit exceeded. Please retry after the specified time. retry_after: 60 '500': description: Internal Server Error content: application/json: schema: type: object properties: status: type: string description: The status of the message delivery. errors: type: string description: "The error for not processing the request.\r\n\r\n" examples: Example 1: value: status: string errors: string security: - jwt: [] /rcs/v1/mark_read: post: tags: - RCS Messages Request API summary: Marking messages as Read description: The API will mark the messages as read for the recipient, indicating they have been viewed or acknowledged. This API is useful for tracking the delivery and engagement of messages sent through RCS business messaging. operationId: markingMessagesAsRead requestBody: required: true content: application/json: schema: type: object properties: request_id: type: string description: The ID of the request, which can be generated by the client. phone_no: type: string description: The phone number of the recipient, including the country code. bot_name: type: string description: The name of the bot associated with the message request. required: - request_id - phone_no - bot_name examples: Example 1: value: request_id: MxZBgOG-VMSraf8Py-C09xxxx phone_no: Number with country code bot_name: Routemobile responses: '200': description: Success content: application/json: schema: type: object properties: status: type: string description: The status of the message delivery. message: type: string description: The response message. examples: Example 1: value: status: success message: Read request sent successfully '400': description: Bad Request content: application/json: schema: type: object properties: status: type: string description: The status of the message delivery. message: type: string description: The response message. examples: Example 1: value: status: failed message: Read request could not be sent, please contact administration '401': description: Authentication Failure content: application/json: schema: type: object properties: status: type: string description: The status of the message delivery. message: type: string description: The response message. examples: Example 1: value: status: failed message: Unauthorised '404': description: Page Not Found content: application/json: schema: type: object properties: message: type: string description: The response message. '429': description: Too Many Requests content: application/json: schema: type: object properties: message: type: string description: Rate limit exceeded message. retry_after: type: integer description: Number of seconds to wait before retrying. examples: Rate Limit Exceeded: value: message: Rate limit exceeded. Please retry after the specified time. retry_after: 60 '500': description: Internal Server Error content: application/json: schema: type: object properties: status: type: string description: The status of the message delivery. message: type: string description: The response message. examples: Example 1: value: status: failed message: Read request could not be sent, please contact administration security: - jwt: [] /rcs/v2/revoke_message: delete: tags: - RCS Messages Request API summary: Revoke with SMS fallback description: 'The API will handle the revocation of the specified message for the recipient. ' operationId: revokeWithSmsFallback responses: '200': description: Success content: application/json: schema: type: object properties: status: type: string description: The status of the message delivery. message: type: string description: The response message. examples: Example 1: value: status: success message: Message Revoke request sent successfully '400': description: Bad Request content: application/json: schema: type: object properties: status: type: string description: The status of the message delivery. message: type: string description: The response message. examples: Example 1: value: status: failed message: Revoke request could not be sent, please contact administration '401': description: Authentication Failure content: application/json: schema: type: object properties: status: type: string description: The status of the message delivery. message: type: string description: The response message. examples: Example 1: value: status: failed message: Unauthorised '404': description: Page Not Found content: application/json: schema: type: object properties: message: type: string description: The response message. '429': description: Too Many Requests content: application/json: schema: type: object properties: message: type: string description: Rate limit exceeded message. retry_after: type: integer description: Number of seconds to wait before retrying. examples: Rate Limit Exceeded: value: message: Rate limit exceeded. Please retry after the specified time. retry_after: 60 '500': description: Internal Server Error content: application/json: schema: type: object properties: status: type: string description: The status of the message delivery. message: type: string description: The response message. examples: Example 1: value: status: failed message: Revoke request could not be sent, please contact administration security: - jwt: [] /callback: post: tags: - Callback API summary: Callback description: 'Use the Callback API to receive real-time RCS notifications of incoming messages and other events. ' operationId: post-callback requestBody: required: true content: application/json: schema: oneOf: - $ref: '#/components/schemas/rcs_callback_incoming_text' - $ref: '#/components/schemas/rcs_callback_incoming_image' - $ref: '#/components/schemas/rcs_callback_incoming_location' - $ref: '#/components/schemas/rcs_callback_incoming_suggaction' - $ref: '#/components/schemas/rcs_callback_incoming_suggestion_reply' - $ref: '#/components/schemas/rcs_callback_incoming_video' - $ref: '#/components/schemas/rcs_callback_incoming_document' - $ref: '#/components/schemas/rcs_callback_status_read_delivered' - $ref: '#/components/schemas/rcs_callback_status_failed' - $ref: '#/components/schemas/rcs_callback_fallback_whatsapp' examples: Incoming Text: value: bot_name: Routemobile event_type: text_message request_id: Mx068dFMQbSWm7zPxvVFIxxxx session_id: 1d80575f-fe51-4ea9-b1b4-883ded8fxxxx text_message: Hi timestamp: 2023-05-23T09:14:36.2599xxx user_contact: '{phone}' username: demo Incoming Image: value: bot_name: Routemobile event_type: media_message media_name: 16656.jpg media_size: '193386' media_type: image media_uri: https://www.example.com/a502a4e475d7f700cead51b416a1040ed53f2c607a6d87790561d5xxxxxx request_id: MxE3=LDqIZRqKVzsjLPIxxxx session_id: b19d033c-a159-4565-8d3d-8d527abaxxxx timestamp: 2023-04-02T10:49:30.9598xxxx user_contact: '{phone}' username: demo Incoming Location: value: request_id: 01bc1fcd-6ceb-473d-bd17-b0979ea2xxxx user_contact: '{phone}' timestamp: 2021-02-06T03:50:00.432xxxx bot_name: VMart username: vmartretail session_id: 72cfbb87-f7bf-4e02-bd40-322e4e35xxxxx event_type: location latitude: 19.1453xxx longitude: 72.8236xxx Incoming Suggestion Action (URL/Dial): value: bot_name: Routemobile event_type: response request_id: MxoUu=Ito5SfCX-SVJ0jmxxxx response_postback: url response_text: Tap me session_id: b19d033c-a159-4565-8d3d-8d527abaxxxx suggestion_type: action timestamp: 2023-04-02T12:02:33.594xxxx user_contact: '{phone}' username: demo Incoming Suggestion Reply: value: bot_name: Routemobile event_type: response request_id: Mxtq0v4sL6T1Oa2WpBXxxxxx response_postback: test response_text: Nice session_id: b19d033c-a159-4565-8d3d-8d527abaxxxx suggestion_type: reply timestamp: 2023-04-02T12:03:03.315xxxx user_contact: '{phone}' username: demo Incoming Video: value: bot_name: Routemobile event_type: media_message media_name: 15584.mp4 media_size: '8372956' media_type: video media_uri: https://www.example.com/8ffc96b86dd5a47a1b3e0c5baf68b952998e561e681cf92f6539xxxxxxx request_id: Mx1DOwT7ZHRN-8Gzu2PFxxxxx session_id: b19d033c-a159-4565-8d3d-8d527abxxxxx timestamp: 2023-04-02T10:50:45.8520xxx user_contact: '{phone}' username: demo Incoming Document: value: bot_name: Routemobile event_type: media_message media_name: Ticket.pdf media_size: '160827' media_type: application media_uri: https://www.example.com/9108880408b94cf4a9dfb48002ac580ed868962d757321463a2b8dxxxxx request_id: Mxi3EWJ6TvQkeJZ4MZbPxxxx2 session_id: b19d033c-a159-4565-8d3d-8d527abxxxxx1 timestamp: 2023-04-02T10:51:33.554xxxxx user_contact: '{phone}' username: demo Status (Read/Delivered): value: bot_name: Routemobile event_type: status message_id: 66b3ef00-d14e-11ed-a253-0a58a9xxxxx message_status: READ/DELIVERED timestamp: 2023-04-02T12:03:43.655xxxxxx user_contact: '{phone}' extra: extra username: demo campaign_name: '{campaign_name}' campaign_id: '{campaign_id}' Status Failed: value: bot_name: Routemobile event_type: status message_id: 66b3ef00-d14e-11ed-a253-0a58a9fxxxxx message_status: FAILED failure_reason: 'The supplied file URL https://storage.googleapis.com/kitchen-sink-xxxxx-images/xxxxt.jpg is invalid Code: INVALID_ARGUMENT' timestamp: 2023-04-02T12:03:43.6557xxxx user_contact: '{phone}' extra: extra username: demo campaign_name: '{campaign_name}' campaign_id: '{campaign_id}' Fallback to Whatsapp: value: bot_name: Routemobile event_type: status message_id: 66b3ef00-d14e-11ed-a253-0a58a9feac02 message_status: fallback timestamp: '2023-04-02T12:03:43.655710Z' user_contact: '+917045345285' whatsapp_message_id: 11b3ef00-d14e-11ed-a253-0a58a9feac02 extra: extra username: demo responses: '200': description: OK /rcs-template-apis/api/v1/template/template: post: tags: - RCS Template API summary: Create Template APi description: RCS Create Template APIs allows businesses to create existing templates created by using RML Panel which can be used efficiently send personalized and interactive messages to their customers at scale. operationId: createTemplateRCS responses: '202': description: Accepted content: application/json: schema: type: object properties: message: type: string description: The response message. campaign_id: type: string description: The unique ID of the campaign. examples: Example 1: value: message: Message request has been created campaign_id: 1xx application/xml: schema: type: object '400': description: Bad Request content: application/json: schema: type: object properties: status: type: string description: The status of the message delivery. errors: type: object description: "The error for not processing the request.\r\n\r\n" properties: text: type: array description: The error description. items: type: string examples: Example 1: value: status: string errors: text: - string '401': description: Unauthorized content: application/json: schema: type: object properties: status: type: string description: The status of the message delivery. examples: Example 1: value: status: string '403': description: Forbidden content: application/json: schema: type: object properties: status: type: string description: The status of the message delivery. examples: Example 1: value: status: string '404': description: Not Found content: application/json: schema: type: object properties: message: type: string description: The message response. '429': description: Too Many Requests content: application/json: schema: type: object properties: message: type: string description: Rate limit exceeded message. retry_after: type: integer description: Number of seconds to wait before retrying. examples: Rate Limit Exceeded: value: message: Rate limit exceeded. Please retry after the specified time. retry_after: 60 '500': description: Internal Server Error content: application/json: schema: type: object properties: status: type: string description: The status of the message delivery. errors: type: string description: "The error for not processing the request.\r\n\r\n" examples: Example 1: value: status: string errors: string security: - jwt: [] requestBody: description: '' required: true content: application/json: schema: oneOf: - $ref: '#/components/schemas/rcs_create_template_text' - $ref: '#/components/schemas/rcs_create_template_text_with_pdf' - $ref: '#/components/schemas/rcs_create_template_richcard' - $ref: '#/components/schemas/rcs_create_template_carousel' examples: Text: value: name: '{template name}' type: '{template type}' textMessageContent: '{template content for text message template}' suggestions: [] templateDetails: username: '{username of account}' bot_name: '{RML Agent Name}' variables: [] category: text system_ip: '{system ip}' payload: {} Text with pdf: value: name: '{template name}' type: '{template type}' textMessageContent: '{template content for text message template}' suggestions: [] templateDetails: username: '{username of account}' bot_name: '{RML Agent Name}' variables: [] category: text_message_with_pdf payload: {} textMessageContent: '{template content for text message template}' suggestions: [] documentFileName: '{sample.pdf}' messageOrder: text_message_at_top Rich Card Standalone: value: name: '{template name}' type: '{template type}' orientation: '{orientation of template}' height: '{height of template}' standAlone: cardTitle: '{rich card title}' cardDescription: '{rich card description}' fileName: '{file name}' thumbnailFileName: '{thumbnail file name}' suggestions: - suggestionType: '{suggestion type}' displayText: '{display text}' postback: '{postback text}' templateDetails: username: '{user name}' bot_name: '{RML Agent Name}' variables: [] category: rich_card system_ip: '{system ip}' payload: {} Rich Card Carousel: value: name: '{template name}' type: '{template type}' height: '{height of template}' width: '{width of template}' carouselList: - cardTitle: '{title of card in carouselList}' cardDescription: '{description of card in carouselList}' fileName: '{fileName of card in carouselList}' suggestions: - suggestionType: url_action url: xxxxxx://xxxxxxxxxx.xx/ displayText: '{display text}' postback: '{postback text}' - cardTitle: Step into the limelight! cardDescription: Choose from new arrival sunglasses. fileName: '{file name of image of card in carouselList}' thumbnailFileName: '{thumbnail file name of image of card in carouselList}' suggestions: - suggestionType: url_action url: xxxxxx://xxxxxxxxxx.xx/ displayText: '{display text}' postback: '{postback text}' templateDetails: username: '{user name}' bot_name: '{RML Agent Name}' variables: [] category: carousel system_ip: '{system ip}' payload: {} put: tags: - RCS Template API summary: Update Template APi description: 'RCS Update Template APIs allows businesses to update existing templates created by using RML Panel which can be used efficiently send personalized and interactive messages to their customers at scale. ' operationId: updateTemplateRCS responses: '202': description: Accepted content: application/json: schema: type: object properties: message: type: string description: The response message. campaign_id: type: string description: The unique ID of the campaign. examples: Example 1: value: message: Message request has been created campaign_id: 1xx application/xml: schema: type: object '400': description: Bad Request content: application/json: schema: type: object properties: status: type: string description: The status of the message delivery. errors: type: object description: "The error for not processing the request.\r\n\r\n" properties: text: type: array description: The error description. items: type: string examples: Example 1: value: status: string errors: text: - string '401': description: Unauthorized content: application/json: schema: type: object properties: status: type: string description: The status of the message delivery. examples: Example 1: value: status: string '403': description: Forbidden content: application/json: schema: type: object properties: status: type: string description: The status of the message delivery. examples: Example 1: value: status: string '404': description: Not Found content: application/json: schema: type: object properties: message: type: string description: The message response. '429': description: Too Many Requests content: application/json: schema: type: object properties: message: type: string description: Rate limit exceeded message. retry_after: type: integer description: Number of seconds to wait before retrying. examples: Rate Limit Exceeded: value: message: Rate limit exceeded. Please retry after the specified time. retry_after: 60 '500': description: Internal Server Error content: application/json: schema: type: object properties: status: type: string description: The status of the message delivery. errors: type: string description: "The error for not processing the request.\r\n\r\n" examples: Example 1: value: status: string errors: string security: - jwt: [] requestBody: description: '' required: true content: application/json: schema: oneOf: - $ref: '#/components/schemas/rcs_update_template_text' - $ref: '#/components/schemas/rcs_update_template_text_with_pdf' - $ref: '#/components/schemas/rcs_update_template_richcard' - $ref: '#/components/schemas/rcs_update_template_carousel' examples: Text: value: name: '{template name}' type: '{template type}' textMessageContent: '{template content for text message template}' suggestions: [] templateDetails: username: '{username of account}' bot_name: '{RML Agent Name}' variables: [] category: text system_ip: '{system ip}' payload: {} Text with pdf: value: name: '{template name}' type: '{template type}' textMessageContent: '{template content for text message template}' suggestions: [] templateDetails: username: '{username of account}' bot_name: '{RML Agent Name}' variables: [] category: text_message_with_pdf payload: {} textMessageContent: '{template content for text message template}' suggestions: [] documentFileName: '{sample.pdf}' messageOrder: text_message_at_top Rich Card Standalone: value: name: '{template name}' type: '{template type}' orientation: '{orientation of template}' height: '{height of template}' standAlone: cardTitle: '{rich card title}' cardDescription: '{rich card description}' fileName: '{file name}' thumbnailFileName: '{thumbnail file name}' suggestions: - suggestionType: '{suggestion type}' displayText: '{display text}' postback: '{postback text}' templateDetails: username: '{user name}' bot_name: '{RML Agent Name}' variables: [] category: rich_card system_ip: '{system ip}' payload: {} Rich Card Carousel: value: name: '{template name}' type: '{template type}' height: '{height of template}' width: '{width of template}' carouselList: - cardTitle: '{title of card in carouselList}' cardDescription: '{description of card in carouselList}' fileName: '{fileName of card in carouselList}' suggestions: - suggestionType: url_action url: xxxxxx://xxxxxxxxxx.xx/ displayText: '{display text}' postback: '{postback text}' - cardTitle: Step into the limelight! cardDescription: Choose from new arrival sunglasses. fileName: '{file name of image of card in carouselList}' thumbnailFileName: '{thumbnail file name of image of card in carouselList}' suggestions: - suggestionType: url_action url: xxxxxx://xxxxxxxxxx.xx/ displayText: '{display text}' postback: '{postback text}' templateDetails: username: '{user name}' bot_name: '{RML Agent Name}' variables: [] category: carousel system_ip: '{system ip}' payload: {} get: tags: - RCS Template API summary: Get Template API description: 'RCS Get Template API is used to retrieve TEMPLATE specified when category,name,bot_name, user_name, template_id, page_no and limit are mentioned to locate the template for testing purpose for all RCS Components ' operationId: getTemplateRCS responses: '202': description: Accepted content: application/json: schema: type: object properties: message: type: string description: The response message. campaign_id: type: string description: The unique ID of the campaign. examples: Example 1: value: message: Message request has been created campaign_id: 1xx application/xml: schema: type: object '400': description: Bad Request content: application/json: schema: type: object properties: status: type: string description: The status of the message delivery. errors: type: object description: "The error for not processing the request.\r\n\r\n" properties: text: type: array description: The error description. items: type: string examples: Example 1: value: status: string errors: text: - string '401': description: Unauthorized content: application/json: schema: type: object properties: status: type: string description: The status of the message delivery. examples: Example 1: value: status: string '403': description: Forbidden content: application/json: schema: type: object properties: status: type: string description: The status of the message delivery. examples: Example 1: value: status: string '404': description: Not Found content: application/json: schema: type: object properties: message: type: string description: The message response. '429': description: Too Many Requests content: application/json: schema: type: object properties: message: type: string description: Rate limit exceeded message. retry_after: type: integer description: Number of seconds to wait before retrying. examples: Rate Limit Exceeded: value: message: Rate limit exceeded. Please retry after the specified time. retry_after: 60 '500': description: Internal Server Error content: application/json: schema: type: object properties: status: type: string description: The status of the message delivery. errors: type: string description: "The error for not processing the request.\r\n\r\n" examples: Example 1: value: status: string errors: string security: - jwt: [] delete: tags: - RCS Template API summary: Delete Template API description: 'RCS Delete Template API is used to delete TEMPLATE specified when name and bot_name are mentioned to locate the template for testing purpose for all RCS Components ' operationId: deleteTemplateRCS responses: '202': description: Accepted content: application/json: schema: type: object properties: message: type: string description: The response message. campaign_id: type: string description: The unique ID of the campaign. examples: Example 1: value: success: true, message: Template Deleted successfully !! application/xml: schema: type: object '400': description: Bad Request content: application/json: schema: type: object properties: status: type: string description: The status of the message delivery. errors: type: object description: "The error for not processing the request.\r\n\r\n" properties: text: type: array description: The error description. items: type: string examples: Example 1: value: status: string errors: text: - string '401': description: Unauthorized content: application/json: schema: type: object properties: status: type: string description: The status of the message delivery. examples: Example 1: value: status: string '403': description: Forbidden content: application/json: schema: type: object properties: status: type: string description: The status of the message delivery. examples: Example 1: value: status: string '404': description: Not Found content: application/json: schema: type: object properties: message: type: string description: The message response. '429': description: Too Many Requests content: application/json: schema: type: object properties: message: type: string description: Rate limit exceeded message. retry_after: type: integer description: Number of seconds to wait before retrying. examples: Rate Limit Exceeded: value: message: Rate limit exceeded. Please retry after the specified time. retry_after: 60 '500': description: Internal Server Error content: application/json: schema: type: object properties: status: type: string description: The status of the message delivery. errors: type: string description: "The error for not processing the request.\r\n\r\n" examples: Example 1: value: status: string errors: string security: - jwt: [] /rcs-template-apis/api/v1/template//template: get: tags: - RCS Template API summary: Get Template Status APi description: RCS Get Template Status API allows businesses to get existing templates created by using RML Panel using parameters templateName and bot_name which can be used efficiently send personalized and interactive messages to their customers at scale. operationId: getTemplateStatusRCS responses: '202': description: Accepted content: application/json: schema: type: object properties: message: type: string description: The response message. campaign_id: type: string description: The unique ID of the campaign. examples: Example 1: value: message: Message request has been created campaign_id: 1xx application/xml: schema: type: object '400': description: Bad Request content: application/json: schema: type: object properties: status: type: string description: The status of the message delivery. errors: type: object description: "The error for not processing the request.\r\n\r\n" properties: text: type: array description: The error description. items: type: string examples: Example 1: value: status: string errors: text: - string '401': description: Unauthorized content: application/json: schema: type: object properties: status: type: string description: The status of the message delivery. examples: Example 1: value: status: string '403': description: Forbidden content: application/json: schema: type: object properties: status: type: string description: The status of the message delivery. examples: Example 1: value: status: string '404': description: Not Found content: application/json: schema: type: object properties: message: type: string description: The message response. '429': description: Too Many Requests content: application/json: schema: type: object properties: message: type: string description: Rate limit exceeded message. retry_after: type: integer description: Number of seconds to wait before retrying. examples: Rate Limit Exceeded: value: message: Rate limit exceeded. Please retry after the specified time. retry_after: 60 '500': description: Internal Server Error content: application/json: schema: type: object properties: status: type: string description: The status of the message delivery. errors: type: string description: "The error for not processing the request.\r\n\r\n" examples: Example 1: value: status: string errors: string security: - jwt: [] /rcs-template-apis/api/v1//template//template: get: tags: - RCS Template API summary: Get Single Template APi description: RCS Get Single Template API allows businesses to get one of existing templates created by using RML Panel using parameters name and bot_name which can be used efficiently send personalized and interactive messages to their customers at scale. operationId: getSingleTemplateRCS responses: '202': description: Accepted content: application/json: schema: type: object properties: message: type: string description: The response message. campaign_id: type: string description: The unique ID of the campaign. examples: Example 1: value: message: Message request has been created campaign_id: 1xx application/xml: schema: type: object '400': description: Bad Request content: application/json: schema: type: object properties: status: type: string description: The status of the message delivery. errors: type: object description: "The error for not processing the request.\r\n\r\n" properties: text: type: array description: The error description. items: type: string examples: Example 1: value: status: string errors: text: - string '401': description: Unauthorized content: application/json: schema: type: object properties: status: type: string description: The status of the message delivery. examples: Example 1: value: status: string '403': description: Forbidden content: application/json: schema: type: object properties: status: type: string description: The status of the message delivery. examples: Example 1: value: status: string '404': description: Not Found content: application/json: schema: type: object properties: message: type: string description: The message response. '429': description: Too Many Requests content: application/json: schema: type: object properties: message: type: string description: Rate limit exceeded message. retry_after: type: integer description: Number of seconds to wait before retrying. examples: Rate Limit Exceeded: value: message: Rate limit exceeded. Please retry after the specified time. retry_after: 60 '500': description: Internal Server Error content: application/json: schema: type: object properties: status: type: string description: The status of the message delivery. errors: type: string description: "The error for not processing the request.\r\n\r\n" examples: Example 1: value: status: string errors: string security: - jwt: [] /v1/capabilityCheck/getCapabilityDetails: get: tags: - Capability Check API summary: Bulk Capability Check description: The Bulk Capability Check API retrieves RCS capability details for phone numbers that were submitted for capability checking. Use the date range and optional status filter to paginate through results. operationId: getCapabilityDetails parameters: - name: startDate in: query description: The start date for filtering capability check results (YYYY-MM-DD). required: true schema: type: string format: date - name: endDate in: query description: The end date for filtering capability check results (YYYY-MM-DD). required: true schema: type: string format: date - name: pageNo in: query description: The page number for paginated results (starts at 1). required: true schema: type: integer - name: pageSize in: query description: The number of records to return per page. required: true schema: type: integer responses: '200': description: Success content: application/json: schema: type: object properties: total: type: integer description: Total number of records matching the query. pageNo: type: integer description: Current page number. pageSize: type: integer description: Number of records per page. data: type: array description: List of capability check records. items: type: object properties: phone_no: type: string description: The phone number that was checked. status: type: string description: RCS capability status of the number. enum: - RCS_ENABLED - NOT_RCS_ENABLED checked_at: type: string format: date-time description: Timestamp when the capability check was performed. examples: Example 1: value: total: 100 pageNo: 1 pageSize: 5 data: - phone_no: '+919876543210' status: RCS_ENABLED checked_at: '2026-04-15T10:30:00Z' - phone_no: '+919876543211' status: NOT_RCS_ENABLED checked_at: '2026-04-15T10:30:01Z' '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string description: The error message. status: type: string description: The status of the request. examples: Missing Parameters: value: status: failed message: startDate and endDate are required parameters. '401': description: Unauthorized content: application/json: schema: type: object properties: message: type: string description: The response message. status: type: string description: The status of the request. examples: JWT Token Expired: value: status: failed message: jwt token expired '429': description: Too Many Requests content: application/json: schema: type: object properties: message: type: string description: Rate limit exceeded message. retry_after: type: integer description: Number of seconds to wait before retrying. examples: Rate Limit Exceeded: value: message: Rate limit exceeded. Please retry after the specified time. retry_after: 60 '500': description: Internal Server Error content: application/json: schema: type: object properties: message: type: string description: The error message. status: type: string description: The status of the request. examples: Example 1: value: status: failed message: unable to process request security: - jwt: [] /v1/capabilityCheck/checkBulkCapability: post: tags: - Capability Check API summary: Check Bulk Capability description: Upload a CSV file containing phone numbers to trigger a bulk RCS capability check. The file should contain one phone number per row. After submission, use the Fetch Bulk Capability Details API to retrieve the results once processing is complete. operationId: checkBulkCapability requestBody: required: true content: multipart/form-data: schema: type: object properties: file: type: string format: binary description: A CSV file containing the phone numbers to check for RCS capability. One phone number per row including country code. botName: type: string description: The RCS agent (bot) name associated with your account. example: '{RML agent name}' required: - file - botName examples: Upload CSV: value: file: botName: '{RML agent name}' responses: '200': description: Success — file accepted for capability checking content: application/json: schema: type: object properties: message: type: string description: Confirmation message for the submitted capability check. status: type: string description: The status of the request. examples: Example 1: value: status: success message: File submitted for bulk capability check successfully. '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string description: The error message. status: type: string description: The status of the request. examples: Missing File: value: status: failed message: file and botName are required. '401': description: Unauthorized content: application/json: schema: type: object properties: message: type: string description: The response message. status: type: string description: The status of the request. examples: JWT Token Expired: value: status: failed message: jwt token expired '429': description: Too Many Requests content: application/json: schema: type: object properties: message: type: string description: Rate limit exceeded message. retry_after: type: integer description: Number of seconds to wait before retrying. examples: Rate Limit Exceeded: value: message: Rate limit exceeded. Please retry after the specified time. retry_after: 60 '500': description: Internal Server Error content: application/json: schema: type: object properties: message: type: string description: The error message. status: type: string description: The status of the request. examples: Example 1: value: status: failed message: unable to process request security: - jwt: [] /rcs/dnd/v1/bulk_dnd_set: post: tags: - Management API summary: Bulk Whitelist / Blacklist Numbers description: The Bulk DND Set API allows you to whitelist or blacklist a batch of phone numbers for a specific RCS bot. Provide the URL of a previously uploaded CSV file (from the File Upload API) containing the phone numbers, and set `dnd_mode` to control whether those numbers are blacklisted (`true`) or whitelisted (`false`). operationId: bulkDndSet requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/rcs_bulk_dnd_set_body' examples: Blacklist Numbers: value: bot_name: '{RML agent name}' file_url: https://apis.rmlconnect.net/v1/download/Misc/{file-id}.csv dnd_mode: true Whitelist Numbers: value: bot_name: '{RML agent name}' file_url: https://apis.rmlconnect.net/v1/download/Misc/{file-id}.csv dnd_mode: false responses: '200': description: Success content: application/json: schema: type: object properties: message: type: string description: The result of the bulk DND operation. status: type: string description: The status of the request. examples: Blacklist Applied: value: status: success message: Numbers blacklisted successfully. Whitelist Applied: value: status: success message: Numbers whitelisted successfully. '400': description: Bad Request content: application/json: schema: type: object properties: message: type: string description: The error message. status: type: string description: The status of the request. examples: Missing bot_name: value: status: failed message: bot_name is required. '401': description: Unauthorized content: application/json: schema: type: object properties: message: type: string description: The response message. status: type: string description: The status of the request. examples: JWT Token Expired: value: status: failed message: jwt token expired '429': description: Too Many Requests content: application/json: schema: type: object properties: message: type: string description: Rate limit exceeded message. retry_after: type: integer description: Number of seconds to wait before retrying. examples: Rate Limit Exceeded: value: message: Rate limit exceeded. Please retry after the specified time. retry_after: 60 '500': description: Internal Server Error content: application/json: schema: type: object properties: message: type: string description: The error message. status: type: string description: The status of the request. examples: Example 1: value: status: failed message: unable to process request security: - jwt: [] tags: - name: Login description: Authenticate users and obtain JWT tokens for RCS API access. - name: RCS Messages API description: Send RCS notification, session, and India template messages including text, media, rich cards, carousels, and interactive suggestions. - name: Bulk Upload Campaign API description: Upload campaign files and manage bulk RCS messaging campaigns at scale. - name: Payment API description: Send RCS payment request messages to customers. - name: RCS Messages Request API description: APIs for managing RCS message requests and retrieving request status. - name: Callback API description: Webhook receiver endpoints for real-time RCS message delivery and event notifications. - name: File Server API description: Upload media files (images, videos, PDFs) to the RCS file server for use in messages. - name: Management API description: APIs for managing RCS bot testers, templates, and account configuration. - name: Capability Check API description: Check and retrieve RCS capability details for phone numbers in bulk. components: securitySchemes: jwt: type: apiKey name: Authorization in: header schemas: v1_login_body: type: object properties: password: type: string description: The secret code that users provide to the application during the login process. example: password username: type: string description: Unique identifier that users provide to the application during the login process. Usernames can be any string of characters. example: username required: - password - username inline_response_201_2: type: object properties: JWTAUTH: type: string description: JSON Web Token Authentication user_data: $ref: '#/components/schemas/inline_response_201_2_user_data' inline_response_201_2_user_data: type: object properties: username: type: string description: The name of the user. first_name: type: string description: The first name of the user. last_name: type: string description: The last name of the user. email: type: string description: The email address of the user. phone_number: type: string description: The user phone number in international format. password_reset: type: boolean description: Indicates whether the password reset. is_active: type: boolean description: Checks if the user is active. is_staff: type: boolean description: Checks if the user is a staff. ip: type: string description: The IP address of the user. child_user: type: boolean description: Indicates if user is a child. parent_username: type: string description: The user of child's parent. rcs_notification_common_msg: type: object title: Notification - Common properties: type: type: string description: "The type of message to be sent.\r\n\r\n" example: Text. Media, Card, or Multiple Cards phone_no: type: string description: The recipient's phone number, including the country code. bot_name: type: string description: The name of the bot sending the message. text: type: string description: The plain text content of the message. This field is required for "text" type messages. url: type: string description: The URL of the media (image or video MP4) starting with https:// to be included in the message. This field is optional for "media" type messages. extra: type: string description: An extra value that can be included in the message. suggestions: type: array description: "An array of suggestions shown as actions for the endpoint. Each suggestion can\ \ have a \"text\" field with plain text content. This field is optional.\r\n\r\n" items: type: object properties: type: type: string description: "The label name for the suggestion.\r\n\r\n" text: type: string description: "The plain text content of the suggestion.\r\n\r\n" url: type: string description: "The (image/pdf/video mp4) url starting with https:// .\r\n\r\n" start: type: string description: "The latitude value associated with the suggestion.\r\n\r\n" end: type: string description: "The longitude value associated with the suggestion.\r\n\r\n" decription: type: string description: "The description associated with the suggestion.\r\n\r\n" latitude: type: string description: "The latitude value associated with the suggestion.\r\n\r\n" longitude: type: string description: "The longitude value associated with the suggestion.\r\n\r\n" call_to: type: string description: "The sender phone number.\r\n\r\n" postback: type: string description: "The postback text or action associated with the suggestion.\r\n\r\n" card: type: object description: "An object representing a standalone rich card. It includes a \"title\", \"description\"\ , \"url\", and an array of \"suggestions\". This field is optional for \"card\" type messages.\r\ \n\r\n" properties: title: type: string description: "The label name for the card.\r\n\r\n" description: type: string description: "A short description of the card.\r\n\r\n" url: type: string description: The (image/pdf/video mp4) url starting with https:// . suggestions: type: array description: "An array of suggestions shown as actions for the endpoint. Each suggestion\ \ can have a \"text\" field with plain text content. This field is optional.\r\n\r\n" items: type: object properties: type: type: string description: "The label name for the suggestion.\r\n\r\n" text: type: string description: "The plain text content of the suggestion.\r\n\r\n" latitude: type: string description: "The latitude value associated with the suggestion.\r\n\r\n" longitude: type: string description: "The longitude value associated with the suggestion.\r\n\r\n" postback: type: string description: "The postback text or action associated with the suggestion.\r\n\r\n" required: - title - description - url cards: type: array description: "An array of objects representing multiple rich cards. Each card object has a \"\ title\", \"description\", \"url\", and an array of \"suggestions\". This field is optional\ \ for \"multiple_cards\" type messages.\r\n\r\n" items: type: object properties: card: type: object description: "An object representing a standalone rich card. It includes a \"title\",\ \ \"description\", \"url\", and an array of \"suggestions\". This field is optional\ \ for \"card\" type messages.\r\n\r\n" properties: title: type: string description: "The label name for the card.\r\n\r\n" description: type: string description: "A short description of the card.\r\n\r\n" url: type: string description: The (image/pdf/video mp4) url starting with https:// . suggestions: type: array description: An array of suggestions shown as actions for the endpoint. Each suggestion can have a "text" field with plain text content. This field is optional. items: type: object properties: type: type: string description: The label name for the suggestion. text: type: string description: The plain text content of the suggestion. postback: type: string description: The postback text or action associated with the suggestion. call_to: type: string description: "The sender phone number.\r\n\r\n" url: type: string description: The (image/pdf/video mp4) url starting with https:// . start: type: string description: "The latitude value associated with the suggestion.\r\n\r\n" end: type: string description: "The longitude value associated with the suggestion.\r\n\r\n" decription: type: string description: "The description associated with the suggestion.\r\n\r\n" required: - title - description - url required: - type - phone_no - bot_name rcs_notification_text_msg: type: object title: Notification - Text description: Standard text messages that send plain text content. properties: type: type: string description: The type of message to be sent. It can be "text". phone_no: type: string description: The recipient's phone number, including the country code. bot_name: type: string description: The name of the bot sending the message. ttl: type: integer description: time to live. expire_time: type: string description: "The date and time at which the message should be expired and should be in the\ \ format YYYY-MM-DD HH:MM:SS.\r\n -Either ttl or expire time can be used in a single message" text: type: string description: The plain text content of the message. This field is required for "text" type messages. extra: type: string description: 'An extra value that can be included in the message. ' suggestions: type: array description: An array of suggestions shown as actions for the endpoint. Each suggestion can have a "text" field with plain text content. This field is optional. items: type: object properties: type: type: string description: The label name for the suggestion. text: type: string description: The plain text content of the suggestion. latitude: type: string description: The latitude value associated with the suggestion. longitude: type: string description: The longitude value associated with the suggestion. postback: type: string description: The postback text or action associated with the suggestion. start: type: string description: "The latitude value associated with the suggestion.\r\n\r\n" end: type: string description: "The longitude value associated with the suggestion.\r\n\r\n" decription: type: string description: "The description associated with the suggestion.\r\n\r\n" fallback_text: type: string description: The fallback text that is displayed on devices. The fallback text to be sent if the RCS message cannot be delivered. This field supports variable substitution using {#var#} format. required: - type - phone_no - bot_name - text rcs_notification_media_imagemp4_msg: type: object title: Notification - Media (Image/Video/pdf) image.png description: Messages that include images to enhance visual communication and short videos, or animated content in MP4 format. properties: type: type: string description: "The type of message to be sent. It can be \"media\".\r\n" phone_no: type: string description: "The recipient's phone number, including the country code.\r\n" bot_name: type: string description: "The name of the bot sending the message.\r\n" url: type: string description: "The URL of the media (image or pdf or video MP4) to be included in the message.\ \ This field is optional for \"media\" type messages.\r\n" thumbnail_url: type: string description: The (image/pdf/video mp4) url starting with https:// . id: type: string description: "The id of the media (image or video MP4) to be included in the message.\r\n" thumbnail_id: type: string description: "The id of the media (image or pdf orvideo MP4) to be included in the message.\r\ \n" extra: type: string description: "An extra value that can be included in the message. This field is optional.\r\n" suggestions: type: array description: An array of suggestions shown as actions for the endpoint. Each suggestion can have a "text" field with plain text content. This field is optional. items: type: object properties: type: type: string description: The label name for the suggestion. text: type: string description: The plain text content of the suggestion. latitude: type: string description: The latitude value associated with the suggestion. longitude: type: string description: The longitude value associated with the suggestion. postback: type: string description: The postback text or action associated with the suggestion. fallback_text: type: string description: 'The fallback text that is displayed on devices. The fallback text to be sent if the RCS message cannot be delivered. This field supports variable substitution using {#var#} format. ' required: - type - phone_no - bot_name rcs_notification_videothumbnailurl_msg: type: object title: Notification - Video With Thumbnail URL description: Messages that support sending media message with thumbnail url to enhance visual communication and short videos or animated content in MP4 format as part of a campaign. properties: type: type: string description: "The type of message to be sent. It can be \"media\".\r\n" phone_no: type: string description: "The recipient's phone number, including the country code.\r\n" bot_name: type: string description: "The name of the bot sending the message.\r\n" card: type: object description: An object representing a standalone rich card. It includes a "title", "description", "url", and an array of "suggestions". This field is optional for "card" type messages. properties: title: type: string description: The label name for the card. description: type: string description: A short description of the card. url: type: string description: The (image/video mp4) url starting with https:// . thumbnail_url: type: string description: The (image/video mp4) url starting with https:// . suggestions: type: array description: "An array of suggestions shown as actions for the endpoint. Each suggestion can\ \ have a \"text\" field with plain text content. This field is optional.\r\n\r\n" items: type: object properties: type: type: string description: "The label name for the suggestion.\r\n\r\n" text: type: string description: "The plain text content of the suggestion.\r\n\r\n" postback: type: string description: "The postback text or action associated with the suggestion.\r\n\r\n" required: - type - phone_no - bot_name rcs_notification_videothumbnailid_msg: type: object title: Notification - Video With Thumbnail ID description: Messages that support sending media message with thumbnail id to enhance visual communication and short videos or animated content in MP4 format as part of a campaign. properties: type: type: string description: "The type of message to be sent. It can be \"media\".\r\n" phone_no: type: string description: "The recipient's phone number, including the country code.\r\n" bot_name: type: string description: "The name of the bot sending the message.\r\n" card: type: object description: An object representing a standalone rich card. It includes a "title", "description", "url", and an array of "suggestions". This field is optional for "card" type messages. properties: title: type: string description: The label name for the card. description: type: string description: A short description of the card. id: type: string description: "The id of the media (image or video MP4) to be included in the message.\r\n" thumbnail_id: type: string description: "The id of the media (image or video MP4) to be included in the message.\r\n" suggestions: type: array description: "An array of suggestions shown as actions for the endpoint. Each suggestion can\ \ have a \"text\" field with plain text content. This field is optional.\r\n\r\n" items: type: object properties: type: type: string description: "The label name for the suggestion.\r\n\r\n" text: type: string description: "The plain text content of the suggestion.\r\n\r\n" postback: type: string description: "The postback text or action associated with the suggestion.\r\n\r\n" required: - type - phone_no - bot_name rcs_notification_richcrdstdalone_msg: type: object title: Notification - Rich Card Standalone description: Messages that contain a standalone rich card with structured content, such as images, titles, descriptions, and buttons. These cards can provide interactive experiences and support various actions. properties: type: type: string description: The type of message to be sent. It can be "card". phone_no: type: string description: The recipient's phone number, including the country code. bot_name: type: string description: "The name of the bot sending the message.\r\n" url: type: string description: "The URL of the media (image or video MP4) to be included in the message. This\ \ field is optional for \"media\" type messages.\r\n" extra: type: string description: "An extra value that can be included in the message. This field is optional.\r\n" card: type: object description: An object representing a standalone rich card. It includes a "title", "description", "url", and an array of "suggestions". This field is optional for "card" type messages. properties: title: type: string description: The label name for the card. description: type: string description: A short description of the card. url: type: string description: The (image/pdf/video mp4) url starting with https:// suggestions: type: array description: An array of suggestions shown as actions for the endpoint. Each suggestion can have a "text" field with plain text content. This field is optional. items: type: object properties: type: type: string description: The label name for the suggestion. text: type: string description: The plain text content of the suggestion. latitude: type: string description: The latitude value associated with the suggestion. longitude: type: string description: The longitude value associated with the suggestion. postback: type: string description: The postback text or action associated with the suggestion. start: type: string description: "The latitude value associated with the suggestion.\r\n\r\n" end: type: string description: "The longitude value associated with the suggestion.\r\n\r\n" decription: type: string description: "The description associated with the suggestion.\r\n\r\n" fallback_text: type: string description: The fallback text that is displayed on devices. The fallback text to be sent if the RCS message cannot be delivered. This field supports variable substitution using {#var#} format. required: - type - phone_no - bot_name rcs_notification_richcrdcarousel_msg: type: object title: Notification - Rich Card Carousel description: Messages that include a carousel of multiple rich cards. Each card within the carousel can have its own unique content and actions. properties: type: type: string description: "The type of message to be sent. It can be \"multiple_cards\".\r\n" phone_no: type: string description: "The recipient's phone number, including the country code.\r\n" bot_name: type: string description: "The name of the bot sending the message.\r\n" extra: type: string description: "An extra value that can be included in the message. This field is optional.\r\n" cards: type: array description: An array of objects representing multiple rich cards. Each card object has a "title", "description", "url", and an array of "suggestions". This field is optional for "multiple_cards" type messages. items: type: object properties: card: type: object description: An object representing a standalone rich card. It includes a "title", "description", "url", and an array of "suggestions". This field is optional for "card" type messages. properties: title: type: string description: The label name for the card. description: type: string description: A short description of the card. url: type: string description: "The (image/pdf/video mp4) url starting with https://\r\n" suggestions: type: array description: An array of suggestions shown as actions for the endpoint. Each suggestion can have a "text" field with plain text content. This field is optional. items: type: object properties: type: type: string description: The label name for the suggestion. text: type: string description: The plain text content of the suggestion. postback: type: string description: The postback text or action associated with the suggestion. call_to: type: string description: The sender phone number. url: type: string description: The (image/pdf/video mp4) url starting with https:// start: type: string description: "The latitude value associated with the suggestion.\r\n\r\n" end: type: string description: "The longitude value associated with the suggestion.\r\n\r\n" decription: type: string description: "The description associated with the suggestion.\r\n\r\n" fallback_text: type: string description: "The fallback text that is displayed on devices. The fallback text to be sent if\ \ the RCS message cannot be delivered. This field supports variable substitution using {#var#}\ \ format.\r\n" required: - type - phone_no - bot_name rcs_notification_urlsugg_msg: type: object title: Notification - URL Suggestion description: Messages that provide suggestions for relevant URLs or links that users can easily access or interact with. properties: type: type: string description: "The type of message to be sent. It can be \"media\".\r\n" phone_no: type: string description: "The recipient's phone number, including the country code.\r\n" bot_name: type: string description: "The name of the bot sending the message.\r\n" url: type: string description: "The URL of the media (image or video MP4) starting with https:// to be included\ \ in the message. This field is optional for \"media\" type messages.\r\n" suggestions: type: array description: An array of suggestions shown as actions for the endpoint. Each suggestion can have a "text" field with plain text content. This field is optional. items: type: object properties: type: type: string description: The label name for the suggestion. text: type: string description: The plain text content of the suggestion. url: type: string description: The (image/pdf/video mp4) url starting with https:// . postback: type: string description: The postback text or action associated with the suggestion. fallback_text: type: string description: "The fallback text that is displayed on devices. The fallback text to be sent if\ \ the RCS message cannot be delivered. This field supports variable substitution using {#var#}\ \ format. \r\n" required: - type - phone_no - bot_name rcs_notification_textsugg_msg: type: object title: Notification - Text Suggestion description: Messages that offer a set of suggested response options for users to choose from, making it easier for them to respond to a message. properties: type: type: string description: "The type of message to be sent. It can be \"text\".\r\n" phone_no: type: string description: "The recipient's phone number, including the country code.\r\n" bot_name: type: string description: "The name of the bot sending the message.\r\n" text: type: string description: "The plain text content of the message. This field is required for \"text\" type\ \ messages.\r\n" suggestions: type: array description: An array of suggestions shown as actions for the endpoint. Each suggestion can have a "text" field with plain text content. This field is optional. items: type: object properties: type: type: string description: The label name for the suggestion. text: type: string description: The plain text content of the suggestion. postback: type: string description: The postback text or action associated with the suggestion. fallback_text: type: string description: 'The fallback text that is displayed on devices. The fallback text to be sent if the RCS message cannot be delivered. This field supports variable substitution using {#var#} format. ' required: - type - phone_no - bot_name - text rcs_notification_dialsugg_msg: type: object title: Notification - Dial Suggestion description: Messages that provide suggested phone numbers or prompts for users to initiate a phone call directly from the messaging app. properties: type: type: string description: The type of message to be sent. It can be "media". phone_no: type: string description: "The recipient's phone number, including the country code.\r\n" bot_name: type: string description: "The name of the bot sending the message.\r\n" url: type: string description: "The URL of the media (image or video MP4) to be included in the message. This\ \ field is optional for \"media\" type messages.\r\n" extra: type: string description: "An extra value that can be included in the message. This field is optional.\r\n" suggestions: type: array description: An array of suggestions shown as actions for the endpoint. Each suggestion can have a "text" field with plain text content. This field is optional. items: type: object properties: type: type: string description: The label name for the suggestion. text: type: string description: The plain text content of the suggestion. call_to: type: string description: The sender phone number. postback: type: string description: The postback text or action associated with the suggestion. fallback_text: type: string description: The fallback text that is displayed on devices. The fallback text to be sent if the RCS message cannot be delivered. This field supports variable substitution using {#var#} format. required: - type - phone_no - bot_name rcs_notification_locationsugg_msg: type: object title: Notification - Location Suggestion description: Messages that suggest specific locations or addresses, allow users to share or navigate to a particular place. properties: type: type: string description: "The type of message to be sent. It can be \"text\".\r\n" phone_no: type: string description: "The recipient's phone number, including the country code.\r\n" bot_name: type: string description: "The name of the bot sending the message.\r\n" text: type: string description: "The plain text content of the message. This field is required for \"text\" type\ \ messages.\r\n" extra: type: string description: "An extra value that can be included in the message. This field is optional.\r\n" suggestions: type: array description: An array of suggestions shown as actions for the endpoint. Each suggestion can have a "text" field with plain text content. This field is optional. items: type: object properties: type: type: string description: The label name for the suggestion. text: type: string description: The plain text content of the suggestion. latitude: type: string description: The latitude value associated with the suggestion. longitude: type: string description: The longitude value associated with the suggestion. postback: type: string description: The postback text or action associated with the suggestion. fallback_text: type: string description: "The fallback text that is displayed on devices. The fallback text to be sent if\ \ the RCS message cannot be delivered. This field supports variable substitution using {#var#}\ \ format. It is optional.\r\n" required: - type - phone_no - bot_name - text rcs_notification_calendarsugg_msg: type: object title: Notification - Calendar Suggestion description: 'Messages that provide suggested calendar or prompts for users to initiate a phone call directly from the messaging app as part of a campaign. ' properties: type: type: string description: "The type of message to be sent.\r\n\r\n" example: Text. Media, Card, or Multiple Cards phone_no: type: string description: The recipient's phone number, including the country code. bot_name: type: string description: The name of the bot sending the message. text: type: string description: The plain text content of the message. This field is required for "text" type messages. suggestions: type: array description: "An array of suggestions shown as actions for the endpoint. Each suggestion can\ \ have a \"text\" field with plain text content. This field is optional.\r\n\r\n" items: type: object properties: type: type: string description: "The label name for the suggestion.\r\n\r\n" text: type: string description: "The plain text content of the suggestion.\r\n\r\n" title: type: string description: "The plain title of the suggestion.\r\n\r\n" url: type: string description: "The (image/pdf/video mp4) url starting with https:// .\r\n\r\n" start: type: string description: "The latitude value associated with the suggestion.\r\n\r\n" end: type: string description: "The longitude value associated with the suggestion.\r\n\r\n" decription: type: string description: "The description associated with the suggestion.\r\n\r\n" postback: type: string description: "The postback text or action associated with the suggestion.\r\n\r\n" rcs_notification_mediaid_msg: type: object title: Notification - Media ID description: Messages that support sending media id to enhance visual communication and short videos or animated content in MP4 format as part of a campaign. properties: type: type: string description: "The type of message to be sent. It can be \"media\".\r\n" phone_no: type: string description: "The recipient's phone number, including the country code.\r\n" bot_name: type: string description: "The name of the bot sending the message.\r\n" id: type: string description: "The id of the media (image or video MP4) to be included in the message.\r\n" required: - type - phone_no - bot_name - id rcs_notification_carslwithids_msg: type: object title: Notification - Rich Card Carousel With IDS description: A message type that consists of multiple cards presented in a carousel format. Each card can have an image, title, description, and interactive components like buttons or links. It CAn also have ids with thumbnail ids in addition for video and images. It provides a visually engaging way to present multiple options or information to users. properties: type: type: string description: "The type of the message.\r\n" phone_no: type: string description: "The recipient's phone number, including the country code.\r\n" bot_name: type: string description: "The name of the bot sending the message.\r\n" cards: type: array description: "An array of objects representing multiple rich cards. Each card object has a \"\ title\", \"description\", \"url\", and an array of \"suggestions\". This field is optional\ \ for \"multiple_cards\" type messages.\r\n" items: type: object properties: card: type: object description: An object representing a standalone rich card. It includes a "title", "description", "url", and an array of "suggestions". This field is optional for "card" type messages. properties: title: type: string description: The label name for the card. description: type: string description: A short description of the card. url: type: string description: The (image/pdf/video mp4) url starting with https:// . id: type: string description: "The id of the media (image or video MP4) to be included in the message.\r\ \n" thumbnail_id: type: string description: "The id of the media (image or video MP4) to be included in the message.\r\ \n" required: - type - phone_no - bot_name rcs_session_common_msg: type: object title: Session - Common properties: type: type: string description: "The type of message to be sent.\r\n\r\n" example: Text. Media, Card, or Multiple Cards phone_no: type: string description: The recipient's phone number, including the country code. bot_name: type: string description: The name of the bot sending the message. text: type: string description: The plain text content of the message. This field is required for "text" type messages. url: type: string description: The URL of the media (image or video MP4) starting with https:// to be included in the message. This field is optional for "media" type messages. extra: type: string description: An extra value that can be included in the message. suggestions: type: array description: "An array of suggestions shown as actions for the endpoint. Each suggestion can\ \ have a \"text\" field with plain text content. This field is optional.\r\n\r\n" items: type: object properties: type: type: string description: "The label name for the suggestion.\r\n\r\n" text: type: string description: "The plain text content of the suggestion.\r\n\r\n" url: type: string description: "The (image/pdf/video mp4) url starting with https:// .\r\n\r\n" latitude: type: string description: "The latitude value associated with the suggestion.\r\n\r\n" longitude: type: string description: "The longitude value associated with the suggestion.\r\n\r\n" call_to: type: string description: "The sender phone number.\r\n\r\n" postback: type: string description: "The postback text or action associated with the suggestion.\r\n\r\n" start: type: string description: "The latitude value associated with the suggestion.\r\n\r\n" end: type: string description: "The longitude value associated with the suggestion.\r\n\r\n" decription: type: string description: "The description associated with the suggestion.\r\n\r\n" card: type: object description: "An object representing a standalone rich card. It includes a \"title\", \"description\"\ , \"url\", and an array of \"suggestions\". This field is optional for \"card\" type messages.\r\ \n\r\n" properties: title: type: string description: "The label name for the card.\r\n\r\n" description: type: string description: "A short description of the card.\r\n\r\n" url: type: string description: The (image/pdf/video mp4) url starting with https:// . suggestions: type: array description: "An array of suggestions shown as actions for the endpoint. Each suggestion\ \ can have a \"text\" field with plain text content. This field is optional.\r\n\r\n" items: type: object properties: type: type: string description: "The label name for the suggestion.\r\n\r\n" text: type: string description: "The plain text content of the suggestion.\r\n\r\n" latitude: type: string description: "The latitude value associated with the suggestion.\r\n\r\n" longitude: type: string description: "The longitude value associated with the suggestion.\r\n\r\n" postback: type: string description: "The postback text or action associated with the suggestion.\r\n\r\n" start: type: string description: "The latitude value associated with the suggestion.\r\n\r\n" end: type: string description: "The longitude value associated with the suggestion.\r\n\r\n" decription: type: string description: "The description associated with the suggestion.\r\n\r\n" required: - title - description - url cards: type: array description: "An array of objects representing multiple rich cards. Each card object has a \"\ title\", \"description\", \"url\", and an array of \"suggestions\". This field is optional\ \ for \"multiple_cards\" type messages.\r\n\r\n" items: type: object properties: card: type: object description: "An object representing a standalone rich card. It includes a \"title\",\ \ \"description\", \"url\", and an array of \"suggestions\". This field is optional\ \ for \"card\" type messages.\r\n\r\n" properties: title: type: string description: "The label name for the card.\r\n\r\n" description: type: string description: "A short description of the card.\r\n\r\n" url: type: string description: The (image/pdf/video mp4) url starting with https:// . suggestions: type: array description: An array of suggestions shown as actions for the endpoint. Each suggestion can have a "text" field with plain text content. This field is optional. items: type: object properties: type: type: string description: The label name for the suggestion. text: type: string description: The plain text content of the suggestion. postback: type: string description: The postback text or action associated with the suggestion. call_to: type: string description: "The sender phone number.\r\n\r\n" url: type: string description: The (image/pdf/video mp4) url starting with https:// . start: type: string description: "The latitude value associated with the suggestion.\r\n\r\n" end: type: string description: "The longitude value associated with the suggestion.\r\n\r\n" decription: type: string description: "The description associated with the suggestion.\r\n\r\n" required: - title - description - url required: - type - phone_no - bot_name rcs_session_text_msg: type: object title: Session - Text description: Standard text messages that send plain text content as part of a campaign. properties: type: type: string description: "The type of message to be sent. It can be \"text\".\r\n" phone_no: type: string description: "The recipient's phone number, including the country code.\r\n" bot_name: type: string description: "The name of the bot sending the message.\r\n" ttl: type: integer description: time to live. expire_time: type: string description: "The date and time at which the message should be expired and should be in the\ \ format YYYY-MM-DD HH:MM:SS.\r\n -Either ttl or expire time can be used in a single message" text: type: string description: "The plain text content of the message. This field is required for \"text\" type\ \ messages.\r\n" extra: type: string description: "An extra value that can be included in the message. This field is optional.\r\n" suggestions: type: array description: An array of suggestions shown as actions for the endpoint. Each suggestion can have a "text" field with plain text content. This field is optional. items: type: object properties: type: type: string description: The label name for the suggestion. text: type: string description: The plain text content of the suggestion. latitude: type: string description: The latitude value associated with the suggestion. longitude: type: string description: The longitude value associated with the suggestion. postback: type: string description: The postback text or action associated with the suggestion. start: type: string description: "The latitude value associated with the suggestion.\r\n\r\n" end: type: string description: "The longitude value associated with the suggestion.\r\n\r\n" decription: type: string description: "The description associated with the suggestion.\r\n\r\n" fallback_text: type: string description: "The fallback text that is displayed on devices. The fallback text to be sent if\ \ the RCS message cannot be delivered. This field supports variable substitution using {#var#}\ \ format. It is optional.\r\n" required: - type - phone_no - bot_name - text rcs_session_mediaimagemp4_msg: type: object title: Notification - Media (Image/Video/pdf) image.png description: Messages that support sending images to enhance visual communication and short videos or animated content in MP4 format as part of a campaign. properties: type: type: string description: "The type of message to be sent. It can be \"media\".\r\n" phone_no: type: string description: "The recipient's phone number, including the country code.\r\n" bot_name: type: string description: "The name of the bot sending the message.\r\n" url: type: string description: "The URL of the media (image or video MP4) to be included in the message. This\ \ field is optional for \"media\" type messages.\r\n" thumbnail_url: type: string description: The (image/pdf/video mp4) url starting with https:// . id: type: string description: "The id of the media (image or video MP4) to be included in the message.\r\n" thumbnail_id: type: string description: "The id of the media (image or video MP4) to be included in the message.\r\n" extra: type: string description: "An extra value that can be included in the message. This field is optional.\r\n" suggestions: type: array description: An array of suggestions shown as actions for the endpoint. Each suggestion can have a "text" field with plain text content. This field is optional. items: type: object properties: type: type: string description: The label name for the suggestion. text: type: string description: The plain text content of the suggestion. latitude: type: string description: The latitude value associated with the suggestion. longitude: type: string description: The longitude value associated with the suggestion. postback: type: string description: The postback text or action associated with the suggestion. start: type: string description: "The latitude value associated with the suggestion.\r\n\r\n" end: type: string description: "The longitude value associated with the suggestion.\r\n\r\n" decription: type: string description: "The description associated with the suggestion.\r\n\r\n" fallback_text: type: string description: "The fallback text that is displayed on devices. The fallback text to be sent if\ \ the RCS message cannot be delivered. This field supports variable substitution using {#var#}\ \ format. It is optional.\r\n" required: - type - phone_no - bot_name rcs_session_videothumbnailurl_msg: type: object title: Session - Video With Thumbnail URL description: Messages that support sending media message with thumbnail url to enhance visual communication and short videos or animated content in MP4 format as part of a campaign. properties: type: type: string description: "The type of message to be sent. It can be \"media\".\r\n" phone_no: type: string description: "The recipient's phone number, including the country code.\r\n" bot_name: type: string description: "The name of the bot sending the message.\r\n" card: type: object description: An object representing a standalone rich card. It includes a "title", "description", "url", and an array of "suggestions". This field is optional for "card" type messages. properties: title: type: string description: The label name for the card. description: type: string description: A short description of the card. url: type: string description: The (image/video mp4) url starting with https:// . thumbnail_url: type: string description: The (image/video mp4) url starting with https:// . suggestions: type: array description: "An array of suggestions shown as actions for the endpoint. Each suggestion can\ \ have a \"text\" field with plain text content. This field is optional.\r\n\r\n" items: type: object properties: type: type: string description: "The label name for the suggestion.\r\n\r\n" text: type: string description: "The plain text content of the suggestion.\r\n\r\n" postback: type: string description: "The postback text or action associated with the suggestion.\r\n\r\n" required: - type - phone_no - bot_name rcs_session_videothumbnailid_msg: type: object title: Session - Video With Thumbnail ID description: Messages that support sending media message with thumbnail id to enhance visual communication and short videos or animated content in MP4 format as part of a campaign. properties: type: type: string description: "The type of message to be sent. It can be \"media\".\r\n" phone_no: type: string description: "The recipient's phone number, including the country code.\r\n" bot_name: type: string description: "The name of the bot sending the message.\r\n" card: type: object description: An object representing a standalone rich card. It includes a "title", "description", "url", and an array of "suggestions". This field is optional for "card" type messages. properties: title: type: string description: The label name for the card. description: type: string description: A short description of the card. id: type: string description: "The id of the media (image or video MP4) to be included in the message.\r\n" thumbnail_id: type: string description: "The id of the media (image or video MP4) to be included in the message.\r\n" suggestions: type: array description: "An array of suggestions shown as actions for the endpoint. Each suggestion can\ \ have a \"text\" field with plain text content. This field is optional.\r\n\r\n" items: type: object properties: type: type: string description: "The label name for the suggestion.\r\n\r\n" text: type: string description: "The plain text content of the suggestion.\r\n\r\n" postback: type: string description: "The postback text or action associated with the suggestion.\r\n\r\n" required: - type - phone_no - bot_name rcs_session_richcrdstdalone_msg: type: object title: Session - Rich Card Standalone description: Messages that contain a standalone rich card with structured content, such as images, titles, descriptions, and buttons. These cards can provide interactive experiences and support various actions within a campaign. properties: type: type: string description: "The type of message to be sent. It can be \"card\".\r\n" phone_no: type: string description: "The recipient's phone number, including the country code.\r\n" bot_name: type: string description: "The name of the bot sending the message.\r\n" url: type: string description: "The URL of the media (image or video MP4) to be included in the message. This\ \ field is optional for \"media\" type messages.\r\n" extra: type: string description: "An extra value that can be included in the message. This field is optional.\r\n" card: type: object description: An object representing a standalone rich card. It includes a "title", "description", "url", and an array of "suggestions". This field is optional for "card" type messages. properties: title: type: string description: The label name for the card. description: type: string description: A short description of the card. url: type: string description: The (image/pdf/video mp4) url starting with https:// . suggestions: type: array description: An array of suggestions shown as actions for the endpoint. Each suggestion can have a "text" field with plain text content. This field is optional. items: type: object properties: type: type: string description: The label name for the suggestion. text: type: string description: The plain text content of the suggestion. latitude: type: string description: The latitude value associated with the suggestion. longitude: type: string description: The longitude value associated with the suggestion. postback: type: string description: The postback text or action associated with the suggestion. start: type: string description: "The latitude value associated with the suggestion.\r\n\r\n" end: type: string description: "The longitude value associated with the suggestion.\r\n\r\n" decription: type: string description: "The description associated with the suggestion.\r\n\r\n" fallback_text: type: string description: "The fallback text that is displayed on devices. The fallback text to be sent if\ \ the RCS message cannot be delivered. This field supports variable substitution using {#var#}\ \ format. It is optional.\r\n" required: - type - phone_no - bot_name rcs_session_richcrdcarousel_msg: type: object title: Session - Rich Card Carousel description: Messages that include a carousel of multiple rich cards. Each card within the carousel can have its own unique content and actions, allowing for a dynamic and engaging campaign experience. properties: type: type: string description: "The type of message to be sent. It can be \"multiple_cards\".\r\n" phone_no: type: string description: "The recipient's phone number, including the country code.\r\n" bot_name: type: string description: "The name of the bot sending the message.\r\n" extra: type: string description: "An extra value that can be included in the message. This field is optional.\r\n" cards: type: array description: An array of objects representing multiple rich cards. Each card object has a "title", "description", "url", and an array of "suggestions". This field is optional for "multiple_cards" type messages. items: type: object properties: card: type: object description: An object representing a standalone rich card. It includes a "title", "description", "url", and an array of "suggestions". This field is optional for "card" type messages. properties: title: type: string description: The label name for the card. description: type: string description: A short description of the card. url: type: string description: The (image/pdf/video mp4) url starting with https:// . suggestions: type: array description: An array of suggestions shown as actions for the endpoint. Each suggestion can have a "text" field with plain text content. This field is optional. items: type: object properties: type: type: string description: The label name for the suggestion. text: type: string description: The plain text content of the suggestion. postback: type: string description: The postback text or action associated with the suggestion. call_to: type: string description: The sender phone number. url: type: string description: The (image/pdf/video mp4) url starting with https:// . start: type: string description: "The latitude value associated with the suggestion.\r\n\r\n" end: type: string description: "The longitude value associated with the suggestion.\r\n\r\n" decription: type: string description: "The description associated with the suggestion.\r\n\r\n" fallback_text: type: string description: "The fallback text that is displayed on devices. The fallback text to be sent if\ \ the RCS message cannot be delivered. This field supports variable substitution using {#var#}\ \ format. It is optional.\r\n" required: - type - phone_no - bot_name rcs_session_urlsugg_msg: type: object title: Session - URL Suggestion description: Messages that provide suggestions for relevant URLs or links that users can easily access or interact with as part of a campaign. properties: type: type: string description: "The type of message to be sent. It can be \"media\".\r\n" phone_no: type: string description: "The recipient's phone number, including the country code.\r\n" bot_name: type: string description: "The name of the bot sending the message.\r\n" url: type: string description: "The URL of the media (image or video MP4) to be included in the message. This\ \ field is optional for \"media\" type messages.\r\n" extra: type: string description: "An extra value that can be included in the message. This field is optional.\r\n" suggestions: type: array description: An array of suggestions shown as actions for the endpoint. Each suggestion can have a "text" field with plain text content. This field is optional. items: type: object properties: type: type: string description: The label name for the suggestion. text: type: string description: The plain text content of the suggestion. url: type: string description: The (image/pdf/video mp4) url starting with https:// . postback: type: string description: The postback text or action associated with the suggestion. fallback_text: type: string description: "The fallback text that is displayed on devices. The fallback text to be sent if\ \ the RCS message cannot be delivered. This field supports variable substitution using {#var#}\ \ format. It is optional.\r\n" required: - type - phone_no - bot_name rcs_session_textsugg_msg: type: object title: Session - Text Suggestion description: Messages that offer a set of suggested responses or options for users to choose from, making it easier for them to respond or engage with the campaign. properties: type: type: string description: "The type of message to be sent. It can be \"text\".\r\n" phone_no: type: string description: "The recipient's phone number, including the country code.\r\n" bot_name: type: string description: "The name of the bot sending the message.\r\n" text: type: string description: "The plain text content of the message. This field is required for \"text\" type\ \ messages.\r\n" extra: type: string description: "An extra value that can be included in the message. This field is optional.\r\n" suggestions: type: array description: An array of suggestions shown as actions for the endpoint. Each suggestion can have a "text" field with plain text content. This field is optional. items: type: object properties: type: type: string description: The label name for the suggestion. text: type: string description: The plain text content of the suggestion. postback: type: string description: The postback text or action associated with the suggestion. fallback_text: type: string description: "The fallback text that is displayed on devices. The fallback text to be sent if\ \ the RCS message cannot be delivered. This field supports variable substitution using {#var#}\ \ format. It is optional.\r\n" required: - type - phone_no - bot_name - text rcs_session_dialsugg_msg: type: object title: Session - Dial Suggestion description: Messages that provide suggested phone numbers or prompts for users to initiate a phone call directly from the messaging app as part of a campaign. properties: type: type: string description: "The type of message to be sent. It can be \"media\".\r\n" phone_no: type: string description: "The recipient's phone number, including the country code.\r\n" bot_name: type: string description: "The name of the bot sending the message.\r\n" url: type: string description: "The URL of the media (image or video MP4) to be included in the message. This\ \ field is optional for \"media\" type messages.\r\n" extra: type: string description: "An extra value that can be included in the message. This field is optional.\r\n" suggestions: type: array description: An array of suggestions shown as actions for the endpoint. Each suggestion can have a "text" field with plain text content. This field is optional. items: type: object properties: type: type: string description: The label name for the suggestion. text: type: string description: The plain text content of the suggestion. call_to: type: string description: The sender's phone number. postback: type: string description: The postback text or action associated with the suggestion. fallback_text: type: string description: "The fallback text that is displayed on devices. The fallback text to be sent if\ \ the RCS message cannot be delivered. This field supports variable substitution using {#var#}\ \ format. It is optional.\r\n" required: - type - phone_no - bot_name rcs_session_locationsugg_msg: type: object title: Session - Location Suggestion description: Messages that suggest specific locations or addresses, allowing users to share or navigate to a particular place as part of a campaign. properties: type: type: string description: "The type of message to be sent. It can be \"text\".\r\n" phone_no: type: string description: "The recipient's phone number, including the country code.\r\n" bot_name: type: string description: "The name of the bot sending the message.\r\n" text: type: string description: "The plain text content of the message. This field is required for \"text\" type\ \ messages.\r\n" extra: type: string description: "An extra value that can be included in the message. This field is optional.\r\n" suggestions: type: array description: An array of suggestions shown as actions for the endpoint. Each suggestion can have a "text" field with plain text content. This field is optional. items: type: object properties: type: type: string description: The label name for the suggestion. text: type: string description: The plain text content of the suggestion. latitude: type: string description: The latitude value associated with the suggestion. longitude: type: string description: The longitude value associated with the suggestion. postback: type: string description: The postback text or action associated with the suggestion. fallback_text: type: string description: "The fallback text that is displayed on devices. The fallback text to be sent if\ \ the RCS message cannot be delivered. This field supports variable substitution using {#var#}\ \ format. It is optional.\r\n" required: - type - phone_no - bot_name - text rcs_session_calendarsugg_msg: type: object title: Session - Calendar Suggestion description: 'Messages that provide suggested calendar or prompts for users to initiate a phone call directly from the messaging app as part of a campaign. ' properties: type: type: string description: "The type of message to be sent.\r\n\r\n" example: Text. Media, Card, or Multiple Cards phone_no: type: string description: The recipient's phone number, including the country code. bot_name: type: string description: The name of the bot sending the message. text: type: string description: The plain text content of the message. This field is required for "text" type messages. suggestions: type: array description: "An array of suggestions shown as actions for the endpoint. Each suggestion can\ \ have a \"text\" field with plain text content. This field is optional.\r\n\r\n" items: type: object properties: type: type: string description: "The label name for the suggestion.\r\n\r\n" text: type: string description: "The plain text content of the suggestion.\r\n\r\n" title: type: string description: "The plain title of the suggestion.\r\n\r\n" url: type: string description: "The (image/pdf/video mp4) url starting with https:// .\r\n\r\n" start: type: string description: "The latitude value associated with the suggestion.\r\n\r\n" end: type: string description: "The longitude value associated with the suggestion.\r\n\r\n" decription: type: string description: "The description associated with the suggestion.\r\n\r\n" postback: type: string description: "The postback text or action associated with the suggestion.\r\n\r\n" rcs_session_mediaid_msg: type: object title: Session - Media ID description: Messages that support sending media id to enhance visual communication and short videos or animated content in MP4 format as part of a campaign. properties: type: type: string description: "The type of message to be sent. It can be \"media\".\r\n" phone_no: type: string description: "The recipient's phone number, including the country code.\r\n" bot_name: type: string description: "The name of the bot sending the message.\r\n" id: type: string description: "The id of the media (image or video MP4) to be included in the message.\r\n" thumbnail_id: type: string description: "The id of the media (image or video MP4) to be included in the message.\r\n" required: - type - phone_no - bot_name - id rcs_session_carslwithids_msg: type: object title: Session - Rich Card Carousel With IDs description: A message type that consists of multiple cards presented in a carousel format. Each card can have an image, title, description, and interactive components like buttons or links. It CAn also have ids with thumbnail ids in addition for video and images. It provides a visually engaging way to present multiple options or information to users. properties: type: type: string description: "The type of the message.\r\n" phone_no: type: string description: "The recipient's phone number, including the country code.\r\n" bot_name: type: string description: "The name of the bot sending the message.\r\n" cards: type: array description: "An array of objects representing multiple rich cards. Each card object has a \"\ title\", \"description\", \"url\", and an array of \"suggestions\". This field is optional\ \ for \"multiple_cards\" type messages.\r\n" items: type: object properties: card: type: object description: An object representing a standalone rich card. It includes a "title", "description", "url", and an array of "suggestions". This field is optional for "card" type messages. properties: title: type: string description: The label name for the card. description: type: string description: A short description of the card. url: type: string description: The (image/pdf/video mp4) url starting with https:// . id: type: string description: "The id of the media (image or video MP4) to be included in the message.\r\ \n" thumbnail_id: type: string description: "The id of the media (image or video MP4) to be included in the message.\r\ \n" required: - type - phone_no - bot_name rcs_template_text_msg: type: object title: India Template - Text Message description: RCS template APIs allow businesses to leverage the advanced features of RCS messaging and create compelling, interactive, and visually rich content to engage with their customers more dynamically and interactively. properties: type: type: string description: "The type of the template.\r\n\r\n- **Text:** RCS text templates provide a way\ \ to create engaging and interactive messaging experiences for businesses. \r\n- **Rich Card\ \ Standalone:** Rich Card Standalone utilizes the Rich Card format to provide visually rich\ \ and interactive content. \r\n- **Rich Card Carousel:** A Rich Card Carousel in RCS allows\ \ businesses to present multiple rich media cards in a single message, providing a visually\ \ engaging and interactive experience.\r\n" phone_no: type: string description: "The mobile number to which the message will be sent, including the country code.\r\ \n" bot_name: type: string description: "The name of the bot sending the message.\r\n" ttl: type: integer description: time to live. expire_time: type: string description: "The date and time at which the message should be expired and should be in the\ \ format YYYY-MM-DD HH:MM:SS.\r\n -Either ttl or expire time can be used in a single message" extra: type: string description: "An extra value that can be included in the message. This field is optional.\r\n" template: type: object description: "An object containing the template information.\r\n" properties: name: type: string description: "The name or identifier of the text template you want to use.\r\n" variables: type: object description: "An object containing the variables to be replaced in the template.\r\n" properties: '{var1}': type: string description: "The value to replace the \"{var1}\" variable in the template.\r\n" '{var2}': type: string description: "The value to replace the \"{var2}\" variable in the template.\r\n" required: - name fallback_text: type: string description: "The fallback text that is displayed on devices. The fallback text to be sent if\ \ the RCS message cannot be delivered. This field supports variable substitution using {#var#}\ \ format. It is optional.\r\n" required: - type - phone_no - bot_name - template rcs_template_richcrdstdalone_msg: type: object title: India Template - Rich Card Standalone Message description: RCS template APIs allow businesses to leverage the advanced features of RCS messaging and create compelling, interactive, and visually rich content to engage with their customers more dynamically and interactively. properties: type: type: string description: "The type of the template.\r\n\r\n- **Text:** RCS text templates provide a way\ \ to create engaging and interactive messaging experiences for businesses. \r\n- **Rich Card\ \ Standalone:** Rich Card Standalone utilizes the Rich Card format to provide visually rich\ \ and interactive content. \r\n- **Rich Card Carousel:** A Rich Card Carousel in RCS allows\ \ businesses to present multiple rich media cards in a single message, providing a visually\ \ engaging and interactive experience.\r\n" phone_no: type: string description: "The mobile number to which the message will be sent, including the country code.\r\ \n" bot_name: type: string description: "The name of the bot sending the message.\r\n" ttl: type: integer description: time to live. expire_time: type: string description: "The date and time at which the message should be expired and should be in the\ \ format YYYY-MM-DD HH:MM:SS.\r\n -Either ttl or expire time can be used in a single message" extra: type: string description: "An extra value that can be included in the message. This field is optional.\r\n" template: type: object description: "An object containing the template information.\r\n" properties: name: type: string description: "The name or identifier of the text template you want to use.\r\n" variables: type: object description: "An object containing the variables to be replaced in the template.\r\n" properties: '{var1}': type: string description: "The value to replace the \"{var1}\" variable in the template.\r\n" '{var2}': type: string description: "The value to replace the \"{var2}\" variable in the template.\r\n" required: - name fallback_text: type: string description: "The fallback text that is displayed on devices. The fallback text to be sent if\ \ the RCS message cannot be delivered. This field supports variable substitution using {#var#}\ \ format. It is optional.\r\n" required: - type - phone_no - bot_name - template rcs_template_richcrdcarousel_msg: type: object title: India Template - Rich Card Carousel Message description: RCS template APIs allow businesses to leverage the advanced features of RCS messaging and create compelling, interactive, and visually rich content to engage with their customers more dynamically and interactively. properties: type: type: string description: "The type of the template.\r\n\r\n- **Text:** RCS text templates provide a way\ \ to create engaging and interactive messaging experiences for businesses. \r\n- **Rich Card\ \ Standalone:** Rich Card Standalone utilizes the Rich Card format to provide visually rich\ \ and interactive content. \r\n- **Rich Card Carousel:** A Rich Card Carousel in RCS allows\ \ businesses to present multiple rich media cards in a single message, providing a visually\ \ engaging and interactive experience.\r\n" phone_no: type: string description: "The mobile number to which the message will be sent, including the country code.\r\ \n" bot_name: type: string description: "The name of the bot sending the message.\r\n" ttl: type: integer description: time to live. expire_time: type: string description: "The date and time at which the message should be expired and should be in the\ \ format YYYY-MM-DD HH:MM:SS.\r\n -Either ttl or expire time can be used in a single message" extra: type: string description: "An extra value that can be included in the message. This field is optional.\r\n" template: type: object description: "An object containing the template information.\r\n" properties: name: type: string description: "The name or identifier of the text template you want to use.\r\n" variables: type: object description: "An object containing the variables to be replaced in the template.\r\n" properties: '{var1}': type: string description: "The value to replace the \"{var1}\" variable in the template.\r\n" '{var2}': type: string description: "The value to replace the \"{var2}\" variable in the template.\r\n" required: - name fallback_text: type: string description: "The fallback text that is displayed on devices. The fallback text to be sent if\ \ the RCS message cannot be delivered. This field supports variable substitution using {#var#}\ \ format. It is optional.\r\n" required: - type - phone_no - bot_name - template rcs_template_fallback_api_msg: type: object title: India Template - Fallback API Message description: RCS template APIs allow businesses to leverage the advanced features of RCS messaging and create compelling, interactive, and visually rich content to engage with their customers more dynamically and interactively. properties: type: type: string description: "The type of the template.\r\n\r\n- **Text:** RCS text templates provide a way\ \ to create engaging and interactive messaging experiences for businesses. \r\n- **Rich Card\ \ Standalone:** Rich Card Standalone utilizes the Rich Card format to provide visually rich\ \ and interactive content. \r\n- **Rich Card Carousel:** A Rich Card Carousel in RCS allows\ \ businesses to present multiple rich media cards in a single message, providing a visually\ \ engaging and interactive experience.\r\n" phone_no: type: string description: "The mobile number to which the message will be sent, including the country code.\r\ \n" bot_name: type: string description: "The name of the bot sending the message.\r\n" ttl: type: integer description: time to live. expire_time: type: string description: "The date and time at which the message should be expired and should be in the\ \ format YYYY-MM-DD HH:MM:SS.\r\n -Either ttl or expire time can be used in a single message" extra: type: string description: "An extra value that can be included in the message. This field is optional.\r\n" template: type: object description: "An object containing the template information.\r\n" properties: name: type: string description: "The name or identifier of the text template you want to use.\r\n" variables: type: object description: "An object containing the variables to be replaced in the template.\r\n" properties: '{var1}': type: string description: "The value to replace the \"{var1}\" variable in the template.\r\n" '{var2}': type: string description: "The value to replace the \"{var2}\" variable in the template.\r\n" required: - name fallback_text: type: string description: "The fallback text that is displayed on devices. The fallback text to be sent if\ \ the RCS message cannot be delivered. This field supports variable substitution using {#var#}\ \ format. It is optional.\r\n" required: - type - phone_no - bot_name - template rcs_template_whatsapp_fallback_api_msg: type: object title: India Template - Whatsapp Fallback API Message description: RCS template APIs allow businesses to leverage the advanced features of RCS messaging and create compelling, interactive, and visually rich content to engage with their customers more dynamically and interactively. properties: type: type: string description: "The type of the template.\r\n\r\n- **Text:** RCS text templates provide a way\ \ to create engaging and interactive messaging experiences for businesses. \r\n- **Rich Card\ \ Standalone:** Rich Card Standalone utilizes the Rich Card format to provide visually rich\ \ and interactive content. \r\n- **Rich Card Carousel:** A Rich Card Carousel in RCS allows\ \ businesses to present multiple rich media cards in a single message, providing a visually\ \ engaging and interactive experience.\r\n" phone_no: type: string description: "The mobile number to which the message will be sent, including the country code.\r\ \n" bot_name: type: string description: "The name of the bot sending the message.\r\n" ttl: type: integer description: time to live. expire_time: type: string description: "The date and time at which the message should be expired and should be in the\ \ format YYYY-MM-DD HH:MM:SS.\r\n -Either ttl or expire time can be used in a single message" extra: type: string description: "An extra value that can be included in the message. This field is optional.\r\n" template: type: object description: "An object containing the template information.\r\n" properties: name: type: string description: "The name or identifier of the text template you want to use.\r\n" variables: type: object description: "An object containing the variables to be replaced in the template.\r\n" properties: '{var1}': type: string description: "The value to replace the \"{var1}\" variable in the template.\r\n" '{var2}': type: string description: "The value to replace the \"{var2}\" variable in the template.\r\n" required: - name fallback_text: type: string description: "The fallback text that is displayed on devices. The fallback text to be sent if\ \ the RCS message cannot be delivered. This field supports variable substitution using {#var#}\ \ format. It is optional.\r\n" whatsapp: type: object description: "An object containing the whatsapp template fallback information.\r\n" properties: media: type: object description: "An object containing the whatsapp template fallback media information.\r\n" properties: type: type: string description: "The type of the template.\r\n\r\n- **Text:** Example is Media Template\r\ \n" template_name: type: string description: "The name of the template for whatsapp fallback.\r\n" lang_code: type: string description: "The language code of the template to be sending fallback payload.\r\n" required: - type - phone_no - bot_name - template rcs_template_sms_fallback_api_msg: type: object title: India Template - SMS Fallback API Message description: RCS template APIs allow businesses to leverage the advanced features of RCS messaging and create compelling, interactive, and visually rich content to engage with their customers more dynamically and interactively. properties: type: type: string description: "The type of the template.\r\n\r\n- **Text:** RCS text templates provide a way\ \ to create engaging and interactive messaging experiences for businesses. \r\n- **Rich Card\ \ Standalone:** Rich Card Standalone utilizes the Rich Card format to provide visually rich\ \ and interactive content. \r\n- **Rich Card Carousel:** A Rich Card Carousel in RCS allows\ \ businesses to present multiple rich media cards in a single message, providing a visually\ \ engaging and interactive experience.\r\n" phone_no: type: string description: "The mobile number to which the message will be sent, including the country code.\r\ \n" bot_name: type: string description: "The name of the bot sending the message.\r\n" ttl: type: integer description: time to live. expire_time: type: string description: "The date and time at which the message should be expired and should be in the\ \ format YYYY-MM-DD HH:MM:SS.\r\n -Either ttl or expire time can be used in a single message" extra: type: string description: "An extra value that can be included in the message. This field is optional.\r\n" template: type: object description: "An object containing the template information.\r\n" properties: name: type: string description: "The name or identifier of the text template you want to use.\r\n" variables: type: object description: "An object containing the variables to be replaced in the template.\r\n" properties: '{var1}': type: string description: "The value to replace the \"{var1}\" variable in the template.\r\n" '{var2}': type: string description: "The value to replace the \"{var2}\" variable in the template.\r\n" required: - name fallback_text: type: string description: "The fallback text that is displayed on devices. The fallback text to be sent if\ \ the RCS message cannot be delivered. This field supports variable substitution using {#var#}\ \ format. It is optional.\r\n" sms: type: object description: "An object containing the sms template fallback information.\r\n" properties: fallback_text: type: string description: "The fallback text that is displayed on devices. The fallback text to be sent\ \ if the RCS message cannot be delivered. This field supports variable substitution using\ \ {#var#} format.\r\n" required: - type - phone_no - bot_name - template rcs_bulkcamp_text_msg: type: object title: Text description: A message type that is used to send simple text message to users. properties: type: type: string description: "The type of the message.\r\n" country_code: type: string description: "The country code to be used for the recipient phone numbers. The user can include\ \ the country code in the upload file or select it from the user interface. \r\n" file_url: type: string description: "The URL of the file containing the list of recipient phone numbers. The file should\ \ be in plain text format with each phone number on a new line.\r\n" campaign_name: type: string description: "The name of the campaign for identification purposes.\r\n" scheduled_time: type: string description: "The date and time at which the message should be scheduled to be sent in the format\ \ \"YYYY-MM-DD HH:MM:SS\".\r\n" ttl: type: integer description: time to live. expire_time: type: string description: "The date and time at which the message should be expired and should be in the\ \ format YYYY-MM-DD HH:MM:SS.\r\n -Either ttl or expire time can be used in a single message" bot_name: type: string description: "The name of the bot sending the message.\r\n" text: type: string description: "The main text content of the message to be sent via RCS.\r\n" suggestions: type: array description: An array of suggestions shown as actions for the endpoint. items: type: object properties: type: type: string description: The label name for the suggestion. text: type: string description: The plain text content of the suggestion. latitude: type: string description: The latitude value associated with the suggestion. longitude: type: string description: The longitude value associated with the suggestion. postback: type: string description: The postback text or action associated with the suggestion. fallback_text: type: string description: "The fallback text that is displayed on devices. The fallback text to be sent if\ \ the RCS message cannot be delivered. This field supports variable substitution using {#var#}\ \ format. It is optional.\r\n" required: - type - file_url - campaign_name - bot_name - text rcs_bulkcamp_media_msg: type: object title: Media description: Messages that support sending images to enhance visual communication and short videos or animated content in MP4 format as part of a bulk campaign. properties: type: type: string description: "The type of the message.\r\n" country_code: type: string description: "The country code to be used for the recipient phone numbers. The user can include\ \ the country code in the upload file or select it from the user interface. \r\n" file_url: type: string description: "The URL of the file containing the list of recipient phone numbers. The file should\ \ be in plain text format with each phone number on a new line.\r\n" campaign_name: type: string description: "The name of the campaign for identification purposes.\r\n" scheduled_time: type: string description: "The date and time at which the message should be scheduled to be sent in the format\ \ \"YYYY-MM-DD HH:MM:SS\".\r\n" bot_name: type: string description: "The name of the bot sending the message.\r\n" url: type: string description: The URL of the media file starting with https:// to be included in the message. suggestions: type: array description: An array of suggestions shown as actions for the endpoint. items: type: object properties: type: type: string description: The label name for the suggestion. text: type: string description: The plain text content of the suggestion. latitude: type: string description: The latitude value associated with the suggestion. longitude: type: string description: The longitude value associated with the suggestion. postback: type: string description: The postback text or action associated with the suggestion. fallback_text: type: string description: "The fallback text that is displayed on devices. The fallback text to be sent if\ \ the RCS message cannot be delivered. This field supports variable substitution using {#var#}\ \ format. It is optional.\r\n" required: - type - file_url - campaign_name - bot_name - url rcs_bulkcamp_richcrdstd_msg: type: object title: Rich Card Standalone description: A message type that supports a wide range of interactive components such as images, buttons, links, forms, and more. properties: type: type: string description: "The type of the message.\r\n" country_code: type: string description: "The country code to be used for the recipient phone numbers. The user can include\ \ the country code in the upload file or select it from the user interface. \r\n" file_url: type: string description: "The URL of the file containing the list of recipient phone numbers. The file should\ \ be in plain text format with each phone number on a new line.\r\n" campaign_name: type: string description: "The name of the campaign for identification purposes.\r\n" scheduled_time: type: string description: "The date and time at which the message should be scheduled to be sent in the format\ \ \"YYYY-MM-DD HH:MM:SS\".\r\n" bot_name: type: string description: "The name of the bot sending the message.\r\n" url: type: string description: The URL of the media file starting with https:// to be included in the message. card: type: object description: An object representing a standalone rich card. It includes a "title", "description", "url", and an array of "suggestions". This field is optional for "card" type messages. properties: title: type: string description: The label name for the card. description: type: string description: A short description of the card. url: type: string description: The (image/pdf/video mp4) url starting with https:// . suggestions: type: array description: An array of suggestions shown as actions for the endpoint. Each suggestion can have a "text" field with plain text content. This field is optional. items: type: object properties: type: type: string description: The label name for the suggestion. text: type: string description: The plain text content of the suggestion. latitude: type: string description: The latitude value associated with the suggestion. longitude: type: string description: The longitude value associated with the suggestion. postback: type: string description: The postback text or action associated with the suggestion. fallback_text: type: string description: "The fallback text that is displayed on devices. The fallback text to be sent if\ \ the RCS message cannot be delivered. This field supports variable substitution using {#var#}\ \ format. It is optional.\r\n" required: - type - file_url - campaign_name - bot_name - url rcs_bulkcamp_richcardcarsl_msg: type: object title: Rich Card Carousel description: A message type that consists of multiple cards presented in a carousel format. Each card can have an image, title, description, and interactive components like buttons or links. It provides a visually engaging way to present multiple options or information to users. properties: type: type: string description: "The type of the message.\r\n" country_code: type: string description: "The country code to be used for the recipient phone numbers. The user can include\ \ the country code in the upload file or select it from the user interface. \r\n" file_url: type: string description: "The URL of the file containing the list of recipient phone numbers. The file should\ \ be in plain text format with each phone number on a new line.\r\n" campaign_name: type: string description: "The name of the campaign for identification purposes.\r\n" scheduled_time: type: string description: "The date and time at which the message should be scheduled to be sent in the format\ \ \"YYYY-MM-DD HH:MM:SS\".\r\n" bot_name: type: string description: "The name of the bot sending the message.\r\n" cards: type: array description: "An array of objects representing multiple rich cards. Each card object has a \"\ title\", \"description\", \"url\", and an array of \"suggestions\". This field is optional\ \ for \"multiple_cards\" type messages.\r\n" items: type: object properties: card: type: object description: An object representing a standalone rich card. It includes a "title", "description", "url", and an array of "suggestions". This field is optional for "card" type messages. properties: title: type: string description: The label name for the card. description: type: string description: A short description of the card. url: type: string description: The (image/pdf/video mp4) url starting with https:// . suggestions: type: array description: An array of suggestions shown as actions for the endpoint. Each suggestion can have a "text" field with plain text content. This field is optional. items: type: object properties: type: type: string description: The label name for the suggestion. text: type: string description: The plain text content of the suggestion. postback: type: string description: The postback text or action associated with the suggestion. call_to: type: string description: The sender phone number. url: type: string description: The (image/pdf/video mp4) url starting with https:// . fallback_text: type: string description: "The fallback text that is displayed on devices. The fallback text to be sent if\ \ the RCS message cannot be delivered. This field supports variable substitution using {#var#}\ \ format. It is optional.\r\n" required: - type - file_url - campaign_name - bot_name rcs_bulkcamp_urlsugg_msg: type: object title: URL Suggestion description: A message type that includes a suggested URL or link for the user to click. It can be used to direct users to specific web pages, landing pages, or external content. properties: type: type: string description: "The type of the message.\r\n" country_code: type: string description: "The country code to be used for the recipient phone numbers. The user can include\ \ the country code in the upload file or select it from the user interface. \r\n" file_url: type: string description: "The URL of the file containing the list of recipient phone numbers. The file should\ \ be in plain text format with each phone number on a new line.\r\n" campaign_name: type: string description: "The name of the campaign for identification purposes.\r\n" scheduled_time: type: string description: "The date and time at which the message should be scheduled to be sent in the format\ \ \"YYYY-MM-DD HH:MM:SS\".\r\n" bot_name: type: string description: "The name of the bot sending the message.\r\n" url: type: string description: The URL of the media file starting with https:// to be included in the message. suggestions: type: array description: An array of suggestions shown as actions for the endpoint. Each suggestion can have a "text" field with plain text content. This field is optional. items: type: object properties: type: type: string description: The label name for the suggestion. text: type: string description: The plain text content of the suggestion. url: type: string description: The (image/pdf/video mp4) url starting with https:// . postback: type: string description: The postback text or action associated with the suggestion. fallback_text: type: string description: "The fallback text that is displayed on devices. The fallback text to be sent if\ \ the RCS message cannot be delivered. This field supports variable substitution using {#var#}\ \ format. It is optional.\r\n" required: - type - file_url - campaign_name - bot_name - url rcs_bulkcamp_textsugg_msg: type: object title: Text Suggestion description: A message type that includes a list of suggested text responses for the user to choose from. It simplifies user interactions by providing predefined options for quick replies or actions. properties: type: type: string description: "The type of the message.\r\n" country_code: type: string description: "The country code to be used for the recipient phone numbers. The user can include\ \ the country code in the upload file or select it from the user interface. \r\n" file_url: type: string description: "The URL of the file containing the list of recipient phone numbers. The file should\ \ be in plain text format with each phone number on a new line.\r\n" campaign_name: type: string description: "The name of the campaign for identification purposes.\r\n" scheduled_time: type: string description: "The date and time at which the message should be scheduled to be sent in the format\ \ \"YYYY-MM-DD HH:MM:SS\".\r\n" bot_name: type: string description: "The name of the bot sending the message.\r\n" text: type: string description: "The main text content of the message to be sent via RCS.\r\n" suggestions: type: array description: An array of suggestions shown as actions for the endpoint. items: type: object properties: type: type: string description: The label name for the suggestion. text: type: string description: The plain text content of the suggestion. postback: type: string description: The postback text or action associated with the suggestion. fallback_text: type: string description: "The fallback text that is displayed on devices. The fallback text to be sent if\ \ the RCS message cannot be delivered. This field supports variable substitution using {#var#}\ \ format. It is optional.\r\n" required: - type - file_url - campaign_name - bot_name - text rcs_bulkcamp_dialsugg_msg: type: object title: Dial Suggestion properties: type: type: string description: "The type of the message.\r\n" country_code: type: string description: "The country code to be used for the recipient phone numbers. The user can include\ \ the country code in the upload file or select it from the user interface. \r\n" file_url: type: string description: "The URL of the file containing the list of recipient phone numbers. The file should\ \ be in plain text format with each phone number on a new line.\r\n" campaign_name: type: string description: "The name of the campaign for identification purposes.\r\n" scheduled_time: type: string description: "The date and time at which the message should be scheduled to be sent in the format\ \ \"YYYY-MM-DD HH:MM:SS\".\r\n" bot_name: type: string description: "The name of the bot sending the message.\r\n" url: type: string description: The URL of the media file starting with https:// to be included in the message. suggestions: type: array description: An array of suggestions shown as actions for the endpoint. Each suggestion can have a "text" field with plain text content. This field is optional. items: type: object properties: type: type: string description: The label name for the suggestion. text: type: string description: The plain text content of the suggestion. call_to: type: string description: The sender's phone number. postback: type: string description: The postback text or action associated with the suggestion. fallback_text: type: string description: "The fallback text that is displayed on devices. The fallback text to be sent if\ \ the RCS message cannot be delivered. This field supports variable substitution using {#var#}\ \ format. It is optional.\r\n" required: - type - file_url - campaign_name - bot_name - url rcs_bulkcamp_locsugg_msg: type: object title: Location Suggestion properties: type: type: string description: "The type of the message.\r\n" country_code: type: string description: "The country code to be used for the recipient phone numbers. The user can include\ \ the country code in the upload file or select it from the user interface. \r\n" file_url: type: string description: "The URL of the file containing the list of recipient phone numbers. The file should\ \ be in plain text format with each phone number on a new line.\r\n" campaign_name: type: string description: "The name of the campaign for identification purposes.\r\n" scheduled_time: type: string description: "The date and time at which the message should be scheduled to be sent in the format\ \ \"YYYY-MM-DD HH:MM:SS\".\r\n" bot_name: type: string description: "The name of the bot sending the message.\r\n" text: type: string description: "The main text content of the message to be sent via RCS.\r\n" suggestions: type: array description: An array of suggestions shown as actions for the endpoint. items: type: object properties: type: type: string description: The label name for the suggestion. text: type: string description: The plain text content of the suggestion. latitude: type: string description: The latitude value associated with the suggestion. longitude: type: string description: The longitude value associated with the suggestion. postback: type: string description: The postback text or action associated with the suggestion. fallback_text: type: string description: "The fallback text that is displayed on devices. The fallback text to be sent if\ \ the RCS message cannot be delivered. This field supports variable substitution using {#var#}\ \ format. It is optional.\r\n" required: - type - file_url - campaign_name - bot_name - text rcs_bulkcamp_calendarsugg_msg: type: object title: Calendar Suggestion properties: type: type: string description: "The type of message to be sent.\r\n\r\n" example: Text. Media, Card, or Multiple Cards phone_no: type: string description: The recipient's phone number, including the country code. bot_name: type: string description: The name of the bot sending the message. text: type: string description: The plain text content of the message. This field is required for "text" type messages. suggestions: type: array description: "An array of suggestions shown as actions for the endpoint. Each suggestion can\ \ have a \"text\" field with plain text content. This field is optional.\r\n\r\n" items: type: object properties: type: type: string description: "The label name for the suggestion.\r\n\r\n" text: type: string description: "The plain text content of the suggestion.\r\n\r\n" title: type: string description: "The plain title of the suggestion.\r\n\r\n" url: type: string description: "The (image/pdf/video mp4) url starting with https:// .\r\n\r\n" start: type: string description: "The latitude value associated with the suggestion.\r\n\r\n" end: type: string description: "The longitude value associated with the suggestion.\r\n\r\n" decription: type: string description: "The description associated with the suggestion.\r\n\r\n" postback: type: string description: "The postback text or action associated with the suggestion.\r\n\r\n" rcs_payments_india_template: type: object title: India Template description: The API will use the provided phone number to send the payment template message to the recipient via RCS. The template will include the specified variables and their corresponding values, allowing you to customize the payment details for each recipient. properties: payment: type: object description: "The details of the payment.\r\n" properties: amount: type: object description: "The payment amount.\r\n" properties: value: type: string description: "The value of the payment amount.\r\n" currency: type: string description: "The currency of the payment amount.\r\n" required: - value - currency mode: type: string description: "The payment mode. \r\n" region: type: string description: "The region for the payment. For example: \"INDIA\"\r\n" merchant_name: type: string description: "The name of the merchant.\r\n" extra: type: object description: "Additional information or parameters related to the payment.\r\n" properties: some: type: string description: "A key-value pair representing additional information.\r\n" required: - amount - mode - region - merchant_name channels: type: array description: "An array specifying the channels through which the payment will be sent. \r\n" items: type: string rcs: type: object description: "The RCS-specific details for the payment.\r\n" properties: type: type: string description: "The message type as \"template\".\r\n" phone_no: type: string description: "The phone number of the recipient, including the country code.\r\n" bot_name: type: string description: "The name of the bot sending the message.\r\n" template: type: object description: "The details of the payment template.\r\n" properties: name: type: string description: "The name of the template.\r\n" variables: type: object description: "The variables used in the template and their corresponding values. In\ \ this example, \"{Name}\" and \"\" are placeholders for the actual values.\r\ \n" properties: '{var1}': type: string description: The variable used in the template and its corresponding value. '{var2}': type: string description: The variable used in the template and its corresponding value. required: - type - phone_no - bot_name - template required: - payment - channels rcs_payments_text_template: type: object title: Text description: The API will use the provided phone number to send the text template message to the recipient via RCS. properties: payment: type: object description: "The details of the payment.\r\n" properties: amount: type: object description: "The payment amount.\r\n" properties: value: type: string description: "The value of the payment amount.\r\n" currency: type: string description: "The currency of the payment amount.\r\n" required: - value - currency mode: type: string description: "The payment mode.\r\n" region: type: string description: "The region for the payment. (Example: \"INDIA\")\r\n" merchant_name: type: string description: "The name of the merchant.\r\n" extra: type: object description: "Additional information or parameters related to the payment.\r\n" properties: some: type: string description: "A key-value pair representing additional information.\r\n" required: - amount - mode - region - merchant_name channels: type: array description: "An array specifying the channels through which the payment will be sent. \r\n" items: type: string rcs: type: object description: "The RCS-specific details for the payment.\r\n" properties: type: type: string description: "The message type as \"template\".\r\n" phone_no: type: string description: "The recipient's phone number, including the country code.\r\n" bot_name: type: string description: "The name of the bot sending the message.\r\n" text: type: string description: "The main text content of the message to be sent via RCS.\r\n" suggestions: type: array description: An array of suggestions shown as actions for the endpoint. Each suggestion can have a "text" field with plain text content. This field is optional. items: type: object properties: type: type: string description: The label name for the suggestion. text: type: string description: The plain text content of the suggestion. url: type: string description: The (image/video mp4) url starting with https://. postback: type: string description: The postback text or action associated with the suggestion. fallback_text: type: string description: "The fallback text that is displayed on devices. The fallback text to be sent\ \ if the RCS message cannot be delivered. This field supports variable substitution using\ \ {#var#} format. It is optional.\r\n" required: - type - phone_no - bot_name - text required: - payment rcs_payments_media_template: type: object title: Media description: The API will use the provided phone number to send the media message to the recipient via RCS. properties: payment: type: object description: "The details of the payment.\r\n" properties: amount: type: object description: "The payment amount.\r\n" properties: value: type: string description: "The value of the payment amount.\r\n" currency: type: string description: "The currency of the payment amount.\r\n" required: - value - currency mode: type: string description: "The payment mode. For example: \"ALL\"\r\n" region: type: string description: "The region for the payment. For example: \"INDIA\"\r\n" merchant_name: type: string description: "The name of the merchant.\r\n" extra: type: object description: "Additional information or parameters related to the payment.\r\n" properties: some: type: string description: "A key-value pair representing additional information.\r\n" required: - amount - mode - region - merchant_name channels: type: array description: "An array specifying the channels through which the payment will be sent. \r\n" items: type: string rcs: type: object description: "The RCS-specific details for the payment.\r\n" properties: type: type: string description: "The message type as \"template\".\r\n" phone_no: type: string description: "The recipient's phone number, including the country code.\r\n" bot_name: type: string description: "The name of the bot sending the message.\r\n" url: type: string description: "The (image/video mp4) url starting with https:// .\r\n" suggestions: type: array description: An array of suggestions shown as actions for the endpoint. Each suggestion can have a "text" field with plain text content. This field is optional. items: type: object properties: type: type: string description: The label name for the suggestion. text: type: string description: The plain text content of the suggestion. url: type: string description: The (image/video mp4) url starting with https://. postback: type: string description: The postback text or action associated with the suggestion. fallback_text: type: string description: "The fallback text that is displayed on devices. The fallback text to be sent\ \ if the RCS message cannot be delivered. This field supports variable substitution using\ \ {#var#} format. It is optional.\r\n" required: - type - phone_no - bot_name - url required: - payment rcs_payments_richcrdstdle_template: type: object title: Rich Card Standalone description: The API will use the provided phone number to send the rich card standalone message to the recipient via RCS. properties: payment: type: object description: "The details of the payment.\r\n" properties: amount: type: object description: "The payment amount.\r\n" properties: value: type: string description: "The value of the payment amount.\r\n" currency: type: string description: "The currency of the payment amount.\r\n" required: - value - currency mode: type: string description: "The payment mode. \r\n" region: type: string description: "The region for the payment. \r\n" merchant_name: type: string description: "The name of the merchant.\r\n" extra: type: object description: "Additional information or parameters related to the payment.\r\n" properties: some: type: string description: "A key-value pair representing additional information.\r\n" required: - amount - mode - region - merchant_name channels: type: array description: "An array specifying the channels through which the payment will be sent. \r\n" items: type: string rcs: type: object description: "The RCS-specific details for the payment.\r\n" properties: type: type: string description: "The message type as \"template\".\r\n" phone_no: type: string description: "The recipient's phone number, including the country code.\r\n" bot_name: type: string description: "The name of the bot sending the message.\r\n" url: type: string description: The (image/video mp4) url starting with https:// . card: type: object description: An object representing a standalone rich card. It includes a "title", "description", "url", and an array of "suggestions". This field is optional for "card" type messages. properties: title: type: string description: The label name for the card. description: type: string description: A short description of the card. url: type: string description: The (image/video mp4) url starting with https:// . suggestions: type: array description: An array of suggestions shown as actions for the endpoint. Each suggestion can have a "text" field with plain text content. This field is optional. items: type: object properties: type: type: string description: The label name for the suggestion. text: type: string description: The plain text content of the suggestion. url: type: string description: The (image/video mp4) url starting with https:// . postback: type: string description: The postback text or action associated with the suggestion. fallback_text: type: string description: "The fallback text that is displayed on devices. The fallback text to be sent\ \ if the RCS message cannot be delivered. This field supports variable substitution using\ \ {#var#} format. It is optional.\r\n" required: - type - phone_no - bot_name - url required: - payment rcs_payments_richcrdcarousel_template: type: object title: Rich Card Carousel description: The API will use the provided phone number to send the rich card carousel message to the recipient via RCS. properties: payment: type: object description: "The details of the payment.\r\n" properties: amount: type: object description: "The payment amount.\r\n" properties: value: type: string description: "The value of the payment amount.\r\n" currency: type: string description: "The currency of the payment amount.\r\n" required: - value - currency mode: type: string description: "The payment mode.\r\n" region: type: string description: "The region for the payment. \r\n" merchant_name: type: string description: "The name of the merchant.\r\n" extra: type: object description: "Additional information or parameters related to the payment.\r\n" properties: some: type: string description: "A key-value pair representing additional information.\r\n" required: - amount - mode - region - merchant_name channels: type: array description: "An array specifying the channels through which the payment will be sent. \r\n" items: type: string rcs: type: object description: "The RCS-specific details for the payment.\r\n" properties: type: type: string description: "The message type as \"template\".\r\n" phone_no: type: string description: "The recipient's phone number, including the country code.\r\n" bot_name: type: string description: "The name of the bot sending the message.\r\n" cards: type: array description: "An array of objects representing multiple rich cards. Each card object has\ \ a \"title\", \"description\", \"url\", and an array of \"suggestions\". This field is\ \ optional for \"multiple_cards\" type messages.\r\n" items: type: object properties: card: type: object description: An object representing a standalone rich card. It includes a "title", "description", "url", and an array of "suggestions". This field is optional for "card" type messages. properties: title: type: string description: The label name for the card. description: type: string description: A short description of the card. url: type: string description: The (image/video mp4) url starting with https:// . suggestions: type: array description: An array of suggestions shown as actions for the endpoint. Each suggestion can have a "text" field with plain text content. This field is optional. items: type: object properties: type: type: string description: The label name for the suggestion. text: type: string description: The plain text content of the suggestion. url: type: string description: The (image/video mp4) url starting with https:// . postback: type: string description: The postback text or action associated with the suggestion. call_to: type: string description: The sender phone number. fallback_text: type: string description: "The fallback text that is displayed on devices. The fallback text to be sent\ \ if the RCS message cannot be delivered. This field supports variable substitution using\ \ {#var#} format. It is optional.\r\n" required: - type - phone_no - bot_name required: - payment rcs_payments_urlsugg_template: type: object title: URL Suggestion description: The API will use the provided phone number to send the URL suggestion message to the recipient via RCS. properties: payment: type: object description: "The details of the payment.\r\n" properties: amount: type: object description: "The payment amount.\r\n" properties: value: type: string description: "The value of the payment amount.\r\n" currency: type: string description: "The currency of the payment amount.\r\n" required: - value - currency mode: type: string description: "The payment mode. \r\n" region: type: string description: The region for the payment. merchant_name: type: string description: "The name of the merchant.\r\n" extra: type: object description: "Additional information or parameters related to the payment.\r\n" properties: some: type: string description: "A key-value pair representing additional information.\r\n" required: - amount - mode - region - merchant_name channels: type: array description: "An array specifying the channels through which the payment will be sent. \r\n" items: type: string rcs: type: object description: "The RCS-specific details for the payment.\r\n" properties: type: type: string description: "The message type as \"template\".\r\n" phone_no: type: string description: "The recipient's phone number, including the country code.\r\n" bot_name: type: string description: "The name of the bot sending the message.\r\n" url: type: string description: "The (image/video mp4) url starting with https:// .\r\n" suggestions: type: array description: "An array of suggestions shown as actions for the endpoint. Each suggestion\ \ can have a \"text\" field with plain text content. This field is optional.\r\n" items: type: object properties: type: type: string description: The label name for the suggestion. text: type: string description: The plain text content of the suggestion. url: type: string description: The (image/video mp4) url starting with https://. postback: type: string description: The postback text or action associated with the suggestion. fallback_text: type: string description: "The fallback text that is displayed on devices. The fallback text to be sent\ \ if the RCS message cannot be delivered. This field supports variable substitution using\ \ {#var#} format. It is optional.\r\n" required: - type - phone_no - bot_name - url required: - payment rcs_callback_incoming_text: type: object title: Incoming Text properties: bot_name: type: string description: "The name of the bot.\r\n" event_type: type: string description: "The type of event or message. \r\n" request_id: type: string description: "The unique identifier for the original request or message.\r\n" session_id: type: string description: "The session identifier for the conversation or interaction. It helps to associate\ \ multiple messages from the same user or session.\r\n" text_message: type: string description: "The text content of the message sent by the user.\r\n" timestamp: type: string description: "The timestamp of when the message was received or sent.\r\n" user_contact: type: string description: "The contact information of the user.\r\n" username: type: string description: "The name of the user.\r\n" required: - bot_name - event_type - request_id - session_id - text_message - timestamp - user_contact - username rcs_callback_incoming_image: type: object title: Incoming Image properties: bot_name: type: string description: "The name of the bot.\r\n" event_type: type: string description: "The type of event or message. \r\n" media_name: type: string description: "The name of the media file.\r\n" media_size: type: string description: "The size of the media file in bytes.\r\n" media_type: type: string description: "The type of media. For an image, it is set to \"image\".\r\n" media_uri: type: string description: "The URI or URL where the media file is hosted or stored.\r\n" request_id: type: string description: "The unique identifier for the original request or message.\r\n" session_id: type: string description: "The session identifier for the conversation or interaction. It helps to associate\ \ multiple messages from the same user or session.\r\n" timestamp: type: string description: "The timestamp of when the message was received or sent.\r\n" user_contact: type: string description: "The contact information of the user.\r\n" username: type: string description: "The name of the user.\r\n" required: - bot_name - event_type - media_name - media_size - media_type - media_uri - request_id - session_id - timestamp - user_contact - username rcs_callback_incoming_location: type: object title: Incoming Location properties: request_id: type: string description: "The unique identifier for the original request or message.\r\n" user_contact: type: string description: "The contact information of the user.\r\n" timestamp: type: string description: "The timestamp of when the message was received or sent.\r\n" bot_name: type: string description: "The name of the bot.\r\n" username: type: string description: "The name of the user.\r\n" session_id: type: string description: "The session identifier for the conversation or interaction. It helps to associate\ \ multiple messages from the same user or session.\r\n" event_type: type: string description: "The type of event or message. \r\n" latitude: type: number description: "A decimal number representing the latitude coordinate of the location shared by\ \ the user. \r\n" longitude: type: number description: "A decimal number representing the longitude coordinate of the location shared\ \ by the user.\r\n" required: - request_id - user_contact - timestamp - bot_name - username - session_id - event_type - latitude - longitude rcs_callback_incoming_suggaction: type: object title: Incoming Suggestion Action (URL/Dial) properties: bot_name: type: string description: "The name of the bot.\r\n" event_type: type: string description: "The type of event or message. \r\n" request_id: type: string description: "The unique identifier for the original request or message.\r\n" response_postback: type: string description: "The postback value associated with the suggestion action.\r\n" response_text: type: string description: "The text associated with the suggestion action.\r\n" session_id: type: string description: "The session identifier for the conversation or interaction. It helps to associate\ \ multiple messages from the same user or session.\r\n" suggestion_type: type: string description: "The type of suggestion used by the user.\r\n" timestamp: type: string description: "The timestamp of when the message was received or sent.\r\n" user_contact: type: string description: "The contact information of the user.\r\n" username: type: string description: "The name of the user.\r\n" required: - bot_name - event_type - request_id - response_postback - response_text - session_id - suggestion_type - timestamp - user_contact - username rcs_callback_incoming_suggestion_reply: type: object title: Incoming Suggestion Reply properties: bot_name: type: string description: "The name of the bot.\r\n" event_type: type: string description: "The type of event or message. For a suggestion reply, it is set to \"response\"\ .\r\n" request_id: type: string description: "The unique identifier for the original request or message.\r\n" response_postback: type: string description: "The postback value associated with the suggestion reply.\r\n" response_text: type: string description: "The text response provided by the user for the suggestion.\r\n" session_id: type: string description: "The session identifier for the conversation or interaction. It helps to associate\ \ multiple messages from the same user or session.\r\n" suggestion_type: type: string description: "The type of suggestion used by the user. \r\n" timestamp: type: string description: "The timestamp of when the message was received or sent.\r\n" user_contact: type: string description: "The contact information of the user.\r\n" username: type: string description: "The name of the user.\r\n" required: - bot_name - event_type - request_id - response_postback - response_text - session_id - suggestion_type - timestamp - user_contact - username rcs_callback_incoming_video: type: object title: Incoming Video properties: bot_name: type: string description: "The name of the bot.\r\n" event_type: type: string description: "The type of event or message. \r\n" media_name: type: string description: "The name of the media file.\r\n" media_size: type: string description: "The size of the media file in bytes. \r\n" media_type: type: string description: "The type of media. For a video, it is set to \"video\".\r\n" media_uri: type: string description: "The URI or URL where the media file is hosted or stored. \r\n" request_id: type: string description: "The unique identifier for the original request or message.\r\n" session_id: type: string description: "The session identifier for the conversation or interaction. It helps to associate\ \ multiple messages from the same user or session.\r\n" timestamp: type: string description: "The timestamp of when the message was received or sent.\r\n" user_contact: type: string description: "The contact information of the user.\r\n" username: type: string description: "The name of the user.\r\n" required: - bot_name - event_type - media_name - media_size - media_type - media_uri - request_id - session_id - timestamp - user_contact - username rcs_callback_incoming_document: type: object title: Incoming Document properties: bot_name: type: string description: "The name of the bot.\r\n" event_type: type: string description: "The type of event or message. \r\n" media_name: type: string description: "The name of the media file.\r\n" media_size: type: string description: "The size of the media file in bytes. \r\n" media_type: type: string description: "The type of media. For a document, it is set to \"document\".\r\n" media_uri: type: string description: "The URI or URL where the media file is hosted or stored. \r\n" request_id: type: string description: "The unique identifier for the original request or message.\r\n" session_id: type: string description: "The session identifier for the conversation or interaction. It helps to associate\ \ multiple messages from the same user or session.\r\n" timestamp: type: string description: "The timestamp of when the message was received or sent.\r\n" user_contact: type: string description: "The contact information of the user.\r\n" username: type: string description: "The name of the user.\r\n" required: - bot_name - event_type - media_name - media_size - media_type - media_uri - request_id - session_id - timestamp - user_contact - username rcs_callback_status_read_delivered: type: object title: Status (Read/Delivered) properties: bot_name: type: string description: "The name of the bot.\r\n" event_type: type: string description: "The type of event or message. \r\n" message_id: type: string description: "The unique identifier for the message that is being reported for its status. \r\ \n" message_status: type: string description: "The status of the message.\r\n" timestamp: type: string description: "The timestamp of when the message was received or sent.\r\n" user_contact: type: string description: "The contact information of the user.\r\n" extra: type: string description: "Additional information or parameters related to the payment.\r\n" username: type: string description: "The name of the user.\r\n" campaign_name: type: string description: "The name of the campaign. \r\n" campaign_id: type: string description: "The id for the campaign sent. \r\n" required: - bot_name - event_type - message_id - message_status - timestamp - user_contact - extra - username - campaign_name - campaign_id rcs_callback_status_failed: type: object title: Status Failed properties: bot_name: type: string description: "The name of the bot.\r\n" event_type: type: string description: "The type of event or message. \r\n" message_id: type: string description: "The unique identifier for the message that is being reported for its status. \r\ \n" message_status: type: string description: "The status of the message.\r\n" failure_reason: type: string description: "The reason for the failure.\r\n" timestamp: type: string description: "The timestamp of when the message was received or sent.\r\n" user_contact: type: string description: "The contact information of the user.\r\n" extra: type: string description: "Additional information or parameters related to the payment.\r\n" username: type: string description: "The name of the user.\r\n" campaign_name: type: string description: "The name of the campaign. \r\n" campaign_id: type: string description: "The id for the campaign sent. \r\n" required: - bot_name - event_type - message_id - message_status - failure_reason - timestamp - user_contact - extra - username - campaign_name - campaign_id rcs_callback_fallback_whatsapp: type: object title: Fallback To Whatsapp properties: bot_name: type: string description: "The name of the bot.\r\n" event_type: type: string description: "The type of event or message. \r\n" message_id: type: string description: "The unique identifier for the message that is being reported for its status. \r\ \n" message_status: type: string description: "The status of the message.\r\n" timestamp: type: string description: "The timestamp of when the message was received or sent.\r\n" user_contact: type: string description: "The contact information of the user.\r\n" extra: type: string description: "Additional information or parameters related to the payment.\r\n" username: type: string description: "The name of the user.\r\n" required: - bot_name - event_type - message_id - message_status - failure_reason - timestamp - user_contact - extra - username rcs_upload_file_text_msg: type: object title: File Upload API properties: bot_name: type: string description: "The RCS agent (bot) name associated with your account.\r\n" example: '{RML agent name}' file: type: string format: binary description: "The binary media file to upload. Supported formats: image (JPEG, PNG), video (MP4),\ \ PDF.\r\n" required: - bot_name - file rcs_management_add_tester: type: object title: Management Add Tester API properties: bot_name: type: string description: "The name of the bot.\r\n" phone_number: type: string description: "The phone number of the bot. \r\n" required: - bot_name - file rcs_create_optin: type: object title: Create Optin API properties: bot_name: type: string description: "The name of the bot.\r\n" mobile_number: type: string description: "The mobile number of the bot. \r\n" channel: type: string description: "The channel of the bot. \r\n" required: - bot_name - mobile_number - channel rcs_create_template_text: type: object title: Create Template - Text description: The API is used to create a template which uses text which can be used to be sent in message to the recipient via RCS. properties: name: type: string description: "The name of the template.\r\n" type: type: string description: "The type of template to be created.\r\n" textMessageContent: type: string description: "The content of text message template.\r\n" suggestions: type: array description: "Suggestions for text template.\r\n" items: type: string templateDetails: type: object description: "The object defines the template details of text template.\r\n" properties: user_name: type: string description: "The username of the account using text template.\r\n" bot_name: type: string description: "The bot name for the text template.\r\n" variables: type: array description: "The variables for text template \r\n" items: type: string category: type: string description: "Category for the text template which is text for this case.\r\n" system_ip: type: string description: "The system ip for bot for text template.\r\n" payload: type: object description: "Object containing payload for text template.\r\n" required: - name - type - textMessageContent - suggestions - templateDetails rcs_create_template_text_with_pdf: type: object title: Create Template - Text with pdf description: The API is used to create a template which uses text with pdf which can be used to be sent in message to the recipient via RCS. properties: name: type: string description: "The name of the template.\r\n" type: type: string description: "The type of template to be created.\r\n" textMessageContent: type: string description: "The content of text message template.\r\n" suggestions: type: array description: "Suggestions for text template.\r\n" items: type: string templateDetails: type: object description: "The object defines the template details of text template.\r\n" properties: user_name: type: string description: "The username of the account using text template.\r\n" bot_name: type: string description: "The bot name for the text template.\r\n" variables: type: array description: "The variables for text template \r\n" items: type: string category: type: string description: "Category for the text template which is text for this case.\r\n" system_ip: type: string description: "The system ip for bot for text template.\r\n" payload: type: object description: "Object containing payload for text template.\r\n" required: - name - type - textMessageContent - suggestions - templateDetails - document filename - message order rcs_create_template_richcard: type: object title: Create Template - Rich Card Standalone description: The API is used to create a template which uses rich card Standalone which can be used to be sent in message to the recipient via RCS. properties: name: type: string description: "The name of the template.\r\n" type: type: string description: "The type of template to be created.\r\n" orientation: type: string description: "The orientation of the rich card template.\r\n" height: type: string description: "The height of the rich card template. Example : SHORT_HEIGHT \r\n" standAlone: type: object description: "The object defines the template details of rich card template.\r\n" properties: cardTitle: type: string description: "The title of the rich card in template.\r\n" cardDescription: type: string description: "The description of the rich card in the template.\r\n" fileName: type: array description: "The file Name for rich card images in template \r\n" items: type: string thumbnailFileName: type: string description: "The thumbnail image file Name for rich card in template .\r\n" suggestions: type: array description: "Suggestions for rich card template.\r\n" items: type: object templateDetails: type: object description: "The object defines the template details of rich card template.\r\n" properties: user_name: type: string description: "The username of the account using rich card template.\r\n" bot_name: type: string description: "The bot name for the ruch card template.\r\n" variables: type: array description: "The variables for rich card template \r\n" items: type: string category: type: string description: "Category for the rich card template which is rich_card for this case.\r\n" system_ip: type: string description: "The system ip for bot for rich card template.\r\n" payload: type: object description: "Object containing payload for rich card template.\r\n" required: - name - type - orientation - height - standAlone - templateDetails rcs_create_template_carousel: type: object title: Create Template - Carousel description: The API is used to create a template which uses carouselList which can be used to be sent in message to the recipient via RCS. properties: name: type: string description: "The name of the template.\r\n" type: type: string description: "The type of template to be created.\r\n" height: type: string description: "The height of the carousel template. Example : SHORT_HEIGHT \r\n" width: type: string description: "The width of the carousel template.Example: MEDIUM_WIDTH\r\n" carouselList: type: object description: "The object defines the template details of carousel template.\r\n" properties: cardTitle: type: string description: "The title of the card in carouselList in template.\r\n" cardDescription: type: string description: "The description of the card in carouselList in the template.\r\n" fileName: type: array description: "The file Name for card in carouselList images in template \r\n" items: type: string thumbnailFileName: type: string description: "The thumbnail image file Name for rich card in template .\r\n" suggestions: type: array description: "Suggestions for carousel template.\r\n" items: type: object suggestionType: type: string description: "The Suggestion type of the card in carouselList in the template.\r\n" url: type: string description: "The url for suggestion for card in carouselList in template .\r\n" displayText: type: array description: "The display text Name for card in carouselList images in template \r\n" items: type: string postback: type: string description: "The postback string value for carouselList in template .\r\n" templateDetails: type: object description: "The object defines the template details of carousel template.\r\n" properties: user_name: type: string description: "The username of the bot using carousel template.\r\n" bot_name: type: string description: "The bot name for the carousel template.\r\n" variables: type: array description: "The variables for carousel template \r\n" items: type: string category: type: string description: "Category for the carousel template which is carousel for this case.\r\n" system_ip: type: string description: "The system ip for bot for carousel template.\r\n" payload: type: object description: "Object containing payload for carousel template.\r\n" required: - name - type - height - width - carouselList - templateDetails rcs_update_template_text: type: object title: Update Template - Text description: The API is used to update a template which uses text which can be used to be sent in message to the recipient via RCS. properties: name: type: string description: "The name of the template.\r\n" type: type: string description: "The type of template to be created.\r\n" textMessageContent: type: string description: "The content of text message template.\r\n" suggestions: type: array description: "Suggestions for text template.\r\n" items: type: string templateDetails: type: object description: "The object defines the template details of text template.\r\n" properties: user_name: type: string description: "The username of the account using text template.\r\n" bot_name: type: string description: "The bot name for the text template.\r\n" variables: type: array description: "The variables for text template \r\n" items: type: string category: type: string description: "Category for the text template which is text for this case.\r\n" system_ip: type: string description: "The system ip for bot for text template.\r\n" payload: type: object description: "Object containing payload for text template.\r\n" required: - name - type - textMessageContent - suggestions - templateDetails rcs_update_template_text_with_pdf: type: object title: Update Template - Text with pdf description: The API is used to create a template which uses text with pdf which can be used to be sent in message to the recipient via RCS. properties: name: type: string description: "The name of the template.\r\n" type: type: string description: "The type of template to be created.\r\n" textMessageContent: type: string description: "The content of text message template.\r\n" suggestions: type: array description: "Suggestions for text template.\r\n" items: type: string templateDetails: type: object description: "The object defines the template details of text template.\r\n" properties: user_name: type: string description: "The username of the account using text template.\r\n" bot_name: type: string description: "The bot name for the text template.\r\n" variables: type: array description: "The variables for text template \r\n" items: type: string category: type: string description: "Category for the text template which is text for this case.\r\n" system_ip: type: string description: "The system ip for bot for text template.\r\n" payload: type: object description: "Object containing payload for text template.\r\n" required: - name - type - textMessageContent - suggestions - templateDetails - document filename - message order rcs_update_template_richcard: type: object title: Update Template - Rich Card Standalone description: The API is used to update a template which uses rich card Standalone which can be used to be sent in message to the recipient via RCS. properties: name: type: string description: "The name of the template.\r\n" type: type: string description: "The type of template to be created.\r\n" orientation: type: string description: "The orientation of the rich card template.\r\n" height: type: string description: "The height of the rich card template. Example : SHORT_HEIGHT \r\n" standAlone: type: object description: "The object defines the template details of rich card template.\r\n" properties: cardTitle: type: string description: "The title of the rich card in template.\r\n" cardDescription: type: string description: "The description of the rich card in the template.\r\n" fileName: type: array description: "The file Name for rich card images in template \r\n" items: type: string thumbnailFileName: type: string description: "The thumbnail image file Name for rich card in template .\r\n" templateDetails: type: object description: "The object defines the template details of rich card template.\r\n" properties: user_name: type: string description: "The username of the account using rich card template.\r\n" bot_name: type: string description: "The bot name for the ruch card template.\r\n" variables: type: array description: "The variables for rich card template \r\n" items: type: string category: type: string description: "Category for the rich card template which is rich_card for this case.\r\n" system_ip: type: string description: "The system ip for bot for rich card template.\r\n" payload: type: object description: "Object containing payload for rich card template.\r\n" required: - name - type - orientation - height - standAlone - templateDetails rcs_update_template_carousel: type: object title: Update Template - Carousel description: The API is used to update a template which uses carouselList which can be used to be sent in message to the recipient via RCS. properties: name: type: string description: "The name of the template.\r\n" type: type: string description: "The type of template to be created.\r\n" height: type: string description: "The height of the carousel template. Example : SHORT_HEIGHT \r\n" width: type: string description: "The width of the carousel template.Example: MEDIUM_WIDTH\r\n" carouselList: type: object description: "The object defines the template details of carousel template.\r\n" properties: cardTitle: type: string description: "The title of the card in carouselList in template.\r\n" cardDescription: type: string description: "The description of the card in carouselList in the template.\r\n" fileName: type: array description: "The file Name for card in carouselList images in template \r\n" items: type: string templateDetails: type: object description: "The object defines the template details of carousel template.\r\n" properties: user_name: type: string description: "The username of the bot using carousel template.\r\n" bot_name: type: string description: "The bot name for the carousel template.\r\n" variables: type: array description: "The variables for carousel template \r\n" items: type: string category: type: string description: "Category for the carousel template which is carousel for this case.\r\n" system_ip: type: string description: "The system ip for bot for carousel template.\r\n" payload: type: object description: "Object containing payload for carousel template.\r\n" required: - name - type - height - width - carouselList - templateDetails rcs_bulk_dnd_set_body: type: object title: Bulk DND Set (Whitelist / Blacklist) properties: bot_name: type: string description: "The RCS agent (bot) name for which the DND operation applies.\r\n" example: '{RML agent name}' file_url: type: string description: The URL of the uploaded CSV file containing the list of phone numbers to whitelist or blacklist. Obtain this URL from the File Upload API response. example: https://apis.rmlconnect.net/v1/download/Misc/{file-id}.csv dnd_mode: type: boolean description: Set to `true` to blacklist the numbers in the file (block them from receiving messages). Set to `false` to whitelist the numbers (allow them to receive messages). example: false required: - bot_name - file_url - dnd_mode