CM.com Flow Builder API

openapi: 3.2.0
info:
  title: Voice Flow Builder API
  version: v2
servers:
- url: https://api.cm.com
security:
- X-CM-PRODUCTTOKEN: []
tags:
- name: Flow Builder
paths:
  /voiceapi/v2/flowbuilder:
    post:
      tags:
      - Flow Builder
      summary: FlowBuilder
      description: Initiate an outbound FlowBuilder call. For more information, see the Voice FlowBuilder documentation.
      requestBody:
        description: Details of the FlowBuilder instruction.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FlowBuilderInstruction'
          text/json:
            schema:
              $ref: '#/components/schemas/FlowBuilderInstruction'
          application/*+json:
            schema:
              $ref: '#/components/schemas/FlowBuilderInstruction'
      responses:
        '200':
          description: Call is queued
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallQueuedEvent'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionEvent'
        '401':
          description: Unauthorized
      operationId: postVoiceapiV2Flowbuilder
      x-operation-id-source: derived
components:
  schemas:
    ExceptionEvent:
      title: Exception Event
      type: object
      properties:
        type:
          type:
          - string
          - 'null'
          description: The Type of event.
          readOnly: true
        call-id:
          type: string
          description: The ID of the call this event belongs to.
          format: uuid
        instruction-id:
          type:
          - string
          - 'null'
          description: The ID of the instruction the event is a result of.
        queue-id:
          type:
          - string
          - 'null'
          description: The ID of the queue.
        code:
          $ref: '#/components/schemas/ExceptionEventCode'
        title:
          type:
          - string
          - 'null'
          description: The title of the exception.
          readOnly: true
        message:
          type:
          - string
          - 'null'
          description: Some explanatory text on the exception.
      additionalProperties: false
      description: And event containing an exception.
    VoicemailResponse:
      title: Voicemail Response
      enum:
      - Ignore
      - Restart
      - Stop
      - Disconnect
      type: string
      description: The type that determines the flow of Voicemail detection.
    FlowBuilderInstruction:
      title: Flow Builder Instruction
      required:
      - caller
      - callflow-id
      type: object
      properties:
        instruction-id:
          maxLength: 64
          type:
          - string
          - 'null'
          description: 'Optional string that allows you to uniquely identify the placed outbound call. Its value is also included

            in the callback and Call Detail Records (CDRs).'
          example: mycustomid
        callee:
          maxLength: 24
          pattern: ^(\+|00)?[1-9]\d{6,14}$
          type:
          - string
          - 'null'
          description: 'The number to dial. When the number is invalid, the request will be rejected. Must be in valid international

            E.164 format.'
          example: '+31612345678'
        callees:
          pattern: ^(\+|00)?[1-9]\d{6,14}$
          maxItems: 100
          type:
          - array
          - 'null'
          items:
            type: string
          description: 'List of multiple numbers to dial. When the list contains one or more invalid numbers, the request will be

            rejected. Must be in valid international E.164 format.'
          example:
          - '+31612345678'
          - '+31612345679'
        caller:
          maxLength: 24
          minLength: 1
          pattern: ^(\+|00)?[1-9]\d{6,14}$
          type: string
          description: The caller ID to display on the recipient's phone. Must be in valid international E.164 format.
          example: '+31612345678'
        anonymous:
          type: boolean
          description: Indicates whether the caller ID should be hidden. Defaults to `false`.
          example: false
        callback-url:
          type:
          - string
          - 'null'
          description: 'URL that will be called when the call is finished. The body of this POST request will contain details about

            the call or calls.'
          format: uri
        max-ringing-timeout:
          maximum: 60
          minimum: 10
          type:
          - integer
          - 'null'
          description: 'Determines how long the Voice API will wait for the callee to answer the call. Cancels the ringing call

            after the timeout period exceeded. Defaults to `60`.'
          format: int32
          example: 60
        callflow-id:
          minLength: 1
          type: string
          description: 'This property represents the unique identifier for a FlowBuilder flow. For guidance on locating the callflow

            ID of a specific flow, please refer to the <a href="/voice/flowbuilder/configuring-flows/outbound-calls#finding-your-call-flow-id">FlowBuilder documentation</a>.'
          example: 00000000-0000-0000-0000-000000000000
        flow-variables:
          type:
          - object
          - 'null'
          additionalProperties: {}
          description: 'Optional list of flow variables that will be set. For more information on FlowBuilder variables, please see

            the <a href="/voice/flowbuilder/flow-variables">FlowBuilder documentation</a>.'
        voicemail-response:
          $ref: '#/components/schemas/VoicemailResponse'
      additionalProperties: false
      description: This sends the instruction to make and outbound call and start a FlowBuilder flow.
    ExceptionEventCode:
      title: Exception Event Code
      enum:
      - InvalidJson
      - SignatureError
      - FileNotFound
      - InvalidInstruction
      - InvalidParameter
      - InsufficientBalance
      - PremiumNotAllowed
      - CallLimitReached
      - TooManyNumbers
      type: string
      description: Enum of the different codes of exceptions.
    CallQueuedEvent:
      title: Call Queued Event
      type: object
      properties:
        type:
          type:
          - string
          - 'null'
          description: The Type of event.
          readOnly: true
        call-id:
          type: string
          description: The ID of the call this event belongs to.
          format: uuid
        instruction-id:
          type:
          - string
          - 'null'
          description: The ID of the instruction the event is a result of.
        queue-id:
          type:
          - string
          - 'null'
          description: The ID of the queue.
        caller:
          type:
          - string
          - 'null'
          description: The id (e.g. number) of the caller.
        callee:
          type:
          - string
          - 'null'
          description: The id (e.g. number) of the callee.
        success:
          type: boolean
          description: True if the PlaceCallInstruction was accepted.
        error:
          type:
          - string
          - 'null'
          description: True if the PlaceCallInstruction was accepted.
      additionalProperties: false
      description: 'Event that is a result (basically a direct response) to the PlaceCallInstruction.

        This one is generally used in the async versions of the calls.'
  securitySchemes:
    X-CM-PRODUCTTOKEN:
      type: apiKey
      description: Your producttoken
      name: X-CM-PRODUCTTOKEN
      in: header
x-readme:
  explorer-enabled: true
  proxy-enabled: true