Telesign Templates Callbacks API

openapi: 3.2.0
info:
  title: Telesign Templates Callbacks API
  version: '1.0'
  contact:
    name: Telesign Customer Support Team
    email: support@telesign.com
  description: 'Operations tagged Templates Callbacks across 2 of this provider''s published API definitions: telesign-engage-callbacks-openapi.json, telesign-engage-callbacks-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://your-callback-url.com
tags:
- name: Templates Callbacks
paths:
  /msg_templates_endpoint:
    parameters: []
    post:
      summary: Receive template management callbacks
      operationId: templatesCallbacks
      responses:
        '200':
          description: OK
      description: 'This is a web service created by you, to receive notifications from Telesign. The details described here are for notifications from Telesign Messaging for template management requests. You can receive notifications from multiple Telesign services at the same endpoint.


        ## Status codes


        | Status code | Text string | Description |

        |-------------|------------------------|-------------|

        |3850|Template successfully created|This template has been successfully created and is ready for use.|

        |3851|Template approved by provider|This template has been successfully created by Telesign and approved by the channel provider and is ready for use.|

        |3852|Template rejected by provider|This template has been rejected by the channel provider.|

        |3853|Template successfully removed|This template has been successfully removed.|

        |3854|Template flagged by provider|This template has been flagged by the channel provider due to misuse.|

        |3855|Template disabled by provider|This template has been disabled by the channel provider.|

        |3857|Removal unsuccessful - provider temporary problem|The template removal has been rejected by the channel provider.|'
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/Shared'
              - type: object
                properties:
                  name:
                    type: string
                    description: The name of this template. This serves as a unique identifier per channel per customer.
                    example: WAMarketingTemplate1
                  channel:
                    type: string
                    description: The channel that messages using this template are sent on.
                    example: whatsapp
                    enum:
                    - whatsapp
                    - sms
                  language:
                    type: array
                    description: Abbreviations that specify the languages used in the text in your template. Required for WhatsApp templates. Not used for templates on other channels. See [Supported Languages](https://developers.facebook.com/docs/whatsapp/api/messages/message-templates#supported-languages) in Facebook's documentation for a complete list of valid abbreviations.
                    example:
                    - en_US
                    items:
                      type: string
                  status:
                    allOf:
                    - $ref: '#/components/schemas/Status'
                    - type: object
                      properties:
                        code:
                          type: integer
                          example: 3850
                        description:
                          type: string
                          example: Template successfully created
                required:
                - name
                - channel
                - status
            examples:
              Example:
                value:
                  reference_id: B56259E45884010488343BAA15FB0002
                  name: WAMarketingTemplate1
                  channel: whatsapp
                  language:
                  - en_US
                  status:
                    code: 3850
                    description: Template successfully created
                    updated_on: '2022-09-21T14:05:36.181346Z'
        description: ''
      tags:
      - Templates Callbacks
    servers:
    - url: https://your-callback-url.com
components:
  schemas:
    Status:
      title: Status
      type: object
      description: Contains properties related to the processing status of this transaction or send.
      properties:
        code:
          type: integer
          example: 200
          description: Numeric code that indicates the processing status of this transaction or send.
        description:
          type: string
          example: Delivered to handset
          description: Text that describes the processing status of this transaction or send.
        updated_on:
          type: string
          example: '2016-10-21T14:05:36.181346Z'
          description: Timestamp that indicates when the status of this transaction or send was last updated.
      required:
      - code
      - description
      - updated_on
    Shared:
      title: Shared
      type: object
      properties:
        reference_id:
          type: string
          description: The service's unique identifier for the original transaction this notification is related to.
          minLength: 32
          maxLength: 32
          example: B56259E45884010488343BAA15FB0002
      required:
      - reference_id
x-refined-from:
- telesign-engage-callbacks-openapi.json
- telesign-engage-callbacks-openapi.yml
x-readme:
  explorer-enabled: true
  proxy-enabled: true
  samples-enabled: true