Syniverse Application API

openapi: 3.2.0
info:
  title: SCG Application API
  description: Synivere Communication Gateway API
  version: 1.0.0
servers:
- url: https://api.syniverse.com/scg-external-api/api/v1
tags:
- name: Application
paths:
  /applications:
    get:
      summary: Returns the list of applications
      tags:
      - Application
      description: '  Returns the list of applications'
      parameters:
      - in: query
        name: id
        description: 'Unique id of the sender class

          '
        schema:
          type: string
      - in: query
        name: name
        description: 'The name of the appication.

          '
        schema:
          type: string
      - in: query
        name: auth_code_length
        description: 'The length of the authentication token that will be used for authentication.

          '
        schema:
          type: number
      - in: query
        name: auth_token_type
        description: 'NUMERIC, ALPHANUMERIC, ALPHA, COMPLEX

          '
        schema:
          type: string
      - in: query
        name: auth_token_validity_duration
        description: 'The number of seconds that the authentication token should remain valid.

          '
        schema:
          type: number
      - in: query
        name: auth_token_prefix
        description: 'A prefix that will be included with each authentiation token.

          '
        schema:
          type: string
      - in: query
        name: auth_token_delivery_methods
        description: 'SMS

          '
        schema:
          type: string
      - in: query
        name: message_from
        description: 'The SCG sender ID to be used when sending authentication token messages for this appication.

          '
        schema:
          type: string
      - in: query
        name: created_date
        description: 'The date the resource was created

          '
        schema:
          type: string
      - in: query
        name: last_updated_date
        description: 'The data the resource was last changed

          '
        schema:
          type: string
      responses:
        200:
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          description: 'Unique id of the sender class

                            '
                          type: string
                        name:
                          description: 'The name of the appication.

                            '
                          type: string
                        description:
                          description: 'The description for the Application.

                            '
                          type: string
                        auth_code_length:
                          description: 'The length of the authentication token that will be used for authentication.

                            '
                          type: number
                        auth_token_type:
                          description: 'NUMERIC, ALPHANUMERIC, ALPHA, COMPLEX

                            '
                          type: string
                        auth_token_validity_duration:
                          description: 'The number of seconds that the authentication token should remain valid.

                            '
                          type: number
                        auth_token_prefix:
                          description: 'A prefix that will be included with each authentiation token.

                            '
                          type: string
                        auth_token_delivery_methods:
                          description: 'SMS

                            '
                          type: string
                        associate_template:
                          description: 'An inline template or template id to be used to send mdn assosiation validation code. If empty a default template will be used

                            '
                          type: string
                        display_name:
                          description: 'String to be used as value of $display_name parameter in validation and login templates

                            '
                          type: string
                        login_template:
                          description: 'An inline template or template id to be used to send login validation code. If empty a default template will be used

                            '
                          type: string
                        message_from:
                          description: 'The SCG sender ID to be used when sending authentication token messages for this appication.

                            '
                          type: string
                        created_date:
                          description: 'The date the resource was created

                            '
                          type: string
                        last_updated_date:
                          description: 'The data the resource was last changed

                            '
                          type: string
                        version_number:
                          description: 'An ascending version number of the resource.  1 upon creation, incremented by one for each modification done.  Used to implement optimisitic locking

                            '
                          type: integer
        400:
          description: "Bad Request.  The request could not be understood by the server.\n\n  * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length\n"
          content:
            application/json:
              schema:
                properties:
                  error_code:
                    description: The error code for this error.
                    type: string
                  error_description:
                    description: A human readable description of the error.
                    type: string
        401:
          description: "Unauthorized. The request requires user authentication.\n\n  * **401** - Unauthorized - Provided authentication data is invalid or insufficient\n"
          content:
            application/json:
              schema:
                properties:
                  error_code:
                    description: The error code for this error.
                    type: string
                  error_description:
                    description: A human readable description of the error.
                    type: string
        500:
          description: "Server Error. An error has been encountered while processing this request.\n\n  * **500** - Server Error - Internal server error. Please report\n"
          content:
            application/json:
              schema:
                properties:
                  error_code:
                    description: The error code for this error.
                    type: string
                  error_description:
                    description: A human readable description of the error.
                    type: string
        402:
          description: "Payment Required.\n\n  * **402** - Insufficient credit - The account does not have sufficeint funds for this operation\n"
          content:
            application/json:
              schema:
                properties:
                  error_code:
                    description: The error code for this error.
                    type: string
                  error_description:
                    description: A human readable description of the error.
                    type: string
        403:
          description: "Forbidden. The user does not have permission to access the specified resource.\n\n  * **403** - Forbidden - Access to this resource is not allowed with the current application token\n"
          content:
            application/json:
              schema:
                properties:
                  error_code:
                    description: The error code for this error.
                    type: string
                  error_description:
                    description: A human readable description of the error.
                    type: string
        404:
          description: "Not found. The requested resource could not be found.\n\n  * **404** - The Error message provides details about the missing resource - Requested resource not found\n"
          content:
            application/json:
              schema:
                properties:
                  error_code:
                    description: The error code for this error.
                    type: string
                  error_description:
                    description: A human readable description of the error.
                    type: string
        429:
          description: "Too Many Requests. The user has sent too many requests in a given amount of time.\n\n  * **2004** - User sent too many requests - User sent too many requests.\n"
          content:
            application/json:
              schema:
                properties:
                  error_code:
                    description: The error code for this error.
                    type: string
                  error_description:
                    description: A human readable description of the error.
                    type: string
        409:
          description: "Conflict. The request could not be completed due to a conflict with the current state of the target resource.\n\n  * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.\n  * **1011** - The Error message provides details about the key being violated - Unique key constraint violated\n"
          content:
            application/json:
              schema:
                properties:
                  error_code:
                    description: The error code for this error.
                    type: string
                  error_description:
                    description: A human readable description of the error.
                    type: string
    post:
      summary: Creates a new application
      tags:
      - Application
      description: '  Creates a new application'
      responses:
        200:
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    description: The identifier for the newly created resource.
                    type: string
        400:
          description: "Bad Request.  The request could not be understood by the server.\n\n  * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length\n"
          content:
            application/json:
              schema:
                properties:
                  error_code:
                    description: The error code for this error.
                    type: string
                  error_description:
                    description: A human readable description of the error.
                    type: string
        401:
          description: "Unauthorized. The request requires user authentication.\n\n  * **401** - Unauthorized - Provided authentication data is invalid or insufficient\n"
          content:
            application/json:
              schema:
                properties:
                  error_code:
                    description: The error code for this error.
                    type: string
                  error_description:
                    description: A human readable description of the error.
                    type: string
        500:
          description: "Server Error. An error has been encountered while processing this request.\n\n  * **500** - Server Error - Internal server error. Please report\n"
          content:
            application/json:
              schema:
                properties:
                  error_code:
                    description: The error code for this error.
                    type: string
                  error_description:
                    description: A human readable description of the error.
                    type: string
        402:
          description: "Payment Required.\n\n  * **402** - Insufficient credit - The account does not have sufficeint funds for this operation\n"
          content:
            application/json:
              schema:
                properties:
                  error_code:
                    description: The error code for this error.
                    type: string
                  error_description:
                    description: A human readable description of the error.
                    type: string
        403:
          description: "Forbidden. The user does not have permission to access the specified resource.\n\n  * **403** - Forbidden - Access to this resource is not allowed with the current application token\n"
          content:
            application/json:
              schema:
                properties:
                  error_code:
                    description: The error code for this error.
                    type: string
                  error_description:
                    description: A human readable description of the error.
                    type: string
        404:
          description: "Not found. The requested resource could not be found.\n\n  * **404** - The Error message provides details about the missing resource - Requested resource not found\n"
          content:
            application/json:
              schema:
                properties:
                  error_code:
                    description: The error code for this error.
                    type: string
                  error_description:
                    description: A human readable description of the error.
                    type: string
        429:
          description: "Too Many Requests. The user has sent too many requests in a given amount of time.\n\n  * **2004** - User sent too many requests - User sent too many requests.\n"
          content:
            application/json:
              schema:
                properties:
                  error_code:
                    description: The error code for this error.
                    type: string
                  error_description:
                    description: A human readable description of the error.
                    type: string
        409:
          description: "Conflict. The request could not be completed due to a conflict with the current state of the target resource.\n\n  * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.\n  * **1011** - The Error message provides details about the key being violated - Unique key constraint violated\n"
          content:
            application/json:
              schema:
                properties:
                  error_code:
                    description: The error code for this error.
                    type: string
                  error_description:
                    description: A human readable description of the error.
                    type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  description: 'The name of the appication.

                    '
                  type: string
                description:
                  description: 'The description for the Application.

                    '
                  type: string
                auth_code_length:
                  description: 'The length of the authentication token that will be used for authentication.

                    '
                  type: number
                auth_token_type:
                  description: 'NUMERIC, ALPHANUMERIC, ALPHA, COMPLEX

                    '
                  type: string
                auth_token_validity_duration:
                  description: 'The number of seconds that the authentication token should remain valid.

                    '
                  type: number
                auth_token_prefix:
                  description: 'A prefix that will be included with each authentiation token.

                    '
                  type: string
                auth_token_delivery_methods:
                  description: 'SMS

                    '
                  type: string
                associate_template:
                  description: 'An inline template or template id to be used to send mdn assosiation validation code. If empty a default template will be used

                    '
                  type: string
                display_name:
                  description: 'String to be used as value of $display_name parameter in validation and login templates

                    '
                  type: string
                login_template:
                  description: 'An inline template or template id to be used to send login validation code. If empty a default template will be used

                    '
                  type: string
                message_from:
                  description: 'The SCG sender ID to be used when sending authentication token messages for this appication.

                    '
                  type: string
  /'applications/{Application_ID}':
    get:
      summary: Returns the current version of the specified Application
      tags:
      - Application
      description: '  Returns the current version of the specified Application'
      parameters:
      - in: path
        name: Application_ID
        required: true
        description: The Application ID for this resource.
        schema:
          type: string
      - in: query
        name: id
        description: 'Unique id of the sender class

          '
        schema:
          type: string
      - in: query
        name: name
        description: 'The name of the appication.

          '
        schema:
          type: string
      - in: query
        name: auth_code_length
        description: 'The length of the authentication token that will be used for authentication.

          '
        schema:
          type: number
      - in: query
        name: auth_token_type
        description: 'NUMERIC, ALPHANUMERIC, ALPHA, COMPLEX

          '
        schema:
          type: string
      - in: query
        name: auth_token_validity_duration
        description: 'The number of seconds that the authentication token should remain valid.

          '
        schema:
          type: number
      - in: query
        name: auth_token_prefix
        description: 'A prefix that will be included with each authentiation token.

          '
        schema:
          type: string
      - in: query
        name: auth_token_delivery_methods
        description: 'SMS

          '
        schema:
          type: string
      - in: query
        name: message_from
        description: 'The SCG sender ID to be used when sending authentication token messages for this appication.

          '
        schema:
          type: string
      - in: query
        name: created_date
        description: 'The date the resource was created

          '
        schema:
          type: string
      - in: query
        name: last_updated_date
        description: 'The data the resource was last changed

          '
        schema:
          type: string
      responses:
        200:
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    description: 'Unique id of the sender class

                      '
                    type: string
                  name:
                    description: 'The name of the appication.

                      '
                    type: string
                  description:
                    description: 'The description for the Application.

                      '
                    type: string
                  auth_code_length:
                    description: 'The length of the authentication token that will be used for authentication.

                      '
                    type: number
                  auth_token_type:
                    description: 'NUMERIC, ALPHANUMERIC, ALPHA, COMPLEX

                      '
                    type: string
                  auth_token_validity_duration:
                    description: 'The number of seconds that the authentication token should remain valid.

                      '
                    type: number
                  auth_token_prefix:
                    description: 'A prefix that will be included with each authentiation token.

                      '
                    type: string
                  auth_token_delivery_methods:
                    description: 'SMS

                      '
                    type: string
                  associate_template:
                    description: 'An inline template or template id to be used to send mdn assosiation validation code. If empty a default template will be used

                      '
                    type: string
                  display_name:
                    description: 'String to be used as value of $display_name parameter in validation and login templates

                      '
                    type: string
                  login_template:
                    description: 'An inline template or template id to be used to send login validation code. If empty a default template will be used

                      '
                    type: string
                  message_from:
                    description: 'The SCG sender ID to be used when sending authentication token messages for this appication.

                      '
                    type: string
                  created_date:
                    description: 'The date the resource was created

                      '
                    type: string
                  last_updated_date:
                    description: 'The data the resource was last changed

                      '
                    type: string
                  version_number:
                    description: 'An ascending version number of the resource.  1 upon creation, incremented by one for each modification done.  Used to implement optimisitic locking

                      '
                    type: integer
        400:
          description: "Bad Request.  The request could not be understood by the server.\n\n  * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length\n"
          content:
            application/json:
              schema:
                properties:
                  error_code:
                    description: The error code for this error.
                    type: string
                  error_description:
                    description: A human readable description of the error.
                    type: string
        401:
          description: "Unauthorized. The request requires user authentication.\n\n  * **401** - Unauthorized - Provided authentication data is invalid or insufficient\n"
          content:
            application/json:
              schema:
                properties:
                  error_code:
                    description: The error code for this error.
                    type: string
                  error_description:
                    description: A human readable description of the error.
                    type: string
        500:
          description: "Server Error. An error has been encountered while processing this request.\n\n  * **500** - Server Error - Internal server error. Please report\n"
          content:
            application/json:
              schema:
                properties:
                  error_code:
                    description: The error code for this error.
                    type: string
                  error_description:
                    description: A human readable description of the error.
                    type: string
        402:
          description: "Payment Required.\n\n  * **402** - Insufficient credit - The account does not have sufficeint funds for this operation\n"
          content:
            application/json:
              schema:
                properties:
                  error_code:
                    description: The error code for this error.
                    type: string
                  error_description:
                    description: A human readable description of the error.
                    type: string
        403:
          description: "Forbidden. The user does not have permission to access the specified resource.\n\n  * **403** - Forbidden - Access to this resource is not allowed with the current application token\n"
          content:
            application/json:
              schema:
                properties:
                  error_code:
                    description: The error code for this error.
                    type: string
                  error_description:
                    description: A human readable description of the error.
                    type: string
        404:
          description: "Not found. The requested resource could not be found.\n\n  * **404** - The Error message provides details about the missing resource - Requested resource not found\n"
          content:
            application/json:
              schema:
                properties:
                  error_code:
                    description: The error code for this error.
                    type: string
                  error_description:
                    description: A human readable description of the error.
                    type: string
        429:
          description: "Too Many Requests. The user has sent too many requests in a given amount of time.\n\n  * **2004** - User sent too many requests - User sent too many requests.\n"
          content:
            application/json:
              schema:
                properties:
                  error_code:
                    description: The error code for this error.
                    type: string
                  error_description:
                    description: A human readable description of the error.
                    type: string
        409:
          description: "Conflict. The request could not be completed due to a conflict with the current state of the target resource.\n\n  * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.\n  * **1011** - The Error message provides details about the key being violated - Unique key constraint violated\n"
          content:
            application/json:
              schema:
                properties:
                  error_code:
                    description: The error code for this error.
                    type: string
                  error_description:
                    description: A human readable description of the error.
                    type: string
    delete:
      summary: Deletes the Application resource with the specified ID
      tags:
      - Application
      description: '  Deletes the Application resource with the specified ID'
      parameters:
      - in: path
        name: Application_ID
        required: true
        description: The Application ID for this resource.
        schema:
          type: string
      responses:
        204:
          description: Successful operation.  No Content in reponse.
        400:
          description: "Bad Request.  The request could not be understood by the server.\n\n  * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length\n"
          content:
            application/json:
              schema:
                properties:
                  error_code:
                    description: The error code for this error.
                    type: string
                  error_description:
                    description: A human readable description of the error.
                    type: string
        401:
          description: "Unauthorized. The request requires user authentication.\n\n  * **401** - Unauthorized - Provided authentication data is invalid or insufficient\n"
          content:
            application/json:
              schema:
                properties:
                  error_code:
                    description: The error code for this error.
                    type: string
                  error_description:
                    description: A human readable description of the error.
                    type: string
        500:
          description: "Server Error. An error has been encountered while processing this request.\n\n  * **500** - Server Error - Internal server error. Please report\n"
          content:
            application/json:
              schema:
                properties:
                  error_code:
                    description: The error code for this error.
                    type: string
                  error_description:
                    description: A human readable description of the error.
                    type: string
        402:
          description: "Payment Required.\n\n  * **402** - Insufficient credit - The account does not have sufficeint funds for this operation\n"
          content:
            application/json:
              schema:
                properties:
                  error_code:
                    description: The error code for this error.
                    type: string
                  error_description:
                    description: A human readable description of the error.
                    type: string
        403:
          description: "Forbidden. The user does not have permission to access the specified resource.\n\n  * **403** - Forbidden - Access to this resource is not allowed with the current application token\n"
          content:
            application/json:
              schema:
                properties:
                  error_code:
                    description: The error code for this error.
                    type: string
                  error_description:
                    description: A human readable description of the error.
                    type: string
        404:
          description: "Not found. The requested resource could not be found.\n\n  * **404** - The Error message provides details about the missing resource - Requested resource not found\n"
          content:
            application/json:
              schema:
                properties:
                  error_code:
                    description: The error code for this error.
                    type: string
                  error_description:
                    description: A human readable description of the error.
                    type: string
        429:
          description: "Too Many Requests. The user has sent too many requests in a given amount of time.\n\n  * **2004** - User sent too many requests - User sent too many requests.\n"
          content:
            application/json:
              schema:
                properties:
                  error_code:
                    description: The error code for this error.
                    type: string
                  error_description:
                    description: A human readable description of the error.
                    type: string
        409:
          description: "Conflict. The request could not be completed due to a conflict with the current state of the target resource.\n\n  * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.\n  * **1011** - The Error message provides details about the key being violated - Unique key constraint violated\n"
          content:
            application/json:
              schema:
                properties:
                  error_code:
                    description: The error code for this error.
                    type: string
                  error_description:
                    des

# --- truncated at 32 KB (32 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/syniverse/refs/heads/main/openapi/syniverse-application-api-openapi.yml