Microsoft Azure Communication Services Template API

openapi: 3.2.0
info:
  title: CommunicationMessagesClient Template API
  version: '2024-08-30'
  description: Azure Communication Messages Service
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
security:
- AadOauth2Auth:
  - https://communication.azure.com/.default
- ApiKeyAuth: []
tags:
- name: Template
paths:
  /messages/channels/{channelId}/templates:
    get:
      operationId: TemplateOperations_ListTemplates
      tags:
      - Template
      description: List all templates for given Azure Communication Services channel
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: channelId
        in: path
        description: The registration ID of the channel.
        required: true
        schema:
          type: string
          format: uuid
      - name: maxpagesize
        in: query
        description: Number of objects to return per page.
        required: false
        schema:
          type: integer
          format: int32
      - $ref: '#/components/parameters/Azure.Core.ClientRequestIdHeader'
      responses:
        '200':
          description: The request has succeeded.
          headers:
            x-ms-client-request-id:
              description: An opaque, globally-unique, client-generated string identifier for the request.
              schema:
                type: string
                format: uuid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedMessageTemplateItem'
        default:
          description: An unexpected error response.
          headers:
            x-ms-error-code:
              description: String error code indicating what went wrong.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Template operations list templates
      x-summary-source: derived
components:
  schemas:
    MessageTemplateStatus:
      type: string
      description: The aggregated template status.
      enum:
      - approved
      - rejected
      - pending
      - paused
      x-ms-enum:
        name: MessageTemplateStatus
        modelAsString: true
        values:
        - name: approved
          value: approved
          description: Message template is approved.
        - name: rejected
          value: rejected
          description: Message template is rejected.
        - name: pending
          value: pending
          description: Message template is pending.
        - name: paused
          value: paused
          description: Message template is paused.
    Azure.Core.Foundations.ErrorResponse:
      type: object
      description: A response containing error details.
      properties:
        error:
          $ref: '#/components/schemas/Azure.Core.Foundations.Error'
          description: The error object.
      required:
      - error
    PagedMessageTemplateItem:
      type: object
      description: Paged collection of MessageTemplateItem items
      properties:
        value:
          type: array
          description: The MessageTemplateItem items on this page
          items:
            $ref: '#/components/schemas/MessageTemplateItem'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    Azure.Core.Foundations.InnerError:
      type: object
      description: An object containing more specific information about the error. As per Azure REST API guidelines - https://aka.ms/AzureRestApiGuidelines#handling-errors.
      properties:
        code:
          type: string
          description: One of a server-defined set of error codes.
        innererror:
          $ref: '#/components/schemas/Azure.Core.Foundations.InnerError'
          description: Inner error.
    Azure.Core.Foundations.Error:
      type: object
      description: The error object.
      properties:
        code:
          type: string
          description: One of a server-defined set of error codes.
        message:
          type: string
          description: A human-readable representation of the error.
        target:
          type: string
          description: The target of the error.
        details:
          type: array
          description: An array of details about specific errors that led to this reported error.
          items:
            $ref: '#/components/schemas/Azure.Core.Foundations.Error'
        innererror:
          $ref: '#/components/schemas/Azure.Core.Foundations.InnerError'
          description: An object containing more specific information than the current object about the error.
      required:
      - code
      - message
    MessageTemplateItem:
      type: object
      description: The message template as returned from the service.
      properties:
        name:
          type: string
          description: The template's name.
          readOnly: true
        language:
          type: string
          description: The template's language, in the ISO 639 format, consist of a two-letter language code followed by an optional two-letter country code, e.g., 'en' or 'en_US'.
        status:
          $ref: '#/components/schemas/MessageTemplateStatus'
          description: The aggregated template status.
        kind:
          $ref: '#/components/schemas/CommunicationMessagesChannel'
          description: The type discriminator describing a template type.
      discriminator:
        propertyName: kind
      required:
      - name
      - language
      - status
      - kind
    CommunicationMessagesChannel:
      type: string
      description: The type of the communication messages channel.
      enum:
      - whatsApp
      x-ms-enum:
        name: CommunicationMessagesChannel
        modelAsString: true
        values:
        - name: whatsApp
          value: whatsApp
          description: The WhatsApp communication messages channel type.
  parameters:
    Azure.Core.ClientRequestIdHeader:
      name: x-ms-client-request-id
      in: header
      description: An opaque, globally-unique, client-generated string identifier for the request.
      required: false
      x-ms-parameter-location: method
      x-ms-client-name: clientRequestId
      schema:
        type: string
        format: uuid
    Azure.Core.Foundations.ApiVersionParameter:
      name: api-version
      in: query
      description: The API version to use for this operation.
      required: true
      x-ms-parameter-location: method
      x-ms-client-name: apiVersion
      schema:
        type: string
        minLength: 1
  securitySchemes:
    AadOauth2Auth:
      type: oauth2
      flows:
        authorizationCode:
          scopes:
            https://communication.azure.com/.default: ''
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
          tokenUrl: https://login.microsoftonline.com/common/oauth2/token
      description: The Azure Active Directory OAuth2 Flow
    ApiKeyAuth:
      type: apiKey
      name: Authorization
      in: header
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - name: endpoint
    in: path
    description: The communication resource, for example https://my-resource.communication.azure.com
    required: true
    type: string
    format: uri
    x-ms-skip-url-encoding: true