Route Mobile RCS Template API

openapi: 3.2.0
info:
  version: 2.1.0
  title: Route Mobile Rich Communication Services (RCS) API Documentation RCS Template API
  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: []
tags:
- name: RCS Template API
paths:
  /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.


                      '
                    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.


                      '
              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.


                      '
                    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.


                      '
              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.


                      '
                    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.


                      '
              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.


                      '
                    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.


                      '
              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.


                      '
                    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.


                      '
              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:
           

# --- truncated at 32 KB (54 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/route-mobile/refs/heads/main/openapi/route-mobile-rcs-template-api-api-openapi.yml