{
  "openapi": "3.0.1",
  "info": {
    "title": "Telgorithm Messaging API",
    "description": "Our APIs implement rate limiting, which defines the maximum number of calls allowed within a specified time interval. Rate limiting helps ensure optimal performance for the integration between your software and Telgorithm by preventing other clients from negatively affecting your service.  \n\nAlthough no universally accepted standard exists for HTTP rate-limiting headers, we were guided by the [**IETF draft: RateLimit Fields for HTTP**](https://www.ietf.org/archive/id/draft-ietf-httpapi-ratelimit-headers-05.html).  \n  \nWe use the following HTTP headers for our API endpoints:  \n\n```\nRateLimit-Limit: The total number of requests allowed in the current time window.\nRateLimit-Remaining: A non-negative integer representing the number of remaining requests allowed in the current time window.\nRateLimit-Reset: The number of seconds until the quota resets and the full quota becomes available.\n```\n\nDefault quotas:\n\n| Endpoint                             | Default            |\n| ------------------------------------ | ------------------ |\n| POST `messaging/v1/OutboundMessages` | 200 per 10 seconds       |\n| All REST GET endpoints               | 100 per 10 seconds |\n| REST non-GET endpoints               | 100 per 10 seconds  |\n\nWhen the quota is exceeded, the server does not process the request and instead responds with a 429 HTTP status code. \n\nIf you need a higher quota, please [contact us](mailto:support@telgorithm.com).\n",
    "version": "v1"
  },
  "servers": [
    {
      "url": "/messaging"
    }
  ],
  "paths": {
    "/v1/CallLegs": {
      "get": {
        "tags": [
          "CallLegs"
        ],
        "summary": "List Call Legs",
        "description": "Returns the list of Call Legs, optionally filtered by parameters.\nThis method supports pagination.",
        "parameters": [
          {
            "name": "CallSid",
            "in": "query",
            "description": "Call Sid.",
            "schema": {
              "pattern": "^(CA)[0-9a-f]{48}$",
              "type": "string"
            }
          },
          {
            "name": "Status",
            "in": "query",
            "description": "Call Leg status.",
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/CallLegStatus"
                }
              ]
            }
          },
          {
            "name": "LegDirection",
            "in": "query",
            "description": "Call Leg direction.",
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/CallDirection"
                }
              ]
            }
          },
          {
            "name": "From",
            "in": "query",
            "description": "Originating (caller) Phone Number or SIP URI.\n\n\nIf it is a SIP URI, it must start with the `sip:` or `sips:` prefix, and must be formatted\naccording to RFC 3261 standard. Examples of valid SIP URI:\n<ul><li>`sip:user@server.com:5060`</li><li>`sip:user@server.com;transport=TLS`</li><li>`sip:user@server.com?header1=value1&header2=value2`</li><li>`sip:user@server.com:5060;transport=TCP?header=value`</li></ul>",
            "schema": {
              "maxLength": 256,
              "type": "string"
            }
          },
          {
            "name": "To",
            "in": "query",
            "description": "Terminating (callee) Phone Number or SIP URI.\n\n\nIf it is a SIP URI, it must start with the `sip:` or `sips:` prefix, and must be formatted\naccording to RFC 3261 standard. Examples of valid SIP URI:\n<ul><li>`sip:user@server.com:5060`</li><li>`sip:user@server.com;transport=TLS`</li><li>`sip:user@server.com?header1=value1&header2=value2`</li><li>`sip:user@server.com:5060;transport=TCP?header=value`</li></ul>",
            "schema": {
              "maxLength": 256,
              "type": "string"
            }
          },
          {
            "name": "CreatedOnFrom",
            "in": "query",
            "description": "Date and time, that Call Leg creation date should be greater than or equal to.\n\nMust have ISO format (e.g. `yyyy-MM-dd'T'HH:mm:ss`).",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "CreatedOnTo",
            "in": "query",
            "description": "Date and time, that Call Leg creation date should be less than.\n\nMust have ISO format (e.g. `yyyy-MM-dd'T'HH:mm:ss`).",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "PageSize",
            "in": "query",
            "schema": {
              "maximum": 10000,
              "minimum": 1,
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "OrderByDirection",
            "in": "query",
            "description": "\n<p>Possible values:</p>\n<ul>\n<li><b>Ascending</b></li>\n<li><b>Descending</b></li>\n</ul>\n",
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/OrderByDirections"
                }
              ],
              "description": "\n<p>Possible values:</p>\n<ul>\n<li><b>Ascending</b></li>\n<li><b>Descending</b></li>\n</ul>\n"
            }
          },
          {
            "name": "SearchId",
            "in": "query",
            "schema": {
              "type": "string",
              "format": "byte"
            }
          },
          {
            "name": "includeFees",
            "in": "query",
            "description": "If `true`, fees are included into result.",
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/CallLegModelPaginatedResult"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CallLegModelPaginatedResult"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/CallLegModelPaginatedResult"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          }
        }
      }
    },
    "/v1/CallLegs/{sid}": {
      "get": {
        "tags": [
          "CallLegs"
        ],
        "summary": "Get Call Leg Info",
        "description": "Returns the specified Call Leg information.\nIf includeFees is `true`, fees are included into result.",
        "parameters": [
          {
            "name": "sid",
            "in": "path",
            "description": "Call Leg Sid.",
            "required": true,
            "schema": {
              "pattern": "^(CL)[0-9a-f]{48}$",
              "type": "string"
            }
          },
          {
            "name": "includeFees",
            "in": "query",
            "description": "If `true`, fees are included into result.",
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/CallLegModel"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CallLegModel"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/CallLegModel"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          },
          "404": {
            "description": "Call Leg with the specified Sid wasn't found.",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          }
        }
      }
    },
    "/v1/Calls": {
      "get": {
        "tags": [
          "Calls"
        ],
        "summary": "List Calls",
        "description": "Returns the list of Calls, optionally filtered by parameters.\nThis method supports pagination.",
        "parameters": [
          {
            "name": "Direction",
            "in": "query",
            "description": "Call direction.",
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/CallDirection"
                }
              ]
            }
          },
          {
            "name": "InternalNumber",
            "in": "query",
            "description": "The Phone Number which belongs to your Telgorithm account and which was the originating (caller) or\nterminating (callee) party of the Call, depending on the `Direction`.",
            "schema": {
              "maxLength": 16,
              "type": "string"
            }
          },
          {
            "name": "ExternalNumber",
            "in": "query",
            "description": "The external Phone Number or SIP URI which was the originating (caller) or terminating (callee) party\nof the Call, depending on the `Direction`.\n\n\nIf it is a SIP URI, it must start with the `sip:` or `sips:` prefix, and must be formatted\naccording to RFC 3261 standard. Examples of valid SIP URI:\n<ul><li>`sip:user@server.com:5060`</li><li>`sip:user@server.com;transport=TLS`</li><li>`sip:user@server.com?header1=value1&header2=value2`</li><li>`sip:user@server.com:5060;transport=TCP?header=value`</li></ul>",
            "schema": {
              "maxLength": 256,
              "type": "string"
            }
          },
          {
            "name": "CreatedOnFrom",
            "in": "query",
            "description": "Date and time, that Call creation date should be greater than or equal to.\n\nMust have ISO format (e.g. `yyyy-MM-dd'T'HH:mm:ss`).",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "CreatedOnTo",
            "in": "query",
            "description": "Date and time, that Call creation date should be less than.\n\nMust have ISO format (e.g. `yyyy-MM-dd'T'HH:mm:ss`).",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "PageSize",
            "in": "query",
            "schema": {
              "maximum": 10000,
              "minimum": 1,
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "OrderByDirection",
            "in": "query",
            "description": "\n<p>Possible values:</p>\n<ul>\n<li><b>Ascending</b></li>\n<li><b>Descending</b></li>\n</ul>\n",
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/OrderByDirections"
                }
              ],
              "description": "\n<p>Possible values:</p>\n<ul>\n<li><b>Ascending</b></li>\n<li><b>Descending</b></li>\n</ul>\n"
            }
          },
          {
            "name": "SearchId",
            "in": "query",
            "schema": {
              "type": "string",
              "format": "byte"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/CallModelPaginatedResult"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CallModelPaginatedResult"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/CallModelPaginatedResult"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          }
        }
      },
      "post": {
        "tags": [
          "Calls"
        ],
        "summary": "Initiate Outbound Call",
        "description": "<p>\n            This endpoint allows to initiate two-leg Outbound Calls.\n            </p>\n<p>\n            The first call leg is initiated from the internal Phone Number (which belongs to your account, specified by\n            `CallerId` field in the request body) to the agent's Phone Number (an external number, specified by\n            `From` field).\n            </p>\n<p>\n            When the first leg is answered, Telgorithm randomly selects one digit from 1 to 9 and plays a voice\n            instruction telling the agent which digit to press. The agent must press that exact digit. For example,\n            if the instruction says to press 7, only 7 is accepted; pressing any other digit will not complete the human-verification step.\n            </p>\n<p>\n            Finally, the second leg is initiated from the internal Phone Number (`CallerId`) to the `To` number\n            specified in the request body, and when it is answered, both call legs are connected to each other.\n            </p>\n<p>\n            The Call ends when any party hang it up, or when you request hangup by an API call.\n            </p>",
        "requestBody": {
          "content": {
            "application/json-patch+json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/InitiateCallRequest"
                  }
                ],
                "description": "Initiate Call request"
              }
            },
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/InitiateCallRequest"
                  }
                ],
                "description": "Initiate Call request"
              }
            },
            "text/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/InitiateCallRequest"
                  }
                ],
                "description": "Initiate Call request"
              }
            },
            "application/*+json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/InitiateCallRequest"
                  }
                ],
                "description": "Initiate Call request"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Outbound Call was successfully initiated.\nThis is an asynchronous operation. Shortly after this request the `From` Phone Number should\nreceive an incoming call from `CallerId` Phone Number.",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/InitiateCallResult"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InitiateCallResult"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/InitiateCallResult"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          },
          "403": {
            "description": "The requested API is not available for your company. Please contact support.",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          }
        }
      }
    },
    "/v1/Calls/{sid}": {
      "get": {
        "tags": [
          "Calls"
        ],
        "summary": "Get Call Info",
        "description": "Returns the specified Call information.",
        "parameters": [
          {
            "name": "sid",
            "in": "path",
            "description": "Call Sid.",
            "required": true,
            "schema": {
              "pattern": "^(CA)[0-9a-f]{48}$",
              "type": "string"
            }
          },
          {
            "name": "includeFees",
            "in": "query",
            "description": "If `true`, fees are included into result.",
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/CallDetailedModel"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CallDetailedModel"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/CallDetailedModel"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          },
          "404": {
            "description": "Call with the specified Sid wasn't found.",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          }
        }
      }
    },
    "/v1/Calls/{sid}/hangup": {
      "post": {
        "tags": [
          "Calls"
        ],
        "summary": "Hangup Call",
        "description": "Ends a specified Call.",
        "parameters": [
          {
            "name": "sid",
            "in": "path",
            "description": "Call Sid.",
            "required": true,
            "schema": {
              "pattern": "^(CA)[0-9a-f]{48}$",
              "type": "string"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "The command to end the Call was successfully accepted.\nThis is an asynchronous operation. The Call will be ended shortly after this request.",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          },
          "404": {
            "description": "Call with the specified Sid wasn't found.",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          },
          "409": {
            "description": "Call is already completed.",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          }
        }
      }
    },
    "/v1/Calls/{sid}/recording-control": {
      "post": {
        "tags": [
          "Calls"
        ],
        "summary": "Start/Pause/Resume Call Recording",
        "description": "Allows starting and pausing of the Call Recording.",
        "parameters": [
          {
            "name": "sid",
            "in": "path",
            "description": "Call Sid.",
            "required": true,
            "schema": {
              "pattern": "^(CA)[0-9a-f]{48}$",
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json-patch+json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/CallRecordingControlRequest"
                  }
                ],
                "description": "Call Recording Control Request."
              }
            },
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/CallRecordingControlRequest"
                  }
                ],
                "description": "Call Recording Control Request."
              }
            },
            "text/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/CallRecordingControlRequest"
                  }
                ],
                "description": "Call Recording Control Request."
              }
            },
            "application/*+json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/CallRecordingControlRequest"
                  }
                ],
                "description": "Call Recording Control Request."
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The requested recording control action was accepted.\nThis is an asynchronous operation. The recording will be started or paused shortly after this request.",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/CallRecordingControlResponse"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CallRecordingControlResponse"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/CallRecordingControlResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          },
          "404": {
            "description": "Call with the specified Sid wasn't found.",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          },
          "409": {
            "description": "Call is already completed, or Call Recording is already started or paused.",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          }
        }
      }
    },
    "/v1/Calls/{callSid}/recordings/{recordingIndex}/download": {
      "get": {
        "tags": [
          "Calls"
        ],
        "summary": "Get Call Recording",
        "description": "Use your credentials to access the call recording by this endpoint.\nIt returns the redirect link (pre-signed URL) to the call recording blob in the platform's recording storage,\nin the `Location` header of the 302 response. You should follow this redirect to access the media file.\nNote that this link will be valid for 15 minutes only and is regenerated every time you access this endpoint.\nTherefore, you MUST NOT cache or save it in any form.",
        "parameters": [
          {
            "name": "callSid",
            "in": "path",
            "description": "Call Sid.",
            "required": true,
            "schema": {
              "pattern": "^(CA)[0-9a-f]{48}$",
              "type": "string"
            }
          },
          {
            "name": "recordingIndex",
            "in": "path",
            "description": "The index of the recording, 1-based.",
            "required": true,
            "schema": {
              "maximum": 2147483647,
              "minimum": 1,
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "302": {
            "description": "Recording was found and available by following the URL in the `Location` header.",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          },
          "404": {
            "description": "Call with the specified Sid or Call Recording with the specified index wasn't found.",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          }
        }
      }
    },
    "/v1/InboundMessages": {
      "get": {
        "tags": [
          "InboundMessages"
        ],
        "summary": "List Inbound Messages",
        "description": "Gets the list of all Inbound Messages, optionally filtered by parameters.\nThis method supports pagination.",
        "parameters": [
          {
            "name": "From",
            "in": "query",
            "description": "Sender phone number",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "To",
            "in": "query",
            "description": "Recipient phone number",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "CreatedOnFrom",
            "in": "query",
            "description": "Date-time, that Inbound message creation should be greater or equal than.\n\n<b>Must have ISO format (e.g. yyyy-MM-dd'T'HH:mm:ss)</b>",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "CreatedOnTo",
            "in": "query",
            "description": "Date-time, that Inbound message creation should be less than.\n\n<b>Must have ISO format (e.g. yyyy-MM-dd'T'HH:mm:ss)</b>",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "PageSize",
            "in": "query",
            "schema": {
              "maximum": 10000,
              "minimum": 1,
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "OrderByDirection",
            "in": "query",
            "description": "\n<p>Possible values:</p>\n<ul>\n<li><b>Ascending</b></li>\n<li><b>Descending</b></li>\n</ul>\n",
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/OrderByDirections"
                }
              ],
              "description": "\n<p>Possible values:</p>\n<ul>\n<li><b>Ascending</b></li>\n<li><b>Descending</b></li>\n</ul>\n"
            }
          },
          {
            "name": "SearchId",
            "in": "query",
            "schema": {
              "type": "string",
              "format": "byte"
            }
          },
          {
            "name": "IncludeFees",
            "in": "query",
            "description": "If true, fees are included into the result.",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "IncludeConversationMetadata",
            "in": "query",
            "description": "If true, conversation metadata is included into the result.",
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/InboundMessageModelPaginatedResult"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InboundMessageModelPaginatedResult"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/InboundMessageModelPaginatedResult"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          }
        }
      }
    },
    "/v1/InboundMessages/{sid}": {
      "get": {
        "tags": [
          "InboundMessages"
        ],
        "summary": "Get Inbound Message by Sid",
        "description": "Returns the specified Inbound Message information.",
        "parameters": [
          {
            "name": "sid",
            "in": "path",
            "description": "Inbound Message Sid.",
            "required": true,
            "schema": {
              "pattern": "^(IM)[0-9a-f]{48}$",
              "type": "string"
            }
          },
          {
            "name": "IncludeFees",
            "in": "query",
            "description": "If true, fees are included into the result.",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "IncludeConversationMetadata",
            "in": "query",
            "description": "If true, conversation metadata is included into the result.",
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/InboundMessageModel"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InboundMessageModel"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/InboundMessageModel"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          },
          "404": {
            "description": "Not Found",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          }
        }
      }
    },
    "/v1/MessagingConfigs": {
      "post": {
        "tags": [
          "MessagingConfigs"
        ],
        "summary": "Create Messaging Config",
        "description": "Creates new Messaging Config with the options specified in the request.\nIf callback URLs are not specified for a particular event, the callbacks for that event would not be sent.",
        "requestBody": {
          "content": {
            "application/json-patch+json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/MessagingConfigRequest"
                  }
                ],
                "description": "Create / Update Messaging Config Request."
              }
            },
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/MessagingConfigRequest"
                  }
                ],
                "description": "Create / Update Messaging Config Request."
              }
            },
            "text/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/MessagingConfigRequest"
                  }
                ],
                "description": "Create / Update Messaging Config Request."
              }
            },
            "application/*+json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/MessagingConfigRequest"
                  }
                ],
                "description": "Create / Update Messaging Config Request."
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Created",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/MessagingConfigDetailsModel"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MessagingConfigDetailsModel"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/MessagingConfigDetailsModel"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          }
        }
      },
      "get": {
        "tags": [
          "MessagingConfigs"
        ],
        "summary": "List Messaging Configs",
        "description": "Gets the list of all Messaging Configs.\nThis method supports pagination.",
        "parameters": [
          {
            "name": "PageSize",
            "in": "query",
            "schema": {
              "maximum": 10000,
              "minimum": 1,
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "OrderByDirection",
            "in": "query",
            "description": "\n<p>Possible values:</p>\n<ul>\n<li><b>Ascending</b></li>\n<li><b>Descending</b></li>\n</ul>\n",
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/OrderByDirections"
                }
              ],
              "description": "\n<p>Possible values:</p>\n<ul>\n<li><b>Ascending</b></li>\n<li><b>Descending</b></li>\n</ul>\n"
            }
          },
          {
            "name": "SearchId",
            "in": "query",
            "schema": {
              "type": "string",
              "format": "byte"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/MessagingConfigListModelPaginatedResult"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MessagingConfigListModelPaginatedResult"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/MessagingConfigListModelPaginatedResult"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          }
        }
      }
    },
    "/v1/MessagingConfigs/{sid}": {
      "patch": {
        "tags": [
          "MessagingConfigs"
        ],
        "summary": "Update Specific Messaging Config Options",
        "description": "Updates options for the specified Messaging Config.\nUpdates only the options that are passed in the request and are not `null`, does not change other values.",
        "parameters": [
          {
            "name": "sid",
            "in": "path",
            "description": "Messaging Config Sid.",
            "required": true,
            "schema": {
              "pattern": "^(MC)[0-9a-f]{32}$",
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "description": "",
          "content": {
            "application/json-patch+json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/MessagingConfigRequest"
                  }
                ],
                "description": "Create / Update Messaging Config Request."
              }
            },
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/MessagingConfigRequest"
                  }
                ],
                "description": "Create / Update Messaging Config Request."
              }
            },
            "text/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/MessagingConfigRequest"
                  }
                ],
                "description": "Create / Update Messaging Config Request."
              }
            },
            "application/*+json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/MessagingConfigRequest"
                  }
                ],
                "description": "Create / Update Messaging Config Request."
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/MessagingConfigDetailsModel"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MessagingConfigDetailsModel"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/MessagingConfigDetailsModel"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          },
          "404": {
            "description": "Not Found",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          }
        }
      },
      "put": {
        "tags": [
          "MessagingConfigs"
        ],
        "summary": "Update Messaging Config Options",
        "description": "Updates options for the specified Messaging Config.\nIf callback URLs are not specified for a particular event, the callbacks for that event would not be sent.",
        "parameters": [
          {
            "name": "sid",
            "in": "path",
            "description": "Messaging Config Sid.",
            "required": true,
            "schema": {
              "pattern": "^(MC)[0-9a-f]{32}$",
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "description": "",
          "content": {
            "application/json-patch+json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/MessagingConfigRequest"
                  }
                ],
                "description": "Create / Update Messaging Config Request."
              }
            },
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/MessagingConfigRequest"
                  }
                ],
                "description": "Create / Update Messaging Config Request."
              }
            },
            "text/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/MessagingConfigRequest"
                  }
                ],
                "description": "Create / Update Messaging Config Request."
              }
            },
            "application/*+json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/MessagingConfigRequest"
                  }
                ],
                "description": "Create / Update Messaging Config Request."
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/MessagingConfigDetailsModel"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MessagingConfigDetailsModel"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/MessagingConfigDetailsModel"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          },
          "404": {
            "description": "Not Found",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          }
        }
      },
      "get": {
        "tags": [
          "MessagingConfigs"
        ],
        "summary": "Get Messaging Config",
        "parameters": [
          {
            "name": "sid",
            "in": "path",
            "description": "Messaging Config Sid.",
            "required": true,
            "schema": {
              "pattern": "^(MC)[0-9a-f]{32}$",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/MessagingConfigDetailsModel"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MessagingConfigDetailsModel"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/MessagingConfigDetailsModel"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          },
          "404": {
            "description": "Not Found",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          }
        }
      },
      "delete": {
        "tags": [
          "MessagingConfigs"
        ],
        "summary": "Delete Messaging Config",
        "description": "You could only remove a Messaging Config that does not have Phone Numbers associated with it.",
        "parameters": [
          {
            "name": "sid",
            "in": "path",
            "description": "Messaging Config Sid.",
            "required": true,
            "schema": {
              "pattern": "^(MC)[0-9a-f]{32}$",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          },
          "404": {
            "description": "Not Found",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          }
        }
      }
    },
    "/v1/MessagingConfigs/{sid}/phones": {
      "get": {
        "tags": [
          "MessagingConfigs"
        ],
        "summary": "Get Associated Phone Numbers",
        "description": "Returns the list of Phone Numbers associated with the Messaging Config.",
        "parameters": [
          {
            "name": "sid",
            "in": "path",
            "description": "Messaging Config Sid.",
            "required": true,
            "schema": {
              "pattern": "^(MC)[0-9a-f]{32}$",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/MessagingConfigPhonesResult"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MessagingConfigPhonesResult"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/MessagingConfigPhonesResult"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          },
          "404": {
            "description": "Not Found",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          }
        }
      }
    },
    "/v1/MessagingConfigs/{sid}/addPhones": {
      "patch": {
        "tags": [
          "MessagingConfigs"
        ],
        "summary": "Associate Phone Numbers",
        "description": "Associates the supplied Phone Numbers with the Messaging Config.\nIf the Messaging Config has a TCR Campaign associated with it,\nthe supplied Phone Numbers will be associated with that TCR Campaign.\nNote that it may take some time for the Phone Numbers to change\nTCR Campaign association.",
        "parameters": [
          {
            "name": "sid",
            "in": "path",
            "description": "Messaging Config Sid.",
            "required": true,
            "schema": {
              "pattern": "^(MC)[0-9a-f]{32}$",
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "description": "",
          "content": {
            "application/json-patch+json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/PhoneListRequest"
                  }
                ],
                "description": "Phone List Request."
              }
            },
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/PhoneListRequest"
                  }
                ],
                "description": "Phone List Request."
              }
            },
            "text/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/PhoneListRequest"
                  }
                ],
                "description": "Phone List Request."
              }
            },
            "application/*+json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/PhoneListRequest"
                  }
                ],
                "description": "Phone List Request."
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/PhoneNumberBulkResult"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PhoneNumberBulkResult"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/PhoneNumberBulkResult"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          },
          "404": {
            "description": "Not Found",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          }
        }
      }
    },
    "/v1/MessagingConfigs/{sid}/deletePhones": {
      "patch": {
        "tags": [
          "MessagingConfigs"
        ],
        "summary": "De-Associate Phone Numbers",
        "description": "De-associates the supplied Phone Numbers from the Messaging Config.\nIf the Messaging Config has a TCR Campaign associated with it,\nthe supplied Phone Numbers will be de-associated from that TCR Campaign.\nNote that it may take some time for the Phone Numbers to change TCR Campaign association.",
        "parameters": [
          {
            "name": "sid",
            "in": "path",
            "description": "Messaging Config Sid.",
            "required": true,
            "schema": {
              "pattern": "^(MC)[0-9a-f]{32}$",
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "description": "",
          "content": {
            "application/json-patch+json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/PhoneListRequest"
                  }
                ],
                "description": "Phone List Request."
              }
            },
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/PhoneListRequest"
                  }
                ],
                "description": "Phone List Request."
              }
            },
            "text/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/PhoneListRequest"
                  }
                ],
                "description": "Phone List Request."
              }
            },
            "application/*+json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/PhoneListRequest"
                  }
                ],
                "description": "Phone List Request."
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/PhoneNumberBulkResult"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PhoneNumberBulkResult"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/PhoneNumberBulkResult"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          },
          "404": {
            "description": "Not Found",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          }
        }
      }
    },
    "/v1/MyCompany": {
      "get": {
        "tags": [
          "MyCompany"
        ],
        "summary": "Get Company Information",
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/CompanyModel"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CompanyModel"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/CompanyModel"
                }
              }
            }
          }
        }
      }
    },
    "/v1/MyCompany/cspId": {
      "put": {
        "tags": [
          "MyCompany"
        ],
        "summary": "Set TCR CspId",
        "description": "Sets the CspId that is assigned to your Company by TCR.\nYou cannot change the CspId once at least one TCR Brand and/or Campaign is shared by you with Telgorithm.",
        "requestBody": {
          "description": "A request to set company's CspId.",
          "content": {
            "application/json-patch+json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SetCompanyCspIdRequest"
                  }
                ],
                "description": "Request to set CspId for a Company."
              }
            },
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SetCompanyCspIdRequest"
                  }
                ],
                "description": "Request to set CspId for a Company."
              }
            },
            "text/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SetCompanyCspIdRequest"
                  }
                ],
                "description": "Request to set CspId for a Company."
              }
            },
            "application/*+json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SetCompanyCspIdRequest"
                  }
                ],
                "description": "Request to set CspId for a Company."
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/CompanyModel"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CompanyModel"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/CompanyModel"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          }
        }
      }
    },
    "/v1/OptOuts": {
      "get": {
        "tags": [
          "OptOuts"
        ],
        "summary": "List Opt-Outs",
        "description": "Gets the list of all Opt-Outs that are registered for your Phone Numbers and/or TCR Campaigns.\nThis method supports pagination.",
        "parameters": [
          {
            "name": "Number",
            "in": "query",
            "description": "End-user number that opted out",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "CreatedOn",
            "in": "query",
            "description": "Created date",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "Scope",
            "in": "query",
            "description": "TollFree phone number (must start with country code e.g. +1...) or TCR Campaign Sid\nto which end-user is opted out",
            "schema": {
              "maxLength": 128,
              "type": "string"
            }
          },
          {
            "name": "PageSize",
            "in": "query",
            "schema": {
              "maximum": 10000,
              "minimum": 1,
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "OrderByDirection",
            "in": "query",
            "description": "\n<p>Possible values:</p>\n<ul>\n<li><b>Ascending</b></li>\n<li><b>Descending</b></li>\n</ul>\n",
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/OrderByDirections"
                }
              ],
              "description": "\n<p>Possible values:</p>\n<ul>\n<li><b>Ascending</b></li>\n<li><b>Descending</b></li>\n</ul>\n"
            }
          },
          {
            "name": "SearchId",
            "in": "query",
            "schema": {
              "type": "string",
              "format": "byte"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/OptOutModelPaginatedResult"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OptOutModelPaginatedResult"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/OptOutModelPaginatedResult"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          }
        }
      },
      "post": {
        "tags": [
          "OptOuts"
        ],
        "summary": "Import Opt-Outs",
        "description": "Allows to import the Opt-Outs manually, for example, during the migration from other provider.",
        "requestBody": {
          "content": {
            "application/json-patch+json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ImportOptOutsRequest"
                  }
                ],
                "description": "Import Opt-Outs Request."
              }
            },
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ImportOptOutsRequest"
                  }
                ],
                "description": "Import Opt-Outs Request."
              }
            },
            "text/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ImportOptOutsRequest"
                  }
                ],
                "description": "Import Opt-Outs Request."
              }
            },
            "application/*+json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ImportOptOutsRequest"
                  }
                ],
                "description": "Import Opt-Outs Request."
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/CreatedOptOutsModel"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreatedOptOutsModel"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreatedOptOutsModel"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          }
        }
      }
    },
    "/v1/OutboundMessages": {
      "post": {
        "tags": [
          "OutboundMessages"
        ],
        "summary": "Send Outbound Message",
        "description": "<p>\n            Submits Outbound Message for sending.\n            </p>\n<p>\n            Response status code `200` means that the Outbound Message was accepted for delivery.\n            It does not guarantee that the message will be sent right away, or ever.\n            Depending on the TCR Campaign association state, the remaining TCR limit and the Opt-Out of the recipient,\n            the message may end up queued or even discarded.\n            </p>\n<p>\n            In case `MediaUrls` array is not empty (i.e. contains at least one attachment URL)\n            and/or more than 1 recipient the message is considered MMS.\n            </p>",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/CreateOutboundMessageRequest"
                  }
                ],
                "description": "Submit Outbound Message request."
              },
              "examples": {
                "SMS": {
                  "value": {"from":"+12145678900","to":"+19876543210","recipients":null,"text":"Glad to see you!","priority":null,"mediaUrls":null,"callbackUrlOverride":null,"expiresOn":null,"conversationMetadata":null,"ignoreSendingTimes":false}
                },
                "MMS": {
                  "value": {"from":"+12145678900","to":"+19876543210","recipients":null,"text":"Glad to see you!","priority":null,"mediaUrls":["https://example.com/image.jpg"],"callbackUrlOverride":null,"expiresOn":null,"conversationMetadata":null,"ignoreSendingTimes":false}
                },
                "Group MMS": {
                  "value": {"from":"+12145678900","to":null,"recipients":["+19876543210","+12345678900"],"text":"Glad to see you!","priority":null,"mediaUrls":["https://example.com/image.jpg"],"callbackUrlOverride":null,"expiresOn":null,"conversationMetadata":null,"ignoreSendingTimes":false}
                },
                "SMS with High priority and expiration": {
                  "value": {"from":"+12145678900","to":"+19876543210","recipients":null,"text":"Glad to see you!","priority":"High","mediaUrls":null,"callbackUrlOverride":null,"expiresOn":"2022-12-31T12:34:56.0000000Z","conversationMetadata":null,"ignoreSendingTimes":false}
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/CreateOutboundMessageResult"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreateOutboundMessageResult"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreateOutboundMessageResult"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/OutboundMessageError"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OutboundMessageError"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/OutboundMessageError"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          }
        }
      },
      "get": {
        "tags": [
          "OutboundMessages"
        ],
        "summary": "List Outbound Messages",
        "description": "Gets the list of all Outbound Messages, optionally filtered by parameters.\nThis method supports pagination.",
        "parameters": [
          {
            "name": "Status",
            "in": "query",
            "description": "Outbound message status",
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/OutboundMessageStatus"
                }
              ]
            }
          },
          {
            "name": "From",
            "in": "query",
            "description": "Sender phone number",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "To",
            "in": "query",
            "description": "Recipient phone number",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "CreatedOnFrom",
            "in": "query",
            "description": "Date-time, that Outbound message creation should be greater or equal than.\n\n<b>Must have ISO format (e.g. yyyy-MM-dd'T'HH:mm:ss)</b>",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "CreatedOnTo",
            "in": "query",
            "description": "Date-time, that Outbound message creation should be less than.\n\n<b>Must have ISO format (e.g. yyyy-MM-dd'T'HH:mm:ss)</b>",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "ErrorCode",
            "in": "query",
            "description": "Outbound message error code",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "PageSize",
            "in": "query",
            "schema": {
              "maximum": 10000,
              "minimum": 1,
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "OrderByDirection",
            "in": "query",
            "description": "\n<p>Possible values:</p>\n<ul>\n<li><b>Ascending</b></li>\n<li><b>Descending</b></li>\n</ul>\n",
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/OrderByDirections"
                }
              ],
              "description": "\n<p>Possible values:</p>\n<ul>\n<li><b>Ascending</b></li>\n<li><b>Descending</b></li>\n</ul>\n"
            }
          },
          {
            "name": "SearchId",
            "in": "query",
            "schema": {
              "type": "string",
              "format": "byte"
            }
          },
          {
            "name": "IncludeFees",
            "in": "query",
            "description": "If true, fees are included into the result.",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "IncludeConversationMetadata",
            "in": "query",
            "description": "If true, conversation metadata is included into the result.",
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/OutboundMessageModelPaginatedResult"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OutboundMessageModelPaginatedResult"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/OutboundMessageModelPaginatedResult"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          }
        }
      }
    },
    "/v1/OutboundMessages/{sid}": {
      "get": {
        "tags": [
          "OutboundMessages"
        ],
        "summary": "Get Outbound Message",
        "description": "Returns the specified Outbound Message information.",
        "parameters": [
          {
            "name": "sid",
            "in": "path",
            "description": "Outbound Message Sid.",
            "required": true,
            "schema": {
              "pattern": "^(OM|RO)[0-9a-f]{48}$",
              "type": "string"
            }
          },
          {
            "name": "IncludeFees",
            "in": "query",
            "description": "If true, fees are included into the result.",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "IncludeConversationMetadata",
            "in": "query",
            "description": "If true, conversation metadata is included into the result.",
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/OutboundMessageModel"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OutboundMessageModel"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/OutboundMessageModel"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          },
          "404": {
            "description": "Not Found",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          }
        }
      }
    },
    "/v1/Phones": {
      "post": {
        "tags": [
          "Phones"
        ],
        "summary": "Order Phone Number",
        "description": "Places the order to buy the Phone Number from the list of available numbers.\nOptionally, associates Phone Number with the specified Messaging Config after order completion.",
        "requestBody": {
          "content": {
            "application/json-patch+json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/CreatePhoneRequest"
                  }
                ],
                "description": "Order Phone."
              }
            },
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/CreatePhoneRequest"
                  }
                ],
                "description": "Order Phone."
              }
            },
            "text/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/CreatePhoneRequest"
                  }
                ],
                "description": "Order Phone."
              }
            },
            "application/*+json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/CreatePhoneRequest"
                  }
                ],
                "description": "Order Phone."
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Created",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/PhoneModel"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PhoneModel"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/PhoneModel"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          },
          "409": {
            "description": "Conflict",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          }
        }
      },
      "get": {
        "tags": [
          "Phones"
        ],
        "summary": "List Own Numbers",
        "description": "Gets a list of all phone numbers owned by you.\nFor each number, its status is returned along with the identifier\nof the Messaging Config that the number is attached to.\nThis method supports pagination.",
        "parameters": [
          {
            "name": "Number",
            "in": "query",
            "description": "Search by a phone number substring.",
            "schema": {
              "maxLength": 16,
              "minLength": 3,
              "pattern": "^\\+?[0-9]+$",
              "type": "string"
            }
          },
          {
            "name": "Name",
            "in": "query",
            "description": "Search by a phone name substring.",
            "schema": {
              "maxLength": 1024,
              "minLength": 3,
              "type": "string"
            }
          },
          {
            "name": "Status",
            "in": "query",
            "description": "Phone statuses.",
            "schema": {
              "maxItems": 8,
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/DisplayPhoneStatus"
              }
            }
          },
          {
            "name": "Type",
            "in": "query",
            "description": "Phone number type.",
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/PhoneNumberType"
                }
              ]
            }
          },
          {
            "name": "MessagingConfigSid",
            "in": "query",
            "description": "Messaging Config SID.\nThis field is mutually exclusive with `OnlyWithoutMessagingConfig`.",
            "schema": {
              "pattern": "^(MC)[0-9a-f]{32}$",
              "type": "string"
            }
          },
          {
            "name": "OnlyWithoutMessagingConfig",
            "in": "query",
            "description": "If true, returns only numbers that are not assigned to any messaging config.\nThis field is mutually exclusive with `MessagingConfigSid`.",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "PageSize",
            "in": "query",
            "schema": {
              "maximum": 10000,
              "minimum": 1,
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "OrderByDirection",
            "in": "query",
            "description": "\n<p>Possible values:</p>\n<ul>\n<li><b>Ascending</b></li>\n<li><b>Descending</b></li>\n</ul>\n",
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/OrderByDirections"
                }
              ],
              "description": "\n<p>Possible values:</p>\n<ul>\n<li><b>Ascending</b></li>\n<li><b>Descending</b></li>\n</ul>\n"
            }
          },
          {
            "name": "SearchId",
            "in": "query",
            "schema": {
              "type": "string",
              "format": "byte"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/PhoneModelPaginatedResult"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PhoneModelPaginatedResult"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/PhoneModelPaginatedResult"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          }
        }
      }
    },
    "/v1/Phones/Available10DLC": {
      "get": {
        "tags": [
          "Phones"
        ],
        "summary": "Available 10DLC Numbers",
        "description": "Gets the list of 10DLC phone numbers that are available for order.",
        "parameters": [
          {
            "name": "AreaCode",
            "in": "query",
            "description": "Filter by phone number area code (NPA). If specified, no other filters must be specified except `ExchangeCode` can be specified.",
            "schema": {
              "maxLength": 3,
              "minLength": 3,
              "pattern": "^[0-9]{3}$",
              "type": "string"
            }
          },
          {
            "name": "ExchangeCode",
            "in": "query",
            "description": "Filter by phone number exchange code (central office code, or NXX). Can only be specified if `AreaCode` is specified.",
            "schema": {
              "maxLength": 3,
              "minLength": 3,
              "pattern": "^[0-9]{3}$",
              "type": "string"
            }
          },
          {
            "name": "Region.Country",
            "in": "query",
            "description": "Specifies the country to search numbers (US or CA). If omitted, US is assumed.\nNote that to search by State AND City in Canada, you must specify CA explicitly. To search by State only,\nit is not necessary (but still preferable) since Canadian provinces abbreviations don't intersect with US\nstates abbreviations.",
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/PhoneCountry"
                }
              ],
              "example": "US"
            },
            "example": "US"
          },
          {
            "name": "Region.State",
            "in": "query",
            "description": "Two-letter abbreviation of a state in USA or a province in Canada.",
            "schema": {
              "maxLength": 2,
              "minLength": 2,
              "type": "string",
              "example": "CA"
            },
            "example": "CA"
          },
          {
            "name": "Region.City",
            "in": "query",
            "description": "City name. Note that the full city name should be specified here, otherwise the search\nwill return nothing (i.e. partial name search is not supported).",
            "schema": {
              "type": "string",
              "example": "Los Angeles"
            },
            "example": "Los Angeles"
          },
          {
            "name": "Quantity",
            "in": "query",
            "description": "Number of returned phone numbers, default is 10. Must be greater than 0 and less or equal to 100.",
            "schema": {
              "maximum": 100,
              "minimum": 1,
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/Available10DlcResult"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Available10DlcResult"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/Available10DlcResult"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                }
              },
              "application/json": {
                "schema": {
                  "type": "string"
                }
              },
              "text/json": {
                "schema": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    },
    "/v1/Phones/AvailableTollFree": {
      "get": {
        "tags": [
          "Phones"
        ],
        "summary": "Available Toll-Free Numbers",
        "description": "Gets the list of Toll-Free phone numbers that are available for order.",
        "parameters": [
          {
            "name": "AreaCode",
            "in": "query",
            "description": "Phone number area code; one of 800, 833, 844, 855, 866, 877, 888.",
            "required": true,
            "schema": {
              "maxLength": 3,
              "minLength": 3,
              "pattern": "^[0-9]{3}$",
              "type": "string"
            }
          },
          {
            "name": "Quantity",
            "in": "query",
            "description": "Count of returned phone numbers, default is 10. Must be greater than 0 and less or equal to 100.",
            "schema": {
              "maximum": 100,
              "minimum": 1,
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/AvailableTollFreeResult"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AvailableTollFreeResult"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/AvailableTollFreeResult"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                }
              },
              "application/json": {
                "schema": {
                  "type": "string"
                }
              },
              "text/json": {
                "schema": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    },
    "/v1/Phones/{phone}": {
      "get": {
        "tags": [
          "Phones"
        ],
        "summary": "Get Number Info",
        "description": "Gets the information about the specified Phone Number.\nPhone Number status is returned along with the identifier of the Messaging Config that it is attached to.",
        "parameters": [
          {
            "name": "phone",
            "in": "path",
            "description": "Phone number.",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/PhoneDetailsModel"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PhoneDetailsModel"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/PhoneDetailsModel"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                }
              },
              "application/json": {
                "schema": {
                  "type": "string"
                }
              },
              "text/json": {
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          }
        }
      },
      "put": {
        "tags": [
          "Phones"
        ],
        "summary": "Update Number Options",
        "description": "Updates options for the specified Phone Number.\nUse this method to update display name and change the Messaging Config association.",
        "parameters": [
          {
            "name": "phone",
            "in": "path",
            "description": "Phone number.",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "description": "",
          "content": {
            "application/json-patch+json": {
              "schema": {
                "oneOf": [
                  {
                    "$ref": "#/components/schemas/PhoneRequest"
                  },
                  {
                    "$ref": "#/components/schemas/CreatePhoneRequest"
                  }
                ],
                "description": "Update Phone Request."
              }
            },
            "application/json": {
              "schema": {
                "oneOf": [
                  {
                    "$ref": "#/components/schemas/PhoneRequest"
                  },
                  {
                    "$ref": "#/components/schemas/CreatePhoneRequest"
                  }
                ],
                "description": "Update Phone Request."
              }
            },
            "text/json": {
              "schema": {
                "oneOf": [
                  {
                    "$ref": "#/components/schemas/PhoneRequest"
                  },
                  {
                    "$ref": "#/components/schemas/CreatePhoneRequest"
                  }
                ],
                "description": "Update Phone Request."
              }
            },
            "application/*+json": {
              "schema": {
                "oneOf": [
                  {
                    "$ref": "#/components/schemas/PhoneRequest"
                  },
                  {
                    "$ref": "#/components/schemas/CreatePhoneRequest"
                  }
                ],
                "description": "Update Phone Request."
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/PhoneModel"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PhoneModel"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/PhoneModel"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                }
              },
              "application/json": {
                "schema": {
                  "type": "string"
                }
              },
              "text/json": {
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          }
        }
      },
      "patch": {
        "tags": [
          "Phones"
        ],
        "summary": "Update Specific Number Options",
        "description": "Updates options for the specified Phone Number.\nUse this method to update display name and change the Messaging Config association.\nUpdates only the options that are passed in the request and are not `null`, does not change other values.",
        "parameters": [
          {
            "name": "phone",
            "in": "path",
            "description": "Phone number.",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "description": "",
          "content": {
            "application/json-patch+json": {
              "schema": {
                "oneOf": [
                  {
                    "$ref": "#/components/schemas/PhoneRequest"
                  },
                  {
                    "$ref": "#/components/schemas/CreatePhoneRequest"
                  }
                ],
                "description": "Update Phone Request."
              }
            },
            "application/json": {
              "schema": {
                "oneOf": [
                  {
                    "$ref": "#/components/schemas/PhoneRequest"
                  },
                  {
                    "$ref": "#/components/schemas/CreatePhoneRequest"
                  }
                ],
                "description": "Update Phone Request."
              }
            },
            "text/json": {
              "schema": {
                "oneOf": [
                  {
                    "$ref": "#/components/schemas/PhoneRequest"
                  },
                  {
                    "$ref": "#/components/schemas/CreatePhoneRequest"
                  }
                ],
                "description": "Update Phone Request."
              }
            },
            "application/*+json": {
              "schema": {
                "oneOf": [
                  {
                    "$ref": "#/components/schemas/PhoneRequest"
                  },
                  {
                    "$ref": "#/components/schemas/CreatePhoneRequest"
                  }
                ],
                "description": "Update Phone Request."
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/PhoneModel"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PhoneModel"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/PhoneModel"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                }
              },
              "application/json": {
                "schema": {
                  "type": "string"
                }
              },
              "text/json": {
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          }
        }
      },
      "delete": {
        "tags": [
          "Phones"
        ],
        "summary": "Deallocate Number",
        "description": "Suspends all messaging and voice services for the specified phone number and removes it from the account.",
        "parameters": [
          {
            "name": "phone",
            "in": "path",
            "description": "Phone number.",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                }
              },
              "application/json": {
                "schema": {
                  "type": "string"
                }
              },
              "text/json": {
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          }
        }
      }
    },
    "/v1/Phones/{phone}/voice": {
      "get": {
        "tags": [
          "Phones"
        ],
        "summary": "Get Voice Options",
        "description": "Gets Voice service options for the specified Phone Number.",
        "parameters": [
          {
            "name": "phone",
            "in": "path",
            "description": "Phone number.",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/PhoneVoiceModel"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PhoneVoiceModel"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/PhoneVoiceModel"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          },
          "404": {
            "description": "Not Found",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          }
        }
      },
      "put": {
        "tags": [
          "Phones"
        ],
        "summary": "Update Voice Options",
        "description": "Updates Voice service options for the specified Phone Number.",
        "parameters": [
          {
            "name": "phone",
            "in": "path",
            "description": "Phone number.",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "description": "",
          "content": {
            "application/json-patch+json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/PhoneVoiceRequest"
                  }
                ],
                "description": "Update voice settings request."
              }
            },
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/PhoneVoiceRequest"
                  }
                ],
                "description": "Update voice settings request."
              }
            },
            "text/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/PhoneVoiceRequest"
                  }
                ],
                "description": "Update voice settings request."
              }
            },
            "application/*+json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/PhoneVoiceRequest"
                  }
                ],
                "description": "Update voice settings request."
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/PhoneVoiceModel"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PhoneVoiceModel"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/PhoneVoiceModel"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          },
          "404": {
            "description": "Not Found",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          }
        }
      },
      "patch": {
        "tags": [
          "Phones"
        ],
        "summary": "Update Specific Voice Options",
        "description": "Updates voice service options for the specified Phone Number.\nUpdates only the options that are passed in the request and are not `null`, does not change other values.",
        "parameters": [
          {
            "name": "phone",
            "in": "path",
            "description": "Phone number.",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "description": "",
          "content": {
            "application/json-patch+json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/PhoneVoiceRequest"
                  }
                ],
                "description": "Update voice settings request."
              }
            },
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/PhoneVoiceRequest"
                  }
                ],
                "description": "Update voice settings request."
              }
            },
            "text/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/PhoneVoiceRequest"
                  }
                ],
                "description": "Update voice settings request."
              }
            },
            "application/*+json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/PhoneVoiceRequest"
                  }
                ],
                "description": "Update voice settings request."
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/PhoneVoiceModel"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PhoneVoiceModel"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/PhoneVoiceModel"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          },
          "404": {
            "description": "Not Found",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          }
        },
        "deprecated": true
      }
    },
    "/v1/Phones/port-in": {
      "post": {
        "tags": [
          "Phones"
        ],
        "summary": "Port-In Phone Numbers",
        "description": "Starts the process of porting Phone Numbers in to Telgorithm.\nOptionally, associates ported-in numbers with the specified Messaging Configs\nafter port-in completion.",
        "requestBody": {
          "content": {
            "multipart/form-data": {
              "schema": {
                "required": [
                  "Files",
                  "Data"
                ],
                "type": "object",
                "properties": {
                  "Data": {
                    "required": [
                      "features",
                      "phones"
                    ],
                    "type": "object",
                    "properties": {
                      "phones": {
                        "maxItems": 2000,
                        "minItems": 1,
                        "type": "array",
                        "items": {
                          "$ref": "#/components/schemas/PortInPhoneModel"
                        },
                        "description": "Phones collection to port in."
                      },
                      "features": {
                        "allOf": [
                          {
                            "$ref": "#/components/schemas/PortInPhoneFeatures"
                          }
                        ],
                        "description": "Sets features to port in.\n<p>Possible values:</p>\n<ul>\n<li><b>Messaging</b>: Includes only Messaging (SMS & MMS).</li>\n<li><b>Voice</b>: Includes only Voice.</li>\n<li><b>MessagingAndVoice</b>: Includes Messaging (SMS & MMS) and Voice.</li>\n</ul>\n"
                      }
                    },
                    "additionalProperties": false,
                    "description": "PortIn data model.\n See PortInPhonesModel model."
                  },
                  "Files": {
                    "minItems": 1,
                    "type": "array",
                    "items": {
                      "type": "string",
                      "format": "binary"
                    },
                    "description": "LOA Files"
                  }
                }
              },
              "encoding": {
                "Files": {
                  "style": "form"
                },
                "Data": {
                  "contentType": "application/json"
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/PortInOrderModel"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PortInOrderModel"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/PortInOrderModel"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          },
          "404": {
            "description": "Not Found",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          },
          "409": {
            "description": "Conflict",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          }
        }
      }
    },
    "/v1/Rcs/Events": {
      "post": {
        "tags": [
          "RcsEvents"
        ],
        "summary": "Submit RCS Outbound Events",
        "description": "Submits a batch of RCS outbound events for forwarding to the upstream provider.\nUp to 100 events can be submitted per request.\nThe batch is accepted for asynchronous processing.",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/CreateRcsEventsRequest"
                  }
                ],
                "description": "Submit one or more RCS outbound events in a single request (up to 100)."
              },
              "examples": {
                "Seen": {
                  "value": {"events":[{"type":"Seen","messageSid":"RIa1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3f4"}]}
                },
                "Typing indicator": {
                  "value": {"events":[{"type":"TypingIndicator","agentId":"MyAgentId","to":"+12345678901"}]}
                },
                "All": {
                  "value": {"events":[{"type":"Seen","messageSid":"RIa1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3f4"},{"type":"TypingIndicator","agentId":"MyAgentId","to":"+12345678901"}]}
                }
              }
            }
          }
        },
        "responses": {
          "202": {
            "description": "Accepted",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          }
        }
      }
    },
    "/v1/Rcs/InboundMessages": {
      "get": {
        "tags": [
          "RcsInboundMessages"
        ],
        "summary": "List RCS Inbound Messages",
        "description": "Gets the list of all RCS Inbound Messages, optionally filtered by parameters.\nThis method supports pagination.",
        "parameters": [
          {
            "name": "From",
            "in": "query",
            "description": "Sender phone number.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "AgentId",
            "in": "query",
            "description": "Recipient Agent ID (RCS identity).",
            "schema": {
              "maxLength": 40,
              "minLength": 3,
              "type": "string"
            }
          },
          {
            "name": "CreatedOnFrom",
            "in": "query",
            "description": "Date-time that RCS inbound message creation should be greater or equal than.\n\n<b>Must have ISO format (e.g. yyyy-MM-dd'T'HH:mm:ss)</b>",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "CreatedOnTo",
            "in": "query",
            "description": "Date-time that RCS inbound message creation should be less than.\n\n<b>Must have ISO format (e.g. yyyy-MM-dd'T'HH:mm:ss)</b>",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "PageSize",
            "in": "query",
            "schema": {
              "maximum": 10000,
              "minimum": 1,
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "OrderByDirection",
            "in": "query",
            "description": "\n<p>Possible values:</p>\n<ul>\n<li><b>Ascending</b></li>\n<li><b>Descending</b></li>\n</ul>\n",
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/OrderByDirections"
                }
              ],
              "description": "\n<p>Possible values:</p>\n<ul>\n<li><b>Ascending</b></li>\n<li><b>Descending</b></li>\n</ul>\n"
            }
          },
          {
            "name": "SearchId",
            "in": "query",
            "schema": {
              "type": "string",
              "format": "byte"
            }
          },
          {
            "name": "IncludeFees",
            "in": "query",
            "description": "If true, fees are included into the result.",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "IncludeContent",
            "in": "query",
            "description": "If true, RCS message content is included into the result.",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "IncludeConversationMetadata",
            "in": "query",
            "description": "If true, conversation metadata is included into the result.",
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/RcsInboundMessageModelPaginatedResult"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RcsInboundMessageModelPaginatedResult"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/RcsInboundMessageModelPaginatedResult"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          }
        }
      }
    },
    "/v1/Rcs/InboundMessages/{sid}": {
      "get": {
        "tags": [
          "RcsInboundMessages"
        ],
        "summary": "Get RCS Inbound Message",
        "description": "Returns the specified RCS Inbound Message information.",
        "parameters": [
          {
            "name": "sid",
            "in": "path",
            "required": true,
            "schema": {
              "pattern": "^(RI)[0-9a-f]{48}$",
              "type": "string"
            }
          },
          {
            "name": "IncludeFees",
            "in": "query",
            "description": "If true, fees are included into the result.",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "IncludeContent",
            "in": "query",
            "description": "If true, RCS message content is included into the result.",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "IncludeConversationMetadata",
            "in": "query",
            "description": "If true, conversation metadata is included into the result.",
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/RcsInboundMessageModel"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RcsInboundMessageModel"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/RcsInboundMessageModel"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          },
          "404": {
            "description": "Not Found",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          }
        }
      }
    },
    "/v1/Rcs/OutboundMessages": {
      "post": {
        "tags": [
          "RcsOutboundMessages"
        ],
        "summary": "Send RCS Outbound Messages",
        "description": "Submits one or more RCS Outbound Messages for sending.\nUp to 100 messages can be submitted per request.",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/CreateRcsOutboundMessagesRequest"
                  }
                ],
                "description": "Submit one or more RCS messages in a single request (up to Telgorithm.Phone.Api.Contracts.Rcs.CreateRcsOutboundMessagesRequest.MaxMessages)."
              },
              "examples": {
                "Text": {
                  "value": {"messages":[{"agentId":"TestAgent","to":"+19876543210","content":{"type":"Text","text":"Hello from RCS!","file":null,"cards":null,"suggestions":null,"orientation":null,"alignment":null,"cardWidth":null},"fallback":null,"callbackUrlOverride":null,"conversationMetadata":null}]}
                },
                "File": {
                  "value": {"messages":[{"agentId":"TestAgent","to":"+19876543210","content":{"type":"File","text":null,"file":{"url":"https://example.com/image.jpg","thumbnail":null},"cards":null,"suggestions":null,"orientation":null,"alignment":null,"cardWidth":null},"fallback":null,"callbackUrlOverride":null,"conversationMetadata":null}]}
                },
                "Card": {
                  "value": {"messages":[{"agentId":"TestAgent","to":"+19876543210","content":{"type":"Card","text":null,"file":null,"cards":[{"title":"Welcome!","description":"Check out our latest offer.","media":{"file":{"url":"https://example.com/banner.jpg","thumbnail":null},"mediaHeight":"Medium"},"suggestions":[{"type":"Reply","text":"Learn more","postbackData":"learn_more","url":null,"phoneNumber":null,"latitude":null,"longitude":null,"label":null,"startTime":null,"endTime":null,"title":null,"description":null,"application":null,"webviewViewMode":null}]}],"suggestions":null,"orientation":"Vertical","alignment":"Left","cardWidth":null},"fallback":null,"callbackUrlOverride":null,"conversationMetadata":null}]}
                },
                "Text with Fallback": {
                  "value": {"messages":[{"agentId":"TestAgent","to":"+19876543210","content":{"type":"Text","text":"Hello from RCS!","file":null,"cards":null,"suggestions":null,"orientation":null,"alignment":null,"cardWidth":null},"fallback":{"from":"+12145678900","text":"Hello! (SMS fallback)","priority":null,"mediaUrls":null,"callbackUrlOverride":null,"expiresOn":null,"conversationMetadata":null,"ignoreSendingTimes":null},"callbackUrlOverride":null,"conversationMetadata":null}]}
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/CreateRcsOutboundMessagesResult"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreateRcsOutboundMessagesResult"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreateRcsOutboundMessagesResult"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"Error title","detail":"Error detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          }
        }
      },
      "get": {
        "tags": [
          "RcsOutboundMessages"
        ],
        "summary": "List RCS Outbound Messages",
        "description": "Gets the list of all RCS Outbound Messages, optionally filtered by parameters.\nThis method supports pagination.",
        "parameters": [
          {
            "name": "Status",
            "in": "query",
            "description": "RCS outbound message status.",
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/RcsOutboundMessageStatus"
                }
              ]
            }
          },
          {
            "name": "AgentId",
            "in": "query",
            "description": "Sender Agent ID (RCS identity).",
            "schema": {
              "maxLength": 40,
              "minLength": 3,
              "type": "string"
            }
          },
          {
            "name": "To",
            "in": "query",
            "description": "Recipient phone number.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "CreatedOnFrom",
            "in": "query",
            "description": "Date-time that RCS outbound message creation should be greater or equal than.\n\n<b>Must have ISO format (e.g. yyyy-MM-dd'T'HH:mm:ss)</b>",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "CreatedOnTo",
            "in": "query",
            "description": "Date-time that RCS outbound message creation should be less than.\n\n<b>Must have ISO format (e.g. yyyy-MM-dd'T'HH:mm:ss)</b>",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "PageSize",
            "in": "query",
            "schema": {
              "maximum": 10000,
              "minimum": 1,
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "OrderByDirection",
            "in": "query",
            "description": "\n<p>Possible values:</p>\n<ul>\n<li><b>Ascending</b></li>\n<li><b>Descending</b></li>\n</ul>\n",
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/OrderByDirections"
                }
              ],
              "description": "\n<p>Possible values:</p>\n<ul>\n<li><b>Ascending</b></li>\n<li><b>Descending</b></li>\n</ul>\n"
            }
          },
          {
            "name": "SearchId",
            "in": "query",
            "schema": {
              "type": "string",
              "format": "byte"
            }
          },
          {
            "name": "IncludeFees",
            "in": "query",
            "description": "If true, fees are included into the result.",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "IncludeContent",
            "in": "query",
            "description": "If true, RCS message content is included into the result.",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "IncludeConversationMetadata",
            "in": "query",
            "description": "If true, conversation metadata is included into the result.",
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/RcsOutboundMessageModelPaginatedResult"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RcsOutboundMessageModelPaginatedResult"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/RcsOutboundMessageModelPaginatedResult"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          }
        }
      }
    },
    "/v1/Rcs/OutboundMessages/{sid}": {
      "get": {
        "tags": [
          "RcsOutboundMessages"
        ],
        "summary": "Get RCS Outbound Message",
        "description": "Returns the specified RCS Outbound Message information.",
        "parameters": [
          {
            "name": "sid",
            "in": "path",
            "required": true,
            "schema": {
              "pattern": "^(OM|RO)[0-9a-f]{48}$",
              "type": "string"
            }
          },
          {
            "name": "IncludeFees",
            "in": "query",
            "description": "If true, fees are included into the result.",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "IncludeContent",
            "in": "query",
            "description": "If true, RCS message content is included into the result.",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "IncludeConversationMetadata",
            "in": "query",
            "description": "If true, conversation metadata is included into the result.",
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/RcsOutboundMessageModel"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RcsOutboundMessageModel"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/RcsOutboundMessageModel"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          },
          "404": {
            "description": "Not Found",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          }
        }
      }
    },
    "/v1/Static/TimeZones": {
      "get": {
        "tags": [
          "Static"
        ],
        "summary": "List Time Zones",
        "description": "Provides the list of Time Zones that are supported for Messaging Config Sending Times (Time Routing).",
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/TimeZonesModel"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TimeZonesModel"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/TimeZonesModel"
                }
              }
            }
          }
        }
      }
    },
    "/v1/Static/DefaultOptInOutSettings": {
      "get": {
        "tags": [
          "Static"
        ],
        "summary": "Opt-In/Out-Out Settings Defaults",
        "description": "Provides the defaults for the subscriber opt-in/opt-out/help settings. Keywords listed here are\nalways used even if they are not defined in a TCR Campaign and/or a Messaging Config. Messages are used\nin case they are not defined in those entities.",
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/OptInOutSettingsModel"
                    },
                    {
                      "$ref": "#/components/schemas/MessagingConfigOptInOutSettingsModel"
                    }
                  ],
                  "description": "Settings for the subscriber's opt-in/opt-out/help processes."
                }
              },
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/OptInOutSettingsModel"
                    },
                    {
                      "$ref": "#/components/schemas/MessagingConfigOptInOutSettingsModel"
                    }
                  ],
                  "description": "Settings for the subscriber's opt-in/opt-out/help processes."
                }
              },
              "text/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/OptInOutSettingsModel"
                    },
                    {
                      "$ref": "#/components/schemas/MessagingConfigOptInOutSettingsModel"
                    }
                  ],
                  "description": "Settings for the subscriber's opt-in/opt-out/help processes."
                }
              }
            }
          }
        }
      }
    },
    "/v1/TcrBrands": {
      "get": {
        "tags": [
          "TcrBrands"
        ],
        "summary": "List TCR Brands",
        "description": "Gets the list of all TCR Brands. This method supports pagination.",
        "parameters": [
          {
            "name": "PageSize",
            "in": "query",
            "schema": {
              "maximum": 10000,
              "minimum": 1,
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "OrderByDirection",
            "in": "query",
            "description": "\n<p>Possible values:</p>\n<ul>\n<li><b>Ascending</b></li>\n<li><b>Descending</b></li>\n</ul>\n",
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/OrderByDirections"
                }
              ],
              "description": "\n<p>Possible values:</p>\n<ul>\n<li><b>Ascending</b></li>\n<li><b>Descending</b></li>\n</ul>\n"
            }
          },
          {
            "name": "SearchId",
            "in": "query",
            "schema": {
              "type": "string",
              "format": "byte"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/BrandModelPaginatedResult"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BrandModelPaginatedResult"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/BrandModelPaginatedResult"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          }
        }
      }
    },
    "/v1/TcrBrands/{tcrBrandId}": {
      "get": {
        "tags": [
          "TcrBrands"
        ],
        "summary": "Get TCR Brand",
        "description": "Returns the specified TCR Brand information.",
        "parameters": [
          {
            "name": "tcrBrandId",
            "in": "path",
            "description": "TCR Brand ID.",
            "required": true,
            "schema": {
              "pattern": "^B[0-9A-Z]{6,127}$",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/BrandModel"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BrandModel"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/BrandModel"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          },
          "404": {
            "description": "Not Found",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          }
        }
      },
      "put": {
        "tags": [
          "TcrBrands"
        ],
        "summary": "Update TCR Brand Options",
        "description": "Updates options for the specified TCR Brand.",
        "parameters": [
          {
            "name": "tcrBrandId",
            "in": "path",
            "description": "TCR Brand ID.",
            "required": true,
            "schema": {
              "pattern": "^B[0-9A-Z]{6,127}$",
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "description": "",
          "content": {
            "application/json-patch+json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/BrandRequest"
                  }
                ],
                "description": "Brand request."
              }
            },
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/BrandRequest"
                  }
                ],
                "description": "Brand request."
              }
            },
            "text/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/BrandRequest"
                  }
                ],
                "description": "Brand request."
              }
            },
            "application/*+json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/BrandRequest"
                  }
                ],
                "description": "Brand request."
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/BrandModel"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BrandModel"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/BrandModel"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          },
          "404": {
            "description": "Not Found",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          }
        }
      }
    },
    "/v1/TcrCampaigns": {
      "get": {
        "tags": [
          "TcrCampaigns"
        ],
        "summary": "List TCR Campaigns",
        "description": "Gets the list of all TCR Campaigns, optionally filtered by parameters.\nThis method supports pagination.",
        "parameters": [
          {
            "name": "TcrBrandSid",
            "in": "query",
            "description": "TCR Brand ID.",
            "schema": {
              "pattern": "^B[0-9A-Z]{6,127}$",
              "type": "string"
            }
          },
          {
            "name": "PageSize",
            "in": "query",
            "schema": {
              "maximum": 10000,
              "minimum": 1,
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "OrderByDirection",
            "in": "query",
            "description": "\n<p>Possible values:</p>\n<ul>\n<li><b>Ascending</b></li>\n<li><b>Descending</b></li>\n</ul>\n",
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/OrderByDirections"
                }
              ],
              "description": "\n<p>Possible values:</p>\n<ul>\n<li><b>Ascending</b></li>\n<li><b>Descending</b></li>\n</ul>\n"
            }
          },
          {
            "name": "SearchId",
            "in": "query",
            "schema": {
              "type": "string",
              "format": "byte"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/CampaignModelPaginatedResult"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CampaignModelPaginatedResult"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/CampaignModelPaginatedResult"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          }
        }
      }
    },
    "/v1/TcrCampaigns/{tcrCampaignId}": {
      "get": {
        "tags": [
          "TcrCampaigns"
        ],
        "summary": "Get TCR Campaign",
        "description": "Returns the specified TCR Campaign information.",
        "parameters": [
          {
            "name": "tcrCampaignId",
            "in": "path",
            "description": "TCR Campaign ID.",
            "required": true,
            "schema": {
              "pattern": "^C[0-9A-Z]{6,127}$",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/CampaignModel"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CampaignModel"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/CampaignModel"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          },
          "404": {
            "description": "Not Found",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          }
        }
      },
      "put": {
        "tags": [
          "TcrCampaigns"
        ],
        "summary": "Update TCR Campaign Options",
        "description": "Use this method to change the Messaging Config that is associated with the TCR Campaign.\nPlease keep in mind that it may take some time for the Phone Numbers to change the TCR Campaign association.",
        "parameters": [
          {
            "name": "tcrCampaignId",
            "in": "path",
            "description": "TCR Campaign ID.",
            "required": true,
            "schema": {
              "pattern": "^C[0-9A-Z]{6,127}$",
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "description": "",
          "content": {
            "application/json-patch+json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/CampaignRequest"
                  }
                ],
                "description": "Campaign request."
              }
            },
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/CampaignRequest"
                  }
                ],
                "description": "Campaign request."
              }
            },
            "text/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/CampaignRequest"
                  }
                ],
                "description": "Campaign request."
              }
            },
            "application/*+json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/CampaignRequest"
                  }
                ],
                "description": "Campaign request."
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/CampaignModel"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CampaignModel"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/CampaignModel"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          },
          "404": {
            "description": "Not Found",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          }
        }
      },
      "patch": {
        "tags": [
          "TcrCampaigns"
        ],
        "summary": "Update Specific TCR Campaign Options",
        "description": "Updates only the options that are passed in the request and are not `null`, does not change other values.\nUse this method to change the Messaging Config that is associated with the TCR Campaign.\nPlease keep in mind that it may take some time for the Phone Numbers to change the TCR Campaign association.",
        "parameters": [
          {
            "name": "tcrCampaignId",
            "in": "path",
            "required": true,
            "schema": {
              "pattern": "^C[0-9A-Z]{6,127}$",
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json-patch+json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/CampaignPatchRequest"
                  }
                ],
                "description": "Campaign Patch Request."
              }
            },
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/CampaignPatchRequest"
                  }
                ],
                "description": "Campaign Patch Request."
              }
            },
            "text/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/CampaignPatchRequest"
                  }
                ],
                "description": "Campaign Patch Request."
              }
            },
            "application/*+json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/CampaignPatchRequest"
                  }
                ],
                "description": "Campaign Patch Request."
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/CampaignModel"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CampaignModel"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/CampaignModel"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          },
          "404": {
            "description": "Not Found",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          }
        }
      }
    },
    "/v1/TcrCampaigns/{tcrCampaignId}/resubmit": {
      "post": {
        "tags": [
          "TcrCampaigns"
        ],
        "summary": "Resubmit TCR Campaign for Review",
        "description": "Resubmits TCR Campaign with the specified ID for the review after\nit has been declined and inconsistencies have been corrected.",
        "parameters": [
          {
            "name": "tcrCampaignId",
            "in": "path",
            "description": "TCR Campaign ID.",
            "required": true,
            "schema": {
              "pattern": "^C[0-9A-Z]{6,127}$",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          },
          "404": {
            "description": "Not Found",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          }
        }
      }
    },
    "/v1/TcrCampaigns/{tcrCampaignId}/tmpDetails": {
      "get": {
        "tags": [
          "TcrCampaigns"
        ],
        "summary": "Get TCR Campaign Deployment Info",
        "description": "This endpoint is temporary and may be removed at any time without prior notification.",
        "parameters": [
          {
            "name": "tcrCampaignId",
            "in": "path",
            "required": true,
            "schema": {
              "pattern": "^C[0-9A-Z]{6,127}$",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/CampaignTmpDetails"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CampaignTmpDetails"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/CampaignTmpDetails"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          },
          "404": {
            "description": "Not Found",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {"type":"https://tools.ietf.org/html/rfc7231#section-6.5.4","title":"Not found","status":404,"detail":"Not found detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          }
        },
        "deprecated": true
      }
    },
    "/v1/TimeZones": {
      "get": {
        "tags": [
          "TimeZones"
        ],
        "summary": "List Time Zones",
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/TimeZonesModel"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TimeZonesModel"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/TimeZonesModel"
                }
              }
            }
          }
        },
        "deprecated": true
      }
    },
    "/v1/Webhooks/history/{sid}": {
      "get": {
        "tags": [
          "Webhooks"
        ],
        "summary": "Get Webhook Info",
        "parameters": [
          {
            "name": "sid",
            "in": "path",
            "description": "Webhook SID",
            "required": true,
            "schema": {
              "pattern": "^(WH)[0-9a-f]{48}$",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookModelPaginatedResult"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookModelPaginatedResult"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookModelPaginatedResult"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          }
        }
      }
    },
    "/v1/Webhooks/history": {
      "get": {
        "tags": [
          "Webhooks"
        ],
        "summary": "List Webhooks",
        "parameters": [
          {
            "name": "EntitySid",
            "in": "query",
            "description": "SID of an associated entity.\nFor example IM SID for inbound message webhooks.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Type",
            "in": "query",
            "description": "Webhook type.",
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/WebhookType"
                }
              ]
            }
          },
          {
            "name": "Status",
            "in": "query",
            "description": "Webhook status.",
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/WebhookStatus"
                }
              ]
            }
          },
          {
            "name": "CreatedOnFrom",
            "in": "query",
            "description": "Minimal date and time when webhook was created.",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "CreatedOnTo",
            "in": "query",
            "description": "Maximal date and time when webhook was created.",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "LastAttemptOnFrom",
            "in": "query",
            "description": "Minimal date and time when last attempt to process webhook has occurred.",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "LastAttemptOnTo",
            "in": "query",
            "description": "Maximal date and time when last attempt to process webhook has occurred.",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "PageSize",
            "in": "query",
            "schema": {
              "maximum": 10000,
              "minimum": 1,
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "OrderByDirection",
            "in": "query",
            "description": "\n<p>Possible values:</p>\n<ul>\n<li><b>Ascending</b></li>\n<li><b>Descending</b></li>\n</ul>\n",
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/OrderByDirections"
                }
              ],
              "description": "\n<p>Possible values:</p>\n<ul>\n<li><b>Ascending</b></li>\n<li><b>Descending</b></li>\n</ul>\n"
            }
          },
          {
            "name": "SearchId",
            "in": "query",
            "schema": {
              "type": "string",
              "format": "byte"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookModelPaginatedResult"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookModelPaginatedResult"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookModelPaginatedResult"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          }
        }
      }
    },
    "/v1/Webhooks": {
      "get": {
        "tags": [
          "Webhooks"
        ],
        "summary": "List Webhook Subscriptions",
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookSubscriptionListModel"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookSubscriptionListModel"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookSubscriptionListModel"
                }
              }
            }
          }
        }
      }
    },
    "/v1/Webhooks/{Type}": {
      "get": {
        "tags": [
          "Webhooks"
        ],
        "summary": "Get Webhook Subscriptions by Event Type",
        "parameters": [
          {
            "name": "Type",
            "in": "path",
            "description": "Specifies the type of the webhook.",
            "required": true,
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/WebhookSubscriptionType"
                }
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookSubscriptionListModel"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookSubscriptionListModel"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookSubscriptionListModel"
                }
              }
            }
          }
        }
      },
      "put": {
        "tags": [
          "Webhooks"
        ],
        "summary": "Subscribe to Webhook",
        "description": "Enables Webhook Subscription for a particular Event Type.",
        "parameters": [
          {
            "name": "Type",
            "in": "path",
            "description": "Specifies the type of the webhook.",
            "required": true,
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/WebhookSubscriptionType"
                }
              ]
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json-patch+json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/WebhookSubscriptionRequest"
                  }
                ],
                "description": "Webhook model."
              }
            },
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/WebhookSubscriptionRequest"
                  }
                ],
                "description": "Webhook model."
              }
            },
            "text/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/WebhookSubscriptionRequest"
                  }
                ],
                "description": "Webhook model."
              }
            },
            "application/*+json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/WebhookSubscriptionRequest"
                  }
                ],
                "description": "Webhook model."
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookSubscriptionModel"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookSubscriptionModel"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookSubscriptionModel"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          }
        }
      },
      "delete": {
        "tags": [
          "Webhooks"
        ],
        "summary": "Unsubscribe from Webhook",
        "description": "Disables webhooks for a particular Event Type",
        "parameters": [
          {
            "name": "Type",
            "in": "path",
            "description": "Specifies the type of the webhook.",
            "required": true,
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/WebhookSubscriptionType"
                }
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookUnsubscriptionResultModel"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookUnsubscriptionResultModel"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookUnsubscriptionResultModel"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationProblemDetails"
                },
                "example": {"errors":{"Name":["The Name field is required."]},"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"detail":"Some detailed message","traceId":"|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}
              }
            }
          }
        }
      }
    },
    "/v1/Webhooks/types": {
      "get": {
        "tags": [
          "Webhooks"
        ],
        "summary": "List Webhook Event Types",
        "description": "Returns the list of all supported Webhook Event Types.",
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Request-Id": {
                "description": "Correlation ID for the request",
                "schema": {
                  "type": "string",
                  "description": "Correlation ID for the request"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookTypesResponseModel"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookTypesResponseModel"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookTypesResponseModel"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "AttMessageClass": {
        "enum": [
          "A",
          "B",
          "C",
          "D",
          "E",
          "F",
          "G",
          "K",
          "N",
          "P",
          "S",
          "T",
          "W",
          "X",
          "Y",
          "Z"
        ],
        "type": "string",
        "description": "\n<p>Possible values:</p>\n<ul>\n<li><b>A</b></li>\n<li><b>B</b></li>\n<li><b>C</b></li>\n<li><b>D</b></li>\n<li><b>E</b></li>\n<li><b>F</b></li>\n<li><b>G</b></li>\n<li><b>K</b></li>\n<li><b>N</b></li>\n<li><b>P</b></li>\n<li><b>S</b></li>\n<li><b>T</b></li>\n<li><b>W</b></li>\n<li><b>X</b></li>\n<li><b>Y</b></li>\n<li><b>Z</b></li>\n</ul>\n"
      },
      "Available10DlcPhoneModel": {
        "required": [
          "city",
          "features",
          "number",
          "state",
          "supportedServices"
        ],
        "type": "object",
        "properties": {
          "number": {
            "type": "string",
            "description": "Phone Number.",
            "example": "+10123456789"
          },
          "city": {
            "minLength": 1,
            "type": "string",
            "description": "City.",
            "example": "Los Angeles"
          },
          "state": {
            "maxLength": 2,
            "minLength": 1,
            "type": "string",
            "description": "State.",
            "example": "CA"
          },
          "supportedServices": {
            "minLength": 1,
            "type": "string",
            "description": "SMS, MMS, SMSMMS.",
            "example": "SMSMMS",
            "deprecated": true
          },
          "features": {
            "allOf": [
              {
                "$ref": "#/components/schemas/PhoneFeatures"
              }
            ],
            "description": "Specifies a set of features supported by the phone.\nThis should be one of or combination of \"SMS\", \"MMS\" and \"VOICE\" divided by a comma.\n<p>Possible values:</p>\n<ul>\n<li><b>None</b>: None.</li>\n<li><b>SMS</b></li>\n<li><b>MMS</b></li>\n<li><b>VOICE</b></li>\n</ul>\n",
            "example": "SMS, MMS"
          }
        },
        "additionalProperties": false,
        "description": "Available 10DLC phone."
      },
      "Available10DlcResult": {
        "type": "object",
        "properties": {
          "phones": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Available10DlcPhoneModel"
            },
            "description": "Available 10DLC phones."
          }
        },
        "additionalProperties": false,
        "description": "Available 10DLC Result."
      },
      "AvailableTollFreeModel": {
        "required": [
          "country",
          "features",
          "number",
          "supportedServices"
        ],
        "type": "object",
        "properties": {
          "number": {
            "type": "string",
            "description": "Phone Number.",
            "example": "+18001234567"
          },
          "country": {
            "maxLength": 2,
            "minLength": 1,
            "type": "string",
            "description": "USA or Canada.",
            "example": "US"
          },
          "supportedServices": {
            "minLength": 1,
            "type": "string",
            "description": "SMSMMS.",
            "example": "SMSMMS",
            "deprecated": true
          },
          "features": {
            "allOf": [
              {
                "$ref": "#/components/schemas/PhoneFeatures"
              }
            ],
            "description": "Specifies a set of features supported by the phone.\nThis should be one of or combination of \"SMS\", \"MMS\" and \"VOICE\" divided by a comma.\n<p>Possible values:</p>\n<ul>\n<li><b>None</b>: None.</li>\n<li><b>SMS</b></li>\n<li><b>MMS</b></li>\n<li><b>VOICE</b></li>\n</ul>\n",
            "example": "SMS, MMS"
          }
        },
        "additionalProperties": false,
        "description": "Available toll free phone."
      },
      "AvailableTollFreeResult": {
        "type": "object",
        "properties": {
          "phones": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AvailableTollFreeModel"
            },
            "description": "Available Toll-Free phones."
          }
        },
        "additionalProperties": false,
        "description": "Available Toll-Free Result."
      },
      "BrandModel": {
        "required": [
          "tcrBrandId"
        ],
        "type": "object",
        "properties": {
          "tcrBrandId": {
            "minLength": 1,
            "type": "string",
            "description": "TCR Brand ID.",
            "example": "B123ABC"
          },
          "name": {
            "maxLength": 1024,
            "type": "string",
            "description": "Telgorithm-only custom brand label used in the portal UI.\nEditable via Telgorithm API; not sent to or used by TCR or other external services.",
            "nullable": true,
            "example": "My Best Company"
          },
          "legalName": {
            "maxLength": 255,
            "type": "string",
            "description": "Official legal company name registered in TCR.\nRead-only in Telgorithm and synchronized from TCR.",
            "nullable": true,
            "example": "Best Company Inc"
          },
          "displayName": {
            "maxLength": 255,
            "type": "string",
            "description": "Public-facing brand/trade name (marketing name) in TCR.\nRead-only in Telgorithm and synchronized from TCR; may differ from LegalName.",
            "nullable": true,
            "example": "Best Company"
          }
        },
        "additionalProperties": false,
        "description": "Brand model."
      },
      "BrandModelPaginatedResult": {
        "required": [
          "items"
        ],
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BrandModel"
            }
          },
          "searchId": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "BrandRequest": {
        "required": [
          "name"
        ],
        "type": "object",
        "properties": {
          "name": {
            "minLength": 1,
            "type": "string",
            "description": "TCR Brand Name. Should be legal company name exactly as shown in TCR.",
            "example": "My Best Company Inc"
          }
        },
        "additionalProperties": false,
        "description": "Brand request."
      },
      "CallDetailedModel": {
        "type": "object",
        "allOf": [
          {
            "$ref": "#/components/schemas/CallModel"
          }
        ],
        "properties": {
          "callLegs": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CallLegModel"
            },
            "description": "Legs of the Call."
          },
          "recordings": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CallRecordingsModel"
              }
            ],
            "description": "Provides information about call recordings and their status.\nIf the call wasn't recorded, this field is always `null`.",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Call Details."
      },
      "CallDirection": {
        "enum": [
          "Inbound",
          "Outbound"
        ],
        "type": "string",
        "description": "\n<p>Possible values:</p>\n<ul>\n<li><b>Inbound</b></li>\n<li><b>Outbound</b></li>\n</ul>\n"
      },
      "CallLegModel": {
        "type": "object",
        "properties": {
          "sid": {
            "maxLength": 128,
            "type": "string",
            "description": "Call Leg unique identifier."
          },
          "callSid": {
            "maxLength": 128,
            "type": "string",
            "description": "Owning Call unique identifier. This value is shared by all Call Legs of the Call."
          },
          "from": {
            "maxLength": 256,
            "type": "string",
            "description": "The originating (caller) Phone Number or SIP URI of the Call Leg.\n\n\nFor `Inbound` Call Legs it represents an external party.\n\n\nFor `Outbound` Call Legs it represents the Phone Number, which belongs to your Telgorithm account.",
            "example": "+12145678900"
          },
          "to": {
            "maxLength": 256,
            "type": "string",
            "description": "The terminating (callee) Phone Number or SIP URI of the Call Leg.\n\n\nFor `Inbound` Call Legs it represents the Phone Number, which belongs to your Telgorithm account.\n\n\nFor `Outbound` Call Legs it represents an external party.",
            "example": "+19876543210"
          },
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CallLegStatus"
              }
            ],
            "description": "Current Call Leg status.\n<p>Possible values:</p>\n<ul>\n<li><b>Ringing</b>: The call leg is ringing, not connected to the called party yet.</li>\n<li><b>Answered</b>: The call leg is answered by the called party. Both parties are connected.</li>\n<li><b>Completed</b>: The call leg is hang up.</li>\n</ul>\n"
          },
          "direction": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CallDirection"
              }
            ],
            "description": "Call Leg direction.\n<p>Possible values:</p>\n<ul>\n<li><b>Inbound</b></li>\n<li><b>Outbound</b></li>\n</ul>\n"
          },
          "duration": {
            "type": "string",
            "description": "Leg duration. This value is provided only if `Status` is `Completed`.",
            "format": "date-span",
            "nullable": true
          },
          "createdOn": {
            "type": "string",
            "description": "Creation timestamp.",
            "format": "date-time"
          },
          "rangOn": {
            "type": "string",
            "description": "Call Leg Ringing event timestamp.",
            "format": "date-time",
            "nullable": true
          },
          "answeredOn": {
            "type": "string",
            "description": "Call Leg Answered event timestamp.",
            "format": "date-time",
            "nullable": true
          },
          "completedOn": {
            "type": "string",
            "description": "Call Leg Completed event timestamp.",
            "format": "date-time",
            "nullable": true
          },
          "fees": {
            "type": "array",
            "items": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/FeeGroupModel"
                },
                {
                  "$ref": "#/components/schemas/SegmentsGroupModel"
                }
              ],
              "description": "Group of units billed under the same price tier."
            },
            "description": "Processing fees for this Call Leg.\nThis is `null` unless `includeFees` parameter is specified in the request.",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Call Leg."
      },
      "CallLegModelPaginatedResult": {
        "required": [
          "items"
        ],
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CallLegModel"
            }
          },
          "searchId": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "CallLegStatus": {
        "enum": [
          "Ringing",
          "Answered",
          "Completed"
        ],
        "type": "string",
        "description": "\n<p>Possible values:</p>\n<ul>\n<li><b>Ringing</b>: The call leg is ringing, not connected to the called party yet.</li>\n<li><b>Answered</b>: The call leg is answered by the called party. Both parties are connected.</li>\n<li><b>Completed</b>: The call leg is hang up.</li>\n</ul>\n"
      },
      "CallModel": {
        "type": "object",
        "properties": {
          "sid": {
            "maxLength": 128,
            "type": "string",
            "description": "Call unique identifier."
          },
          "internalNumber": {
            "maxLength": 16,
            "type": "string",
            "description": "The Phone Number which belongs to your Telgorithm account and which was the originating (caller)\nor terminating (callee) party of the Call, depending on the `Direction`.",
            "example": "+12145678900"
          },
          "externalNumber": {
            "maxLength": 256,
            "type": "string",
            "description": "The external Phone Number or SIP URI which was the originating (caller) or terminating (callee) party\nof the Call, depending on the `Direction`.",
            "example": "+19876543210"
          },
          "direction": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CallDirection"
              }
            ],
            "description": "Call direction.\n\n\nIf it is `Inbound`, the call is made from `ExternalNumber` to `InternalNumber`.\n\n\nIf it is `Outbound`, the call is made from `InternalNumber` to `ExternalNumber`.\n<p>Possible values:</p>\n<ul>\n<li><b>Inbound</b></li>\n<li><b>Outbound</b></li>\n</ul>\n"
          },
          "createdOn": {
            "type": "string",
            "description": "Creation timestamp.",
            "format": "date-time"
          },
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CallStatus"
              }
            ],
            "description": "Call status.\n<p>Possible values:</p>\n<ul>\n<li><b>Created</b>: The Call has been created but does not yet contain any Legs. This state may appear briefly right after initiating the call via POST to /v1/Voice/Calls, and before the first Leg is established - meaning the Call has not actually started yet.</li>\n<li><b>InProgress</b>: The Call is in progress, i.e. it has uncompleted Legs.</li>\n<li><b>Completed</b>: All Legs of the Call are completed (hung up).</li>\n</ul>\n"
          },
          "startedOn": {
            "type": "string",
            "description": "The time when the first leg was rung.",
            "format": "date-time",
            "nullable": true
          },
          "completedOn": {
            "type": "string",
            "description": "The time when the last leg was completed.",
            "format": "date-time",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Call."
      },
      "CallModelPaginatedResult": {
        "required": [
          "items"
        ],
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/CallModel"
                },
                {
                  "$ref": "#/components/schemas/CallDetailedModel"
                }
              ],
              "description": "Call."
            }
          },
          "searchId": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "CallRecordingControlAction": {
        "enum": [
          "Pause",
          "Resume"
        ],
        "type": "string",
        "description": "Call Recording control action\n<p>Possible values:</p>\n<ul>\n<li><b>Pause</b>: Pauses the recording</li>\n<li><b>Resume</b>: Starts the recording if it was paused earlier or the call wasn't recorded from the beginning</li>\n</ul>\n"
      },
      "CallRecordingControlRequest": {
        "type": "object",
        "properties": {
          "action": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CallRecordingControlAction"
              }
            ],
            "description": "The action to take over Call Recording.\n<p>Possible values:</p>\n<ul>\n<li><b>Pause</b>: Pauses the recording</li>\n<li><b>Resume</b>: Starts the recording if it was paused earlier or the call wasn't recorded from the beginning</li>\n</ul>\n"
          }
        },
        "additionalProperties": false,
        "description": "Call Recording Control Request."
      },
      "CallRecordingControlResponse": {
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CallRecordingsStatus"
              }
            ],
            "description": "Indicates the overall progression of the call recordings.\n<p>Possible values:</p>\n<ul>\n<li><b>Recording</b>: The call is being recorded at the moment. Recording data is not available yet.</li>\n<li><b>Paused</b>: The call recording is paused at the moment. Recording data is not available yet.</li>\n<li><b>Processing</b>: The call was completed, and the recording data is being prepared for download.</li>\n<li><b>Completed</b>: The call and recording have been completed, and the recording data is available for download.</li>\n</ul>\n"
          }
        },
        "additionalProperties": false,
        "description": "Call Recording Control Response."
      },
      "CallRecordingPartModel": {
        "type": "object",
        "properties": {
          "startedOn": {
            "type": "string",
            "description": "Timestamp of the moment when the recording started.",
            "format": "date-time"
          },
          "duration": {
            "type": "string",
            "description": "Duration of the recording.",
            "format": "date-span"
          },
          "url": {
            "type": "string",
            "description": "The URL of the recording to download its contents. This field may be `null` only in case if\nthe platform failed to get the recording, and it's not possible to recover it anymore.",
            "format": "uri",
            "nullable": true
          },
          "fees": {
            "type": "array",
            "items": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/FeeGroupModel"
                },
                {
                  "$ref": "#/components/schemas/SegmentsGroupModel"
                }
              ],
              "description": "Group of units billed under the same price tier."
            },
            "description": "Processing fees for this recording part.\nThis is `null` unless `includeFees` parameter is specified in the request.",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Call recording."
      },
      "CallRecordingsModel": {
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CallRecordingsStatus"
              }
            ],
            "description": "Status value which indicates the overall progression of the call recordings.\n<p>Possible values:</p>\n<ul>\n<li><b>Recording</b>: The call is being recorded at the moment. Recording data is not available yet.</li>\n<li><b>Paused</b>: The call recording is paused at the moment. Recording data is not available yet.</li>\n<li><b>Processing</b>: The call was completed, and the recording data is being prepared for download.</li>\n<li><b>Completed</b>: The call and recording have been completed, and the recording data is available for download.</li>\n</ul>\n"
          },
          "parts": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CallRecordingPartModel"
            },
            "description": "Call recording parts.\nThis field receives value only when the `Status` is `Completed`.\nBefore that, it is always `null`.",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Call recordings."
      },
      "CallRecordingsStatus": {
        "enum": [
          "Recording",
          "Paused",
          "Processing",
          "Completed"
        ],
        "type": "string",
        "description": "Indicates the overall progression of the call recordings.\n<p>Possible values:</p>\n<ul>\n<li><b>Recording</b>: The call is being recorded at the moment. Recording data is not available yet.</li>\n<li><b>Paused</b>: The call recording is paused at the moment. Recording data is not available yet.</li>\n<li><b>Processing</b>: The call was completed, and the recording data is being prepared for download.</li>\n<li><b>Completed</b>: The call and recording have been completed, and the recording data is available for download.</li>\n</ul>\n"
      },
      "CallStatus": {
        "enum": [
          "Created",
          "InProgress",
          "Completed"
        ],
        "type": "string",
        "description": "Call status.\n<p>Possible values:</p>\n<ul>\n<li><b>Created</b>: The Call has been created but does not yet contain any Legs. This state may appear briefly right after initiating the call via POST to /v1/Voice/Calls, and before the first Leg is established - meaning the Call has not actually started yet.</li>\n<li><b>InProgress</b>: The Call is in progress, i.e. it has uncompleted Legs.</li>\n<li><b>Completed</b>: All Legs of the Call are completed (hung up).</li>\n</ul>\n"
      },
      "CampaignDisplayStatus": {
        "enum": [
          "DcaPending",
          "Active",
          "DcaDeclined"
        ],
        "type": "string",
        "description": "User-facing campaign status derived from sharing + DCA approval state.\n<p>Possible values:</p>\n<ul>\n<li><b>DcaPending</b>: The campaign is under DCA review (or accepted but not yet DCA-approved).</li>\n<li><b>Active</b>: The campaign is active and DCA-approved.</li>\n<li><b>DcaDeclined</b>: The campaign failed DCA verification.</li>\n</ul>\n"
      },
      "CampaignModel": {
        "required": [
          "attMessageClass",
          "creationDate",
          "helpKeywords",
          "optInKeywords",
          "optOutKeywords",
          "subscriberHelp",
          "subscriberOptin",
          "subscriberOptout",
          "tcrBrandId",
          "tcrCampaignId",
          "tMobileBrandTier"
        ],
        "type": "object",
        "properties": {
          "tcrCampaignId": {
            "minLength": 1,
            "type": "string",
            "description": "TCR Campaign ID.",
            "example": "C123ABC"
          },
          "tcrBrandId": {
            "minLength": 1,
            "type": "string",
            "description": "Linked TCR Brand ID.",
            "example": "B123ABC"
          },
          "tcrBrandName": {
            "maxLength": 1024,
            "type": "string",
            "description": "Linked TCR Brand Name.",
            "nullable": true
          },
          "creationDate": {
            "maxLength": 10,
            "minLength": 1,
            "type": "string",
            "description": "TCR Creation Date. yyyy-MM-dd format.",
            "example": "2020-02-29"
          },
          "name": {
            "maxLength": 1024,
            "type": "string",
            "description": "TCR Campaign Name.",
            "nullable": true
          },
          "attMessageClass": {
            "allOf": [
              {
                "$ref": "#/components/schemas/AttMessageClass"
              }
            ],
            "description": "AT&T Message Class.\n<p>Possible values:</p>\n<ul>\n<li><b>A</b></li>\n<li><b>B</b></li>\n<li><b>C</b></li>\n<li><b>D</b></li>\n<li><b>E</b></li>\n<li><b>F</b></li>\n<li><b>G</b></li>\n<li><b>K</b></li>\n<li><b>N</b></li>\n<li><b>P</b></li>\n<li><b>S</b></li>\n<li><b>T</b></li>\n<li><b>W</b></li>\n<li><b>X</b></li>\n<li><b>Y</b></li>\n<li><b>Z</b></li>\n</ul>\n"
          },
          "tMobileBrandTier": {
            "allOf": [
              {
                "$ref": "#/components/schemas/TMobileBrandTier"
              }
            ],
            "description": "T-Mobile Brand Tier.\n<p>Possible values:</p>\n<ul>\n<li><b>Unknown</b></li>\n<li><b>SOLE_PROPRIETOR</b></li>\n<li><b>LOW</b></li>\n<li><b>LOWER_MID</b></li>\n<li><b>UPPER_MID</b></li>\n<li><b>TOP</b></li>\n<li><b>UNCAPPED</b></li>\n</ul>\n"
          },
          "verizonWirelessMessageClass": {
            "type": "string",
            "description": "Verizon Wireless Message Class.",
            "nullable": true
          },
          "usCellularMessageClass": {
            "type": "string",
            "description": "US Cellular Message Class.",
            "nullable": true
          },
          "messagingConfigSid": {
            "type": "string",
            "description": "Linked Messaging Config Sid.",
            "nullable": true,
            "example": "MCf4f1e0ccde19431ebde74a9f2996afa0"
          },
          "messagingConfigName": {
            "maxLength": 1024,
            "type": "string",
            "description": "Linked Messaging Config Name.",
            "nullable": true
          },
          "subscriberOptin": {
            "type": "boolean",
            "description": "Indicates whether the campaign supports subscriber opt-in keyword(s) and\nrequires a subscriber to opt-in before SMS is sent to the subscriber."
          },
          "subscriberOptout": {
            "type": "boolean",
            "description": "Indicates whether the campaign supports subscriber opt-out keyword(s)."
          },
          "subscriberHelp": {
            "type": "boolean",
            "description": "Indicates whether the campaign responds to help keyword(s)."
          },
          "optInKeywords": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Subscriber opt-in keywords.",
            "example": "[ \"START\", \"CONTINUE\" ]"
          },
          "optOutKeywords": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Subscriber opt-out keywords.",
            "example": "[ \"STOP\", \"QUIT\" ]"
          },
          "helpKeywords": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Subscriber help keywords.",
            "example": "[ \"HELP\", \"INFO\" ]"
          },
          "optInMessage": {
            "maxLength": 1024,
            "minLength": 20,
            "type": "string",
            "description": "Subscriber opt-in message.",
            "nullable": true,
            "example": "You are subscribed to messages from this sender. Msg frequency varies. Reply HELP for help or STOP to unsubscribe. Msg & data rates may apply."
          },
          "optOutMessage": {
            "maxLength": 1024,
            "minLength": 20,
            "type": "string",
            "description": "Subscriber opt-out message.",
            "nullable": true,
            "example": "You are unsubscribed. You will no longer receive messages from this sender. Reply START to resubscribe. Msg & data rates may apply."
          },
          "helpMessage": {
            "maxLength": 1024,
            "minLength": 20,
            "type": "string",
            "description": "Subscriber help message.",
            "nullable": true,
            "example": "Reply STOP to unsubscribe. Msg & data rates may apply."
          },
          "description": {
            "maxLength": 4096,
            "minLength": 40,
            "type": "string",
            "description": "Summary description of this campaign.",
            "nullable": true
          },
          "messageFlow": {
            "maxLength": 4096,
            "minLength": 40,
            "type": "string",
            "description": "Message flow description.",
            "nullable": true
          },
          "embeddedLink": {
            "type": "boolean",
            "description": "Indicates whether the campaign allows including a URL link in SMS."
          },
          "embeddedPhone": {
            "type": "boolean",
            "description": "Indicates whether the campaign allows including a phone number in SMS."
          },
          "directLending": {
            "type": "boolean",
            "description": "Indicates whether the campaign allows direct lending or loan arrangement."
          },
          "ageGated": {
            "type": "boolean",
            "description": "Indicates whether the campaign allows age-gated content."
          }
        },
        "additionalProperties": false,
        "description": "Campaign model."
      },
      "CampaignModelPaginatedResult": {
        "required": [
          "items"
        ],
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CampaignModel"
            }
          },
          "searchId": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "CampaignPatchRequest": {
        "type": "object",
        "properties": {
          "creationDate": {
            "maxLength": 10,
            "type": "string",
            "description": "TCR Creation Date.",
            "nullable": true,
            "example": "2020-02-29",
            "deprecated": true
          },
          "name": {
            "type": "string",
            "description": "TCR Campaign Name. Should be exactly as shown in TCR.",
            "nullable": true
          },
          "attMessageClass": {
            "allOf": [
              {
                "$ref": "#/components/schemas/AttMessageClass"
              }
            ],
            "description": "AT&T Message Class.\n<p>Possible values:</p>\n<ul>\n<li><b>A</b></li>\n<li><b>B</b></li>\n<li><b>C</b></li>\n<li><b>D</b></li>\n<li><b>E</b></li>\n<li><b>F</b></li>\n<li><b>G</b></li>\n<li><b>K</b></li>\n<li><b>N</b></li>\n<li><b>P</b></li>\n<li><b>S</b></li>\n<li><b>T</b></li>\n<li><b>W</b></li>\n<li><b>X</b></li>\n<li><b>Y</b></li>\n<li><b>Z</b></li>\n</ul>\n",
            "nullable": true,
            "deprecated": true
          },
          "tMobileBrandTier": {
            "allOf": [
              {
                "$ref": "#/components/schemas/TMobileBrandTier"
              }
            ],
            "description": "T-Mobile Brand Tier.\n<p>Possible values:</p>\n<ul>\n<li><b>Unknown</b></li>\n<li><b>SOLE_PROPRIETOR</b></li>\n<li><b>LOW</b></li>\n<li><b>LOWER_MID</b></li>\n<li><b>UPPER_MID</b></li>\n<li><b>TOP</b></li>\n<li><b>UNCAPPED</b></li>\n</ul>\n",
            "nullable": true,
            "deprecated": true
          },
          "verizonWirelessMessageClass": {
            "type": "string",
            "description": "Verizon Wireless Message Class.",
            "nullable": true,
            "deprecated": true
          },
          "usCellularMessageClass": {
            "type": "string",
            "description": "US Cellular Message Class.",
            "nullable": true,
            "deprecated": true
          },
          "messagingConfigSid": {
            "pattern": "^(MC)[0-9a-f]{32}$",
            "type": "string",
            "description": "Linked Messaging Config Sid.",
            "nullable": true,
            "example": "MCf4f1e0ccde19431ebde74a9f2996afa0"
          }
        },
        "additionalProperties": false,
        "description": "Campaign Patch Request."
      },
      "CampaignRequest": {
        "type": "object",
        "properties": {
          "creationDate": {
            "maxLength": 10,
            "type": "string",
            "description": "TCR Creation Date.",
            "nullable": true,
            "example": "2020-02-29",
            "deprecated": true
          },
          "name": {
            "type": "string",
            "description": "TCR Campaign Name. Should be exactly as shown in TCR.",
            "nullable": true
          },
          "attMessageClass": {
            "allOf": [
              {
                "$ref": "#/components/schemas/AttMessageClass"
              }
            ],
            "description": "AT&T Message Class.\n<p>Possible values:</p>\n<ul>\n<li><b>A</b></li>\n<li><b>B</b></li>\n<li><b>C</b></li>\n<li><b>D</b></li>\n<li><b>E</b></li>\n<li><b>F</b></li>\n<li><b>G</b></li>\n<li><b>K</b></li>\n<li><b>N</b></li>\n<li><b>P</b></li>\n<li><b>S</b></li>\n<li><b>T</b></li>\n<li><b>W</b></li>\n<li><b>X</b></li>\n<li><b>Y</b></li>\n<li><b>Z</b></li>\n</ul>\n",
            "nullable": true,
            "deprecated": true
          },
          "tMobileBrandTier": {
            "allOf": [
              {
                "$ref": "#/components/schemas/TMobileBrandTier"
              }
            ],
            "description": "T-Mobile Brand Tier.\n<p>Possible values:</p>\n<ul>\n<li><b>Unknown</b></li>\n<li><b>SOLE_PROPRIETOR</b></li>\n<li><b>LOW</b></li>\n<li><b>LOWER_MID</b></li>\n<li><b>UPPER_MID</b></li>\n<li><b>TOP</b></li>\n<li><b>UNCAPPED</b></li>\n</ul>\n",
            "nullable": true,
            "deprecated": true
          },
          "verizonWirelessMessageClass": {
            "type": "string",
            "description": "Verizon Wireless Message Class.",
            "nullable": true,
            "deprecated": true
          },
          "usCellularMessageClass": {
            "type": "string",
            "description": "US Cellular Message Class.",
            "nullable": true,
            "deprecated": true
          },
          "messagingConfigSid": {
            "pattern": "^(MC)[0-9a-f]{32}$",
            "type": "string",
            "description": "Linked Messaging Config Sid.",
            "nullable": true,
            "example": "MCf4f1e0ccde19431ebde74a9f2996afa0"
          }
        },
        "additionalProperties": false,
        "description": "Campaign request."
      },
      "CampaignStatusModel": {
        "type": "object",
        "properties": {
          "name": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CampaignDisplayStatus"
              }
            ],
            "description": "Current status of the campaign.\n<p>Possible values:</p>\n<ul>\n<li><b>DcaPending</b>: The campaign is under DCA review (or accepted but not yet DCA-approved).</li>\n<li><b>Active</b>: The campaign is active and DCA-approved.</li>\n<li><b>DcaDeclined</b>: The campaign failed DCA verification.</li>\n</ul>\n",
            "nullable": true
          },
          "details": {
            "type": "string",
            "description": "Explanation of why status in this position.",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "CampaignTmpDetails": {
        "type": "object",
        "properties": {
          "tcrCampaignId": {
            "type": "string",
            "description": "TCR Campaign ID.",
            "example": "C123ABC"
          },
          "dcaApprovedOn": {
            "maxLength": 10,
            "type": "string",
            "description": "DCA Approved Date. yyyy-MM-dd format.",
            "nullable": true,
            "example": "2020-02-29"
          },
          "deployedOn": {
            "maxLength": 10,
            "type": "string",
            "description": "Deployed On Date. yyyy-MM-dd format.",
            "nullable": true,
            "example": "2020-02-29"
          }
        },
        "additionalProperties": false,
        "description": "Campaign model."
      },
      "CompanyModel": {
        "type": "object",
        "properties": {
          "cspId": {
            "type": "string",
            "description": "Campaign Service Provider Identifier in TCR (CspId).",
            "nullable": true,
            "example": "S123ABC"
          },
          "cspIdCanBeChanged": {
            "type": "boolean",
            "description": "If `true`, the CspId can be changed. Otherwise, `false`."
          },
          "tcrBrandSid": {
            "type": "string",
            "description": "Reserved for future use.",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Company information."
      },
      "CreateOptOutRequest": {
        "required": [
          "number",
          "scope"
        ],
        "type": "object",
        "properties": {
          "number": {
            "minLength": 1,
            "type": "string",
            "description": "End-user number that opted out."
          },
          "scope": {
            "maxLength": 128,
            "minLength": 1,
            "type": "string",
            "description": "TollFree phone number (must start with country code e.g. +1...) or TCR Campaign Sid\nto which end-user is opted out."
          }
        },
        "additionalProperties": false,
        "description": "Create Opt-Out Request."
      },
      "CreateOutboundMessageRequest": {
        "required": [
          "from"
        ],
        "type": "object",
        "properties": {
          "from": {
            "maxLength": 16,
            "type": "string",
            "description": "Sender of the message. Must be one of the Phone Numbers owned by you.",
            "example": "+12145678900"
          },
          "to": {
            "maxLength": 16,
            "type": "string",
            "description": "Recipient of the message. Either `to` or `recipients` field (and not both) must be defined.\nSpecifying this field is equivalent to specifying `recipients` array with a single element.",
            "example": "+19876543210"
          },
          "recipients": {
            "maxLength": 10,
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Recipients of the message. If multiple Phone Numbers are specified, the request will be treated as a group MMS\nrequest. Either `to` or `recipients` field (and not both) must be defined.",
            "example": [
              "+19876543210",
              "+12345678900"
            ]
          },
          "text": {
            "maxLength": 8000,
            "type": "string",
            "description": "Text of the message. Can be empty only when MediaUrls set.",
            "nullable": true,
            "example": "Glad to see you!"
          },
          "priority": {
            "type": "string",
            "description": "Priority of the message. 'Normal' if not specified.\n<p>Possible values:</p>\n<ul>\n<li><b>Urgent</b>: Urgent</li>\n<li><b>High</b>: High</li>\n<li><b>Normal</b>: Normal</li>\n<li><b>Low</b>: Low</li>\n</ul>\n",
            "nullable": true,
            "example": "Normal"
          },
          "mediaUrls": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Attachment URLs of the message. If `null` or empty, the message is treated as SMS, else - MMS.\nAll elements must be well-formed absolute URL strings. Only HTTP and HTTPS schemes are supported.",
            "nullable": true,
            "example": null
          },
          "callbackUrlOverride": {
            "type": "string",
            "description": "If specified, the events for this Outbound Message will be sent to the specified URL.\nIf this URL is empty then Messaging Config URLs are used for Outbound Message events.\nAdds 'https://' if no HTTP schema is defined.",
            "nullable": true
          },
          "expiresOn": {
            "type": "string",
            "description": "UTC timestamp indicating when the Outbound Message will expire.\n\nIf the value is within 72 hours of message submission, it will be used as-is.\nIf the value is `null` or exceeds 72 hours from the request time, it will be automatically overwritten to 72 hours from the time of submission.\nAfter the expiration time, no delivery attempts will be made, and the message will be marked as \"Expired\".",
            "format": "date-time",
            "nullable": true,
            "example": "2025-06-01T15:00:00Z"
          },
          "conversationMetadata": {
            "maxLength": 2048,
            "type": "string",
            "description": "Specifies new metadata value for this and subsequent messages in the current conversion.\n\nConversation metadata is an arbitrary text value\nassociated with a pair of phone numbers, one being a company phone number.\nOnce specified, all subsequent Outbound Messages and Inbound Messages in the same conversation\nwill get this metadata value.\nConversation metadata can be overriden multiple times,\nbut this does not affect previous messages in the conversation, only future messages are affected.\nConversation metadata is not supported for group messages.",
            "nullable": true
          },
          "ignoreSendingTimes": {
            "type": "boolean",
            "description": "If `true`, the message will be sent regardless of the Time Routing configured for the Messaging Config.",
            "example": false
          }
        },
        "additionalProperties": false,
        "description": "Submit Outbound Message request."
      },
      "CreateOutboundMessageResult": {
        "required": [
          "segmentCount",
          "sid"
        ],
        "type": "object",
        "properties": {
          "sid": {
            "maxLength": 128,
            "minLength": 1,
            "type": "string",
            "description": "Outbound Message Sid",
            "example": "OM08d9704f044a2fa13d3faa216fcf4574b64b19be32626243"
          },
          "segmentCount": {
            "type": "integer",
            "description": "Number of text segments in the outbound message.",
            "format": "int32"
          }
        },
        "additionalProperties": false,
        "description": "Create Outbound Message Response"
      },
      "CreatePhoneRequest": {
        "required": [
          "phone"
        ],
        "type": "object",
        "allOf": [
          {
            "$ref": "#/components/schemas/PhoneRequest"
          }
        ],
        "properties": {
          "phone": {
            "type": "string",
            "description": "Phone Number to order.",
            "example": "+12345678900"
          }
        },
        "additionalProperties": false,
        "description": "Order Phone."
      },
      "CreateRcsEventsRequest": {
        "required": [
          "events"
        ],
        "type": "object",
        "properties": {
          "events": {
            "maxItems": 100,
            "minItems": 1,
            "type": "array",
            "items": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/RcsSeenEventItem"
                },
                {
                  "$ref": "#/components/schemas/RcsTypingIndicatorEventItem"
                }
              ],
              "description": "A single RCS outbound event to dispatch"
            },
            "description": "Events to dispatch. Must contain between 1 and 100 items."
          }
        },
        "additionalProperties": false,
        "description": "Submit one or more RCS outbound events in a single request (up to 100)."
      },
      "CreateRcsOutboundMessagesRequest": {
        "required": [
          "messages"
        ],
        "type": "object",
        "properties": {
          "messages": {
            "maxItems": 100,
            "minItems": 1,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RcsMessageItem"
            },
            "description": "List of RCS messages to send. Must contain between 1 and `100` items."
          }
        },
        "additionalProperties": false,
        "description": "Submit one or more RCS messages in a single request (up to Telgorithm.Phone.Api.Contracts.Rcs.CreateRcsOutboundMessagesRequest.MaxMessages)."
      },
      "CreateRcsOutboundMessagesResult": {
        "type": "object",
        "properties": {
          "messages": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RcsOutboundMessageResultItem"
            }
          }
        },
        "additionalProperties": false
      },
      "CreatedOptOutsModel": {
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/OptOutModel"
            },
            "description": "Created Opt-Outs collection, ignoring existing Opt-Outs."
          }
        },
        "additionalProperties": false,
        "description": "Created Opt-Outs Response."
      },
      "DisplayPhoneStatus": {
        "enum": [
          "Active",
          "Pending",
          "PendingPortIn",
          "PendingTcrCampaignChange",
          "PendingMessagingConfigAdd",
          "PendingTcrCampaignAdd",
          "CanadianTrafficOnly",
          "Removed"
        ],
        "type": "string",
        "description": "Phone Status, used in API response models.\n<p>Possible values:</p>\n<ul>\n<li><b>Active</b>: Phone number is ordered and active.</li>\n<li><b>Pending</b>: Phone number is ordering, but not active yet.</li>\n<li><b>PendingPortIn</b>: Phone number is in port-in process.</li>\n<li><b>PendingTcrCampaignChange</b>: Phone number is in process of changing TCR Campaign.</li>\n<li><b>PendingMessagingConfigAdd</b>: Phone number is ordered, but it's not associated with any MessagingConfig.</li>\n<li><b>PendingTcrCampaignAdd</b>: Phone number is ordered, but it's not associated with an approved TCR Campaign.</li>\n<li><b>CanadianTrafficOnly</b>: Phone number belongs to Canada and has no approved TCR Campaign. Only messages to Canada are allowed.</li>\n<li><b>Removed</b>: Phone number is Removed.</li>\n</ul>\n",
        "example": "Active"
      },
      "EndUserPhoneServiceType": {
        "enum": [
          "Business",
          "Residence"
        ],
        "type": "string",
        "description": "Phone service type requested when porting.\n<p>Possible values:</p>\n<ul>\n<li><b>Business</b>: Business.</li>\n<li><b>Residence</b>: Residence.</li>\n</ul>\n"
      },
      "EndUserStreetDirection": {
        "enum": [
          "N",
          "S",
          "E",
          "W",
          "NE",
          "NW",
          "SE",
          "SW"
        ],
        "type": "string",
        "description": "Directions used for pre- and post- directions.\n<p>Possible values:</p>\n<ul>\n<li><b>N</b>: North</li>\n<li><b>S</b>: South</li>\n<li><b>E</b>: East</li>\n<li><b>W</b>: West</li>\n<li><b>NE</b>: North-East</li>\n<li><b>NW</b>: North-West</li>\n<li><b>SE</b>: South-East</li>\n<li><b>SW</b>: South-West</li>\n</ul>\n"
      },
      "FeeGroupModel": {
        "type": "object",
        "properties": {
          "count": {
            "type": "integer",
            "description": "Number of units (voice minutes, message segments, etc) in this group.",
            "format": "int32"
          },
          "feePerUnit": {
            "type": "number",
            "description": "Fee per one unit. This value is non-negative.",
            "format": "decimal"
          },
          "total": {
            "type": "number",
            "description": "Total fee for this group. This value is non-negative.",
            "format": "decimal"
          }
        },
        "additionalProperties": false,
        "description": "Group of units billed under the same price tier."
      },
      "ImportOptOutsRequest": {
        "required": [
          "items"
        ],
        "type": "object",
        "properties": {
          "items": {
            "maxItems": 2000,
            "minItems": 1,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CreateOptOutRequest"
            },
            "description": "Opt-Outs to create."
          }
        },
        "additionalProperties": false,
        "description": "Import Opt-Outs Request."
      },
      "InboundMessageModel": {
        "required": [
          "additionalRecipients",
          "createdOn",
          "sid",
          "text",
          "to"
        ],
        "type": "object",
        "properties": {
          "sid": {
            "maxLength": 128,
            "minLength": 1,
            "type": "string",
            "description": "Message unique identifier.",
            "example": "IM99d9812a055b3da13d3faa216fcf4574b64b19be32626243"
          },
          "from": {
            "maxLength": 128,
            "type": "string",
            "description": "Sender phone number.",
            "nullable": true,
            "example": "+19876543210"
          },
          "to": {
            "maxLength": 16,
            "minLength": 1,
            "type": "string",
            "description": "Recipient phone number.",
            "example": "+12145678900"
          },
          "additionalRecipients": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Other recipients phone numbers. Not empty when the message represents a group MMS message.",
            "example": [
              "+12145678900",
              "+12145678901"
            ]
          },
          "text": {
            "minLength": 1,
            "type": "string",
            "description": "Message text."
          },
          "mediaUrls": {
            "minItems": 1,
            "type": "array",
            "items": {
              "type": "string",
              "format": "uri"
            },
            "description": "Media URLs. Only used for MMS. The lifetime of the links in this array is 7 days.",
            "nullable": true
          },
          "createdOn": {
            "type": "string",
            "description": "Date the Inbound Message was received on.",
            "format": "date-time"
          },
          "segmentCount": {
            "type": "integer",
            "description": "Number of text segments the Message is divided into. Always equals to `1` for MMS.",
            "format": "int32"
          },
          "conversationMetadata": {
            "maxLength": 2048,
            "type": "string",
            "description": "Conversation metadata for this message.",
            "nullable": true
          },
          "fees": {
            "allOf": [
              {
                "$ref": "#/components/schemas/MessageFeesModel"
              }
            ],
            "description": "Message processing fees.",
            "nullable": true
          },
          "brandSid": {
            "type": "string",
            "description": "TCR Brand SID if the recipient Phone Number was attached to TCR campaign at the receiving moment.",
            "nullable": true
          },
          "campaignSid": {
            "type": "string",
            "description": "TCR Campaign SID if the recipient Phone Number was attached to TCR campaign at the receiving moment.",
            "nullable": true
          },
          "messagingConfigSid": {
            "type": "string",
            "description": "Messaging Config SID at message receiving moment.",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Inbound Message.\n\nNotes for MMS:<ul><li>The lifetime of the links in the `MediaUrls` array is 7 days.</li><li>In some cases, there may be no message body in the `Text` field. Instead, it would come\nas one of the attachments. Most likely it is the attachment with the `.txt` extension and/or\n`Content-Type: text/plain` response header.</li><li>When examining the attachments in the `MediaUrls` field, you should not rely solely on the file extension\nand also check the `Content-Type` response header. The layout of the MMS is determined by the attachment\nwith the `Content-Type: application/smil`. See the <a href=\"https://www.w3.org/TR/SMIL2/\">SMIL Specification</a>\nfor more information.</li></ul>"
      },
      "InboundMessageModelPaginatedResult": {
        "required": [
          "items"
        ],
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/InboundMessageModel"
            }
          },
          "searchId": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "InitiateCallRequest": {
        "required": [
          "callerId",
          "from",
          "to"
        ],
        "type": "object",
        "properties": {
          "callerId": {
            "maxLength": 16,
            "type": "string",
            "description": "The internal number (which belongs to your account) which is used as a number visible to other call parties.",
            "example": "+13456789012"
          },
          "from": {
            "maxLength": 256,
            "type": "string",
            "description": "<p>\n            The agent's Phone Number or SIP URI where the first leg of the call is initiated to.\n            If it is a SIP URI, it must start with the `sip:` or `sips:` prefix, and must be formatted\n            according to RFC 3261 standard. Examples of valid SIP URI:\n            <ul><li>`sip:user@server.com:5060`</li><li>`sip:user@server.com;transport=TLS`</li><li>`sip:user@server.com?header1=value1&header2=value2`</li><li>`sip:user@server.com:5060;transport=TCP?header=value`</li></ul></p>\n<p>\n            ⚠️ <b>To use SIP destinations</b>, the receiving system must be configured to accept SIP\n            traffic from the IP addresses below:\n            <ul><li>`137.192.78.201`</li><li>`137.192.80.201`</li></ul></p>\n<p>\n            These IPs should be added to the receiving system’s allowlist or firewall rules to ensure successful call\n            delivery.\n            </p>",
            "example": "+12345678901"
          },
          "to": {
            "maxLength": 256,
            "type": "string",
            "description": "<p>\n            The external party of the call, which is connected after the first leg is connected.\n            It can be a Phone Number or a SIP URI.\n            If it is a SIP URI, it must start with the `sip:` or `sips:` prefix, and must be formatted\n            according to RFC 3261 standard. Examples of valid SIP URI:\n            <ul><li>`sip:user@server.com:5060`</li><li>`sip:user@server.com;transport=TLS`</li><li>`sip:user@server.com?header1=value1&header2=value2`</li><li>`sip:user@server.com:5060;transport=TCP?header=value`</li></ul></p>\n<p>\n            ⚠️ <b>To use SIP destinations</b>, the receiving system must be configured to accept SIP\n            traffic from the IP addresses below:\n            <ul><li>`137.192.78.201`</li><li>`137.192.80.201`</li></ul></p>\n<p>\n            These IPs should be added to the receiving system’s allowlist or firewall rules to ensure successful call\n            delivery.\n            </p>",
            "example": "+19876543210"
          },
          "record": {
            "type": "boolean",
            "description": "Determines whether this outbound call should be recorded.",
            "example": "false"
          }
        },
        "additionalProperties": false,
        "description": "Initiate Call request"
      },
      "InitiateCallResult": {
        "required": [
          "sid"
        ],
        "type": "object",
        "properties": {
          "sid": {
            "maxLength": 128,
            "minLength": 1,
            "type": "string",
            "description": "Call Sid.",
            "example": "CA08d9704f044a2fa13d3faa216fcf4574b64b19be32626243"
          }
        },
        "additionalProperties": false,
        "description": "Initiate Call response"
      },
      "MessageFeesModel": {
        "type": "object",
        "properties": {
          "platformFees": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SegmentsGroupModel"
            },
            "description": "Per-segment information on Telgorithm Platform fees.",
            "nullable": true
          },
          "passThroughFees": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SegmentsGroupModel"
            },
            "description": "Per-segment information on Telgorithm Pass-Through fees.",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Contains information on message processing fees.\nThere may be different platform fees per segment due to tiered pricing."
      },
      "MessagingConfigDetailsModel": {
        "required": [
          "createdOn",
          "optInOutSettings",
          "sid"
        ],
        "type": "object",
        "properties": {
          "tcrCampaign": {
            "allOf": [
              {
                "$ref": "#/components/schemas/MessagingConfigTcrCampaignModel"
              }
            ],
            "description": "Linked TCR Campaign details.",
            "nullable": true
          },
          "sid": {
            "minLength": 1,
            "type": "string",
            "description": "Messaging Config Sid.",
            "example": "MCf4f1e0ccde19431ebde74a9f2996afa0"
          },
          "createdOn": {
            "type": "string",
            "description": "Created date.",
            "format": "date-time"
          },
          "outboundCallbackUrl": {
            "type": "string",
            "description": "Callback URL for the outbound message events. You can find callback payload for OutboundMessageEvent\nin the <a href=\"/docs/webhooks\">Webhook Samples</a>.",
            "nullable": true,
            "example": "https://example.com/outboundMessage?source=telgorithm"
          },
          "inboundCallbackUrl": {
            "type": "string",
            "description": "Callback URL for the inbound message events. You can find callback payload for InboundMessageEvent\nin the <a href=\"/docs/webhooks\">Webhook Samples</a>.",
            "nullable": true,
            "example": "https://example.com/inboundMessage?source=telgorithm"
          },
          "optInOutCallbackUrl": {
            "type": "string",
            "description": "Callback URL for the Opt In/Out messages. You can find callback payload for OptInOutEvent\nin the <a href=\"/docs/webhooks\">Webhook Samples</a>.",
            "nullable": true
          },
          "tcrCampaignId": {
            "type": "string",
            "description": "Linked TCR Campaign ID.",
            "nullable": true,
            "example": "C123ABC"
          },
          "name": {
            "maxLength": 1024,
            "type": "string",
            "description": "Messaging Config name.",
            "nullable": true,
            "example": "I am messaging config"
          },
          "authorizationBearer": {
            "maxLength": 256,
            "type": "string",
            "description": "If specified, the Authorization header is added to callback requests using the `Bearer` scheme\nand containing the value provided in this field.",
            "nullable": true,
            "example": "MySecretToken123"
          },
          "sendingTimes": {
            "allOf": [
              {
                "$ref": "#/components/schemas/SendingTimesModel"
              }
            ],
            "description": "Specifies the time zone and time periods in a day when the messaging should be active.\nSMS and MMS won't be sent outside of these intervals.\nIf `null`, the messaging is active for the whole day.",
            "nullable": true
          },
          "optInOutSettings": {
            "allOf": [
              {
                "$ref": "#/components/schemas/MessagingConfigOptInOutSettingsModel"
              }
            ],
            "description": "Returns effective subscriber opt-in/opt-out/help settings."
          }
        },
        "additionalProperties": false,
        "description": "Detailed Messaging Config."
      },
      "MessagingConfigListModel": {
        "required": [
          "createdOn",
          "optInOutSettings",
          "sid"
        ],
        "type": "object",
        "properties": {
          "tcrCampaign": {
            "allOf": [
              {
                "$ref": "#/components/schemas/MessagingConfigListTcrCampaignModel"
              }
            ],
            "description": "Linked TCR Campaign details.",
            "nullable": true
          },
          "sid": {
            "minLength": 1,
            "type": "string",
            "description": "Messaging Config Sid.",
            "example": "MCf4f1e0ccde19431ebde74a9f2996afa0"
          },
          "createdOn": {
            "type": "string",
            "description": "Created date.",
            "format": "date-time"
          },
          "outboundCallbackUrl": {
            "type": "string",
            "description": "Callback URL for the outbound message events. You can find callback payload for OutboundMessageEvent\nin the <a href=\"/docs/webhooks\">Webhook Samples</a>.",
            "nullable": true,
            "example": "https://example.com/outboundMessage?source=telgorithm"
          },
          "inboundCallbackUrl": {
            "type": "string",
            "description": "Callback URL for the inbound message events. You can find callback payload for InboundMessageEvent\nin the <a href=\"/docs/webhooks\">Webhook Samples</a>.",
            "nullable": true,
            "example": "https://example.com/inboundMessage?source=telgorithm"
          },
          "optInOutCallbackUrl": {
            "type": "string",
            "description": "Callback URL for the Opt In/Out messages. You can find callback payload for OptInOutEvent\nin the <a href=\"/docs/webhooks\">Webhook Samples</a>.",
            "nullable": true
          },
          "tcrCampaignId": {
            "type": "string",
            "description": "Linked TCR Campaign ID.",
            "nullable": true,
            "example": "C123ABC"
          },
          "name": {
            "maxLength": 1024,
            "type": "string",
            "description": "Messaging Config name.",
            "nullable": true,
            "example": "I am messaging config"
          },
          "authorizationBearer": {
            "maxLength": 256,
            "type": "string",
            "description": "If specified, the Authorization header is added to callback requests using the `Bearer` scheme\nand containing the value provided in this field.",
            "nullable": true,
            "example": "MySecretToken123"
          },
          "sendingTimes": {
            "allOf": [
              {
                "$ref": "#/components/schemas/SendingTimesModel"
              }
            ],
            "description": "Specifies the time zone and time periods in a day when the messaging should be active.\nSMS and MMS won't be sent outside of these intervals.\nIf `null`, the messaging is active for the whole day.",
            "nullable": true
          },
          "optInOutSettings": {
            "allOf": [
              {
                "$ref": "#/components/schemas/MessagingConfigOptInOutSettingsModel"
              }
            ],
            "description": "Returns effective subscriber opt-in/opt-out/help settings."
          }
        },
        "additionalProperties": false,
        "description": "Messaging Config for list response."
      },
      "MessagingConfigListModelPaginatedResult": {
        "required": [
          "items"
        ],
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/MessagingConfigListModel"
            }
          },
          "searchId": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "MessagingConfigListTcrCampaignModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "TCR Campaign ID.",
            "nullable": true,
            "example": "C123ABC"
          },
          "name": {
            "type": "string",
            "description": "TCR Campaign name.",
            "nullable": true,
            "example": "Customer care campaign"
          }
        },
        "additionalProperties": false
      },
      "MessagingConfigOptInOutSettingsModel": {
        "required": [
          "useTcrCampaignSettings"
        ],
        "type": "object",
        "allOf": [
          {
            "$ref": "#/components/schemas/OptInOutSettingsModel"
          }
        ],
        "properties": {
          "useTcrCampaignSettings": {
            "type": "boolean",
            "description": "The flag that specifies whether to use Optin/Optout/Help keywords and messages from the linked TCR campaign\nor provide custom in this Messaging Config."
          }
        },
        "additionalProperties": false
      },
      "MessagingConfigOptInOutSettingsRequest": {
        "type": "object",
        "properties": {
          "useTcrCampaignSettings": {
            "type": "boolean",
            "description": "The flag that specifies whether to use Optin/Optout/Help keywords and messages from the linked TCR campaign\nor provide custom in this Messaging Config.",
            "nullable": true,
            "example": false
          },
          "optInKeywords": {
            "pattern": "^[0-9a-zA-Z]{1,25}$",
            "maxItems": 20,
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Keywords that trigger the opt-in behavior.",
            "nullable": true,
            "example": "[ \"SUBSCRIBE\", \"CONTINUE\" ]"
          },
          "optOutKeywords": {
            "pattern": "^[0-9a-zA-Z]{1,25}$",
            "maxItems": 20,
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Keywords that trigger the opt-out behavior.",
            "nullable": true,
            "example": "[ \"EXIT\", \"STOPNOW\" ]"
          },
          "helpKeywords": {
            "pattern": "^[0-9a-zA-Z]{1,25}$",
            "maxItems": 20,
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Keywords that trigger the help message.",
            "nullable": true,
            "example": "[ \"INFO\" ]"
          },
          "optInMessage": {
            "maxLength": 8000,
            "minLength": 20,
            "type": "string",
            "description": "Subscriber opt-in message that is sent back to the recipient in response to one of keywords defined by\n`OptInKeywords`.",
            "nullable": true,
            "example": "You are subscribed to messages from this sender. Msg frequency varies. Reply HELP for help or STOP to unsubscribe. Msg & data rates may apply."
          },
          "optOutMessage": {
            "maxLength": 8000,
            "minLength": 20,
            "type": "string",
            "description": "Subscriber opt-out message that is sent back to the recipient in response to one of keywords defined by\n`OptOutKeywords`.",
            "nullable": true,
            "example": "You are unsubscribed. You will no longer receive messages from this sender. Reply START to resubscribe. Msg & data rates may apply."
          },
          "helpMessage": {
            "maxLength": 8000,
            "minLength": 20,
            "type": "string",
            "description": "Subscriber help message that is sent back to the recipient in response to one of keywords defined by\n`HelpKeywords`.",
            "nullable": true,
            "example": "Reply STOP to unsubscribe. Msg & data rates may apply."
          }
        },
        "additionalProperties": false,
        "description": "Subscriber settings for opt-in/opt-out/help processes."
      },
      "MessagingConfigPhonesResult": {
        "type": "object",
        "properties": {
          "phones": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Phones assigned to the messaging config."
          }
        },
        "additionalProperties": false,
        "description": "Messaging Config Phones Result."
      },
      "MessagingConfigRequest": {
        "type": "object",
        "properties": {
          "inboundCallbackUrl": {
            "maxLength": 512,
            "minLength": 1,
            "type": "string",
            "description": "Callback URL for the Inbound Message events. You can find callback payload for InboundMessageEvent\nin the <a href=\"/docs/webhooks\">Webhook Samples</a>.",
            "nullable": true,
            "example": "https://example.com/inboundMessage?source=telgorithm"
          },
          "outboundCallbackUrl": {
            "maxLength": 512,
            "minLength": 1,
            "type": "string",
            "description": "Callback URL for the Outbound Message events. You can find callback payload for OutboundMessageEvent\nin the <a href=\"/docs/webhooks\">Webhook Samples</a>.",
            "nullable": true,
            "example": "https://example.com/outboundMessage?source=telgorithm"
          },
          "optInOutCallbackUrl": {
            "maxLength": 512,
            "minLength": 1,
            "type": "string",
            "description": "Callback URL for the Opt In/Out events. You can find callback payload for OptInOutEvent\nin the <a href=\"/docs/webhooks\">Webhook Samples</a>.",
            "nullable": true,
            "example": "https://example.com/optInOut?source=telgorithm"
          },
          "tcrCampaignId": {
            "maxLength": 128,
            "minLength": 1,
            "pattern": "^C[0-9A-Z]{6,127}$",
            "type": "string",
            "description": "Linked TCR Campaign ID.",
            "nullable": true,
            "example": "C123ABC"
          },
          "name": {
            "maxLength": 1024,
            "minLength": 1,
            "type": "string",
            "description": "Name.",
            "nullable": true,
            "example": "I am messaging config"
          },
          "authorizationBearer": {
            "maxLength": 256,
            "type": "string",
            "description": "If specified, the Authorization header is added to webhook requests using\nthe `Bearer` scheme and containing the value provided in this field.",
            "nullable": true,
            "example": "MySecretToken123"
          },
          "sendingTimes": {
            "allOf": [
              {
                "$ref": "#/components/schemas/SendingTimesModel"
              }
            ],
            "description": "Specifies the time zone and time periods in a day when the messaging should be active.\nSMS and MMS won't be sent outside of these intervals.",
            "nullable": true
          },
          "optInOutSettings": {
            "allOf": [
              {
                "$ref": "#/components/schemas/MessagingConfigOptInOutSettingsRequest"
              }
            ],
            "description": "Subscriber settings for opt-in/opt-out/help processes.",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Create / Update Messaging Config Request."
      },
      "MessagingConfigTcrBrandModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "TCR Brand ID.",
            "nullable": true,
            "example": "B123ABC"
          },
          "name": {
            "type": "string",
            "description": "TCR Brand name.",
            "nullable": true,
            "example": "My Best Company Inc"
          }
        },
        "additionalProperties": false
      },
      "MessagingConfigTcrCampaignModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "TCR Campaign ID.",
            "nullable": true,
            "example": "C123ABC"
          },
          "name": {
            "type": "string",
            "description": "TCR Campaign name.",
            "nullable": true,
            "example": "Customer care campaign"
          },
          "tcrBrand": {
            "allOf": [
              {
                "$ref": "#/components/schemas/MessagingConfigTcrBrandModel"
              }
            ],
            "description": "TCR Brand details.",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "OptInOutSettingsModel": {
        "required": [
          "helpKeywords",
          "helpMessage",
          "optInKeywords",
          "optInMessage",
          "optOutKeywords",
          "optOutMessage"
        ],
        "type": "object",
        "properties": {
          "optInKeywords": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Keywords that trigger the opt-in behavior.",
            "example": "[ \"START\", \"UNSTOP\", \"SUBSCRIBE\", \"CONTINUE\" ]"
          },
          "optOutKeywords": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Keywords that trigger the opt-out behavior.",
            "example": "[ \"STOP\", \"QUIT\", \"END\", \"UNSUBSCRIBE\", \"EXIT\", \"STOPNOW\" ]"
          },
          "helpKeywords": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Keywords that trigger the help message.",
            "example": "[ \"HELP\", \"INFO\" ]"
          },
          "optInMessage": {
            "maxLength": 8000,
            "minLength": 20,
            "type": "string",
            "description": "An opt-in message that is sent back to the recipient in response to one of keywords defined by\n`OptInKeywords`.",
            "example": "You are subscribed to messages from this sender. Msg frequency varies. Reply HELP for help or STOP to unsubscribe. Msg & data rates may apply."
          },
          "optOutMessage": {
            "maxLength": 8000,
            "minLength": 20,
            "type": "string",
            "description": "An opt-out message that is sent back to the recipient in response to one of keywords defined by\n`OptOutKeywords`.",
            "example": "You are unsubscribed. You will no longer receive messages from this sender. Reply START to resubscribe. Msg & data rates may apply."
          },
          "helpMessage": {
            "maxLength": 8000,
            "minLength": 20,
            "type": "string",
            "description": "A help message that is sent back to the recipient in response to one of keywords defined by\n`HelpKeywords`.",
            "example": "Reply STOP to unsubscribe. Msg & data rates may apply."
          }
        },
        "additionalProperties": false,
        "description": "Settings for the subscriber's opt-in/opt-out/help processes."
      },
      "OptOutModel": {
        "required": [
          "createdOn",
          "number",
          "scope",
          "scopeType",
          "type"
        ],
        "type": "object",
        "properties": {
          "number": {
            "maxLength": 16,
            "minLength": 1,
            "type": "string",
            "description": "End-user number that opted out.",
            "example": "+12145678900"
          },
          "scope": {
            "minLength": 1,
            "type": "string",
            "description": "Scope on that user is opting out.\n\nIf `scopeType` is `SenderPhoneNumber`, this field contains Toll Free or 10DLC phone number.\n\nIf `scopeType` is `TcrCampaign`, then it contains TCR Campaign Sid."
          },
          "type": {
            "minLength": 1,
            "type": "string",
            "description": "Obsolete, please use `scopeType` instead.",
            "deprecated": true
          },
          "scopeType": {
            "allOf": [
              {
                "$ref": "#/components/schemas/OptOutType"
              }
            ],
            "description": "Represents what end-user is being opted out from: sender phone number or TCR Campaign.\n<p>Possible values:</p>\n<ul>\n<li><b>SenderPhoneNumber</b></li>\n<li><b>TcrCampaign</b></li>\n</ul>\n"
          },
          "createdOn": {
            "type": "string",
            "description": "Created date.",
            "format": "date-time"
          }
        },
        "additionalProperties": false,
        "description": "Opt Out Model."
      },
      "OptOutModelPaginatedResult": {
        "required": [
          "items"
        ],
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/OptOutModel"
            }
          },
          "searchId": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "OptOutType": {
        "enum": [
          "SenderPhoneNumber",
          "TcrCampaign"
        ],
        "type": "string",
        "description": "Represents what end-user is being opted out from: sender phone number or TCR Campaign.\n<p>Possible values:</p>\n<ul>\n<li><b>SenderPhoneNumber</b></li>\n<li><b>TcrCampaign</b></li>\n</ul>\n"
      },
      "OrderByDirections": {
        "enum": [
          "Ascending",
          "Descending"
        ],
        "type": "string",
        "description": "\n<p>Possible values:</p>\n<ul>\n<li><b>Ascending</b></li>\n<li><b>Descending</b></li>\n</ul>\n"
      },
      "OutboundMessageDcaStatusModel": {
        "type": "object",
        "properties": {
          "providerId": {
            "type": "integer",
            "description": "Abstract provider identifier.",
            "format": "int32"
          },
          "code": {
            "type": "string",
            "description": "Provider-specific status or error code.",
            "nullable": true
          },
          "name": {
            "type": "string",
            "description": "Provider-specific symbolic status/error name.",
            "nullable": true
          },
          "description": {
            "type": "string",
            "description": "Human-readable description from the provider.",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Unified delivery status reported by the DCA."
      },
      "OutboundMessageError": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "integer",
            "description": "Error code.\n<p>Possible values:</p>\n<ul>\n<li><b>0</b>: No error</li>\n<li><b>1</b>: Sender Phone Number is invalid or undefined</li>\n<li><b>2</b>: Sender phone number doesn't belong to your company</li>\n<li><b>3</b>: Sender phone number doesn't belong to any TCR campaign</li>\n<li><b>4</b>: Sender phone number is not active yet</li>\n<li><b>5</b>: Sender phone number is in process of changing TCR Campaign</li>\n<li><b>6</b>: Not all MNO's were selected on currently attached TCR campaign, please re-create TCR campaign with all MNO's selected</li>\n<li><b>1001</b>: Recipient Phone Number is invalid or undefined</li>\n<li><b>1002</b>: Message cannot be sent to the recipient because recipient has opted out</li>\n<li><b>1003</b>: Destination number is currently unable to receive text messages (possibly no reception or handset is turned off). Check with the end user</li>\n<li><b>1004</b>: Destination address does not have text messaging services active</li>\n<li><b>1005</b>: The receiver's messaging provider likely does not support MMS messages, please check with the end user</li>\n<li><b>1006</b>: Too many recipient Phone Numbers were specified for group MMS, maximum 10 are allowed</li>\n<li><b>1007</b>: Recipients list contains duplicated elements</li>\n<li><b>2001</b>: Text cannot be empty</li>\n<li><b>2002</b>: Text cannot be longer than 8000 characters</li>\n<li><b>2003</b>: Callback url cannot be longer than 512 characters</li>\n<li><b>2004</b>: Expiration time which was provided with the request is in the past</li>\n<li><b>2005</b>: UTC date-time field in the request body was provided in invalid format</li>\n<li><b>2006</b>: Both `to` and `recipients` fields are specified. Only one of them can be specified.</li>\n<li><b>2007</b>: Conversation metadata is longer than 2048 characters</li>\n<li><b>2008</b>: Conversation metadata is not supported for group messages</li>\n<li><b>2009</b>: MediaUrls field contains an invalid and/or unreachable URL</li>\n<li><b>2010</b>: MediaUrls field can contain up to five items</li>\n<li><b>2011</b>: Some of the attachments referenced by MediaUrls exceed maximum size limit</li>\n<li><b>2012</b>: Callback url is badly formed, or its scheme is not HTTP nor HTTPS.</li>\n<li><b>3001</b>: Message exceeds your Campaign Registry MNO approved throughput limits. The limit specified in TCR Campaign is too low to accomodate a single message</li>\n<li><b>3002</b>: SPAM blocking: volume/velocity policies reached and content filtering</li>\n<li><b>3003</b>: Equivalent to not authorized. Usually because the number may not have SMS enabled for example</li>\n<li><b>3004</b>: Temporarily unable to deliver. Retry or check with the end user</li>\n<li><b>3005</b>: Message queue full</li>\n<li><b>3006</b>: Message submitting failed</li>\n<li><b>3007</b>: Priority is wrong</li>\n<li><b>3008</b>: Destination address does not accept messages from Toll Free Numbers</li>\n<li><b>3009</b>: Message is too long for receiving provider</li>\n<li><b>3010</b>: Source phone number may not be configured correctly (also possible there may be an upstream carrier outage)</li>\n<li><b>3011</b>: Network error between aggregator & MNO, please contact support for further details</li>\n<li><b>3012</b>: Destination number out of carrier funds for texting at the time (Possibly prepaid user). Check with the end user</li>\n<li><b>3013</b>: Message flagged due to non-compliant URL</li>\n<li><b>3014</b>: Temp TF failure likely due to maintenance update. Please retry sending again a bit later</li>\n<li><b>3015</b>: TCR campaign, which the sender number belongs to, is suspended by MNO</li>\n<li><b>3016</b>: TCR campaign, which the sender number belongs to, is not approved by DCA yet</li>\n<li><b>3017</b>: TCR campaign, which the sender number belongs to, expired or has not been shared with Telgorithm</li>\n<li><b>3018</b>: TCR campaign, which the sender number belongs to, is in erroneous state. Please contact support if the problem persists</li>\n<li><b>3019</b>: Your Telgorithm account has insufficient funds. It has been suspended</li>\n<li><b>3020</b>: You've reached a throughput allowance likely because of unregistered traffics, please resend or await full Campaign Approval</li>\n<li><b>2147483647</b>: Unknown error</li>\n</ul>\n",
            "format": "int32",
            "readOnly": true
          },
          "errorMessage": {
            "type": "string",
            "description": "Error Message."
          }
        },
        "additionalProperties": false,
        "description": "Outbound Messages."
      },
      "OutboundMessageErrorCode": {
        "enum": [
          "NoError",
          "SenderIsInvalid",
          "SenderNotInTheCompany",
          "SenderNotInTcrCampaign",
          "SenderPhoneNotActiveYet",
          "SenderPhonePendingTcrCampaignChange",
          "SenderAllMNOsUnapproved",
          "RecipientIsInvalid",
          "RecipientOptedOut",
          "DestinationError",
          "DestinationTxtInactive",
          "DestinationMmsInactive",
          "TooManyRecipients",
          "RecipientsAreNotUnique",
          "TextIsEmpty",
          "TextIsTooLong",
          "CallbackUrlIsTooLong",
          "PastExpirationTime",
          "InvalidDateFormat",
          "BothToAndRecipientsAreDefined",
          "ConversationMetadataIsTooLong",
          "ConversationMetadataIsNotSupportedForGroupMessages",
          "MediaUrlsInvalid",
          "TooManyMediaUrls",
          "MediaSizeAboveLimit",
          "InvalidCallbackUrl",
          "TcrLimitIsNotEnough",
          "BlockedAsSpam",
          "Rejected",
          "DeliveryFailure",
          "MessageQueueIsFull",
          "MessageSubmittingFailed",
          "UnknownPriority",
          "TollFreeMsgNotSupported",
          "MsgTooLongDestProvider",
          "SourceTnError",
          "ExternalAggregatorNetworkError",
          "DestinationBillingError",
          "NonCompliantUrl",
          "TemporaryFailure",
          "TcrCampaignIsSuspended",
          "TcrCampaignNotApprovedYet",
          "TcrCampaignIsExpired",
          "TcrCampaignError",
          "AccountIsSuspended",
          "UnregisteredTrafficThroughputLimitReached",
          "UnknownError"
        ],
        "type": "string",
        "description": "Outbound message error code.\n<p>Possible values:</p>\n<ul>\n<li><b>NoError</b>: No error</li>\n<li><b>SenderIsInvalid</b>: Sender Phone Number is invalid or undefined</li>\n<li><b>SenderNotInTheCompany</b>: Sender phone number doesn't belong to your company</li>\n<li><b>SenderNotInTcrCampaign</b>: Sender phone number doesn't belong to any TCR campaign</li>\n<li><b>SenderPhoneNotActiveYet</b>: Sender phone number is not active yet</li>\n<li><b>SenderPhonePendingTcrCampaignChange</b>: Sender phone number is in process of changing TCR Campaign</li>\n<li><b>SenderAllMNOsUnapproved</b>: Not all MNO's were selected on currently attached TCR campaign, please re-create TCR campaign with all MNO's selected</li>\n<li><b>RecipientIsInvalid</b>: Recipient Phone Number is invalid or undefined</li>\n<li><b>RecipientOptedOut</b>: Message cannot be sent to the recipient because recipient has opted out</li>\n<li><b>DestinationError</b>: Destination number is currently unable to receive text messages (possibly no reception or handset is turned off). Check with the end user</li>\n<li><b>DestinationTxtInactive</b>: Destination address does not have text messaging services active</li>\n<li><b>DestinationMmsInactive</b>: The receiver's messaging provider likely does not support MMS messages, please check with the end user</li>\n<li><b>TooManyRecipients</b>: Too many recipient Phone Numbers were specified for group MMS, maximum 10 are allowed</li>\n<li><b>RecipientsAreNotUnique</b>: Recipients list contains duplicated elements</li>\n<li><b>TextIsEmpty</b>: Text cannot be empty</li>\n<li><b>TextIsTooLong</b>: Text cannot be longer than 8000 characters</li>\n<li><b>CallbackUrlIsTooLong</b>: Callback url cannot be longer than 512 characters</li>\n<li><b>PastExpirationTime</b>: Expiration time which was provided with the request is in the past</li>\n<li><b>InvalidDateFormat</b>: UTC date-time field in the request body was provided in invalid format</li>\n<li><b>BothToAndRecipientsAreDefined</b>: Both `to` and `recipients` fields are specified. Only one of them can be specified.</li>\n<li><b>ConversationMetadataIsTooLong</b>: Conversation metadata is longer than 2048 characters</li>\n<li><b>ConversationMetadataIsNotSupportedForGroupMessages</b>: Conversation metadata is not supported for group messages</li>\n<li><b>MediaUrlsInvalid</b>: MediaUrls field contains an invalid and/or unreachable URL</li>\n<li><b>TooManyMediaUrls</b>: MediaUrls field can contain up to five items</li>\n<li><b>MediaSizeAboveLimit</b>: Some of the attachments referenced by MediaUrls exceed maximum size limit</li>\n<li><b>InvalidCallbackUrl</b>: Callback url is badly formed, or its scheme is not HTTP nor HTTPS.</li>\n<li><b>TcrLimitIsNotEnough</b>: Message exceeds your Campaign Registry MNO approved throughput limits. The limit specified in TCR Campaign is too low to accomodate a single message</li>\n<li><b>BlockedAsSpam</b>: SPAM blocking: volume/velocity policies reached and content filtering</li>\n<li><b>Rejected</b>: Equivalent to not authorized. Usually because the number may not have SMS enabled for example</li>\n<li><b>DeliveryFailure</b>: Temporarily unable to deliver. Retry or check with the end user</li>\n<li><b>MessageQueueIsFull</b>: Message queue full</li>\n<li><b>MessageSubmittingFailed</b>: Message submitting failed</li>\n<li><b>UnknownPriority</b>: Priority is wrong</li>\n<li><b>TollFreeMsgNotSupported</b>: Destination address does not accept messages from Toll Free Numbers</li>\n<li><b>MsgTooLongDestProvider</b>: Message is too long for receiving provider</li>\n<li><b>SourceTnError</b>: Source phone number may not be configured correctly (also possible there may be an upstream carrier outage)</li>\n<li><b>ExternalAggregatorNetworkError</b>: Network error between aggregator & MNO, please contact support for further details</li>\n<li><b>DestinationBillingError</b>: Destination number out of carrier funds for texting at the time (Possibly prepaid user). Check with the end user</li>\n<li><b>NonCompliantUrl</b>: Message flagged due to non-compliant URL</li>\n<li><b>TemporaryFailure</b>: Temp TF failure likely due to maintenance update. Please retry sending again a bit later</li>\n<li><b>TcrCampaignIsSuspended</b>: TCR campaign, which the sender number belongs to, is suspended by MNO</li>\n<li><b>TcrCampaignNotApprovedYet</b>: TCR campaign, which the sender number belongs to, is not approved by DCA yet</li>\n<li><b>TcrCampaignIsExpired</b>: TCR campaign, which the sender number belongs to, expired or has not been shared with Telgorithm</li>\n<li><b>TcrCampaignError</b>: TCR campaign, which the sender number belongs to, is in erroneous state. Please contact support if the problem persists</li>\n<li><b>AccountIsSuspended</b>: Your Telgorithm account has insufficient funds. It has been suspended</li>\n<li><b>UnregisteredTrafficThroughputLimitReached</b>: You've reached a throughput allowance likely because of unregistered traffics, please resend or await full Campaign Approval</li>\n<li><b>UnknownError</b>: Unknown error</li>\n</ul>\n",
        "example": "RecipientIsInvalid"
      },
      "OutboundMessageModel": {
        "required": [
          "createdOn",
          "errorCode",
          "from",
          "recipients",
          "sid",
          "status",
          "text"
        ],
        "type": "object",
        "properties": {
          "sid": {
            "maxLength": 128,
            "minLength": 1,
            "type": "string",
            "description": "Outbound Message Sid.",
            "example": "OM08d9704f044a2fa13d3faa216fcf4574b64b19be32626243"
          },
          "from": {
            "minLength": 1,
            "type": "string",
            "description": "Sender phone number.",
            "example": "+12145678900"
          },
          "to": {
            "type": "string",
            "description": "Recipient Phone Number. For a group MMS this field is undefined, please use `recipients` instead.",
            "nullable": true,
            "example": "+19876543210"
          },
          "recipients": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/OutboundMessageRecipientModel"
            },
            "description": "Recipients' information which includes Phone Numbers and Carrier names.\nThis field contains more than one element for a group MMS."
          },
          "createdOn": {
            "type": "string",
            "description": "Created date.",
            "format": "date-time"
          },
          "sentOn": {
            "type": "string",
            "description": "The UTC date and time when the message was actually sent out for delivery.",
            "format": "date-time",
            "nullable": true
          },
          "text": {
            "minLength": 1,
            "type": "string",
            "description": "Message text."
          },
          "carrier": {
            "type": "string",
            "description": "Carrier name of `to` number. For group MMS this field is undefined, please use `recipients` instead.",
            "nullable": true
          },
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/OutboundMessageStatus"
              }
            ],
            "description": "Message sending status.\n<p>Possible values:</p>\n<ul>\n<li><b>Queued</b>: Message is queued for sending</li>\n<li><b>Sent</b>: Message is sent</li>\n<li><b>Delivered</b>: Message is sent, and the message is delivered to the recipient</li>\n<li><b>Failed</b>: Sending is failed, the error message is filled</li>\n<li><b>Expired</b>: The message has expiration time and the message couldn't be sent before this time. This may occur due to throttling if lots of outbound messages was queued previously, or during messaging config's sending time periods when messaging is not active.</li>\n</ul>\n"
          },
          "errorCode": {
            "type": "integer",
            "description": "If specified, denotes the error occurred when sending a message.\n<p>Possible values:</p>\n<ul>\n<li><b>0</b>: No error</li>\n<li><b>1</b>: Sender Phone Number is invalid or undefined</li>\n<li><b>2</b>: Sender phone number doesn't belong to your company</li>\n<li><b>3</b>: Sender phone number doesn't belong to any TCR campaign</li>\n<li><b>4</b>: Sender phone number is not active yet</li>\n<li><b>5</b>: Sender phone number is in process of changing TCR Campaign</li>\n<li><b>6</b>: Not all MNO's were selected on currently attached TCR campaign, please re-create TCR campaign with all MNO's selected</li>\n<li><b>1001</b>: Recipient Phone Number is invalid or undefined</li>\n<li><b>1002</b>: Message cannot be sent to the recipient because recipient has opted out</li>\n<li><b>1003</b>: Destination number is currently unable to receive text messages (possibly no reception or handset is turned off). Check with the end user</li>\n<li><b>1004</b>: Destination address does not have text messaging services active</li>\n<li><b>1005</b>: The receiver's messaging provider likely does not support MMS messages, please check with the end user</li>\n<li><b>1006</b>: Too many recipient Phone Numbers were specified for group MMS, maximum 10 are allowed</li>\n<li><b>1007</b>: Recipients list contains duplicated elements</li>\n<li><b>2001</b>: Text cannot be empty</li>\n<li><b>2002</b>: Text cannot be longer than 8000 characters</li>\n<li><b>2003</b>: Callback url cannot be longer than 512 characters</li>\n<li><b>2004</b>: Expiration time which was provided with the request is in the past</li>\n<li><b>2005</b>: UTC date-time field in the request body was provided in invalid format</li>\n<li><b>2006</b>: Both `to` and `recipients` fields are specified. Only one of them can be specified.</li>\n<li><b>2007</b>: Conversation metadata is longer than 2048 characters</li>\n<li><b>2008</b>: Conversation metadata is not supported for group messages</li>\n<li><b>2009</b>: MediaUrls field contains an invalid and/or unreachable URL</li>\n<li><b>2010</b>: MediaUrls field can contain up to five items</li>\n<li><b>2011</b>: Some of the attachments referenced by MediaUrls exceed maximum size limit</li>\n<li><b>2012</b>: Callback url is badly formed, or its scheme is not HTTP nor HTTPS.</li>\n<li><b>3001</b>: Message exceeds your Campaign Registry MNO approved throughput limits. The limit specified in TCR Campaign is too low to accomodate a single message</li>\n<li><b>3002</b>: SPAM blocking: volume/velocity policies reached and content filtering</li>\n<li><b>3003</b>: Equivalent to not authorized. Usually because the number may not have SMS enabled for example</li>\n<li><b>3004</b>: Temporarily unable to deliver. Retry or check with the end user</li>\n<li><b>3005</b>: Message queue full</li>\n<li><b>3006</b>: Message submitting failed</li>\n<li><b>3007</b>: Priority is wrong</li>\n<li><b>3008</b>: Destination address does not accept messages from Toll Free Numbers</li>\n<li><b>3009</b>: Message is too long for receiving provider</li>\n<li><b>3010</b>: Source phone number may not be configured correctly (also possible there may be an upstream carrier outage)</li>\n<li><b>3011</b>: Network error between aggregator & MNO, please contact support for further details</li>\n<li><b>3012</b>: Destination number out of carrier funds for texting at the time (Possibly prepaid user). Check with the end user</li>\n<li><b>3013</b>: Message flagged due to non-compliant URL</li>\n<li><b>3014</b>: Temp TF failure likely due to maintenance update. Please retry sending again a bit later</li>\n<li><b>3015</b>: TCR campaign, which the sender number belongs to, is suspended by MNO</li>\n<li><b>3016</b>: TCR campaign, which the sender number belongs to, is not approved by DCA yet</li>\n<li><b>3017</b>: TCR campaign, which the sender number belongs to, expired or has not been shared with Telgorithm</li>\n<li><b>3018</b>: TCR campaign, which the sender number belongs to, is in erroneous state. Please contact support if the problem persists</li>\n<li><b>3019</b>: Your Telgorithm account has insufficient funds. It has been suspended</li>\n<li><b>3020</b>: You've reached a throughput allowance likely because of unregistered traffics, please resend or await full Campaign Approval</li>\n<li><b>2147483647</b>: Unknown error</li>\n</ul>\n",
            "format": "int32"
          },
          "errorDescription": {
            "type": "string",
            "description": "Additional textual description of the error.",
            "nullable": true
          },
          "callbackUrlOverride": {
            "type": "string",
            "description": "If specified - used for sending outbound messages events to this url.\nIf this url is empty then MessagingConfig urls are used for outbound messages events.",
            "nullable": true
          },
          "segmentCount": {
            "type": "integer",
            "description": "Message segment count.",
            "format": "int32"
          },
          "mediaUrls": {
            "type": "array",
            "items": {
              "type": "string",
              "format": "uri"
            },
            "description": "Media urls of the message. If null or empty - SMS, if any - MMS.",
            "nullable": true,
            "example": null
          },
          "expiresOn": {
            "type": "string",
            "description": "UTC timestamp indicating when the Outbound Message will expire (or expired).",
            "format": "date-time",
            "nullable": true,
            "example": "2025-06-01T15:00:00Z"
          },
          "conversationMetadata": {
            "maxLength": 2048,
            "type": "string",
            "description": "Conversation metadata for this message.",
            "nullable": true
          },
          "fees": {
            "allOf": [
              {
                "$ref": "#/components/schemas/MessageFeesModel"
              }
            ],
            "description": "Message processing fees.",
            "nullable": true
          },
          "dcaStatus": {
            "allOf": [
              {
                "$ref": "#/components/schemas/OutboundMessageDcaStatusModel"
              }
            ],
            "description": "Unified delivery status reported by the DCA.",
            "nullable": true
          },
          "priority": {
            "allOf": [
              {
                "$ref": "#/components/schemas/OutboundMessagePriority"
              }
            ],
            "description": "Message priority.\n<p>Possible values:</p>\n<ul>\n<li><b>Urgent</b>: Urgent</li>\n<li><b>High</b>: High</li>\n<li><b>Normal</b>: Normal</li>\n<li><b>Low</b>: Low</li>\n</ul>\n"
          },
          "brandSid": {
            "type": "string",
            "description": "TCR Brand SID if the sender Phone Number was attached to TCR campaign at the sending moment.",
            "nullable": true
          },
          "campaignSid": {
            "type": "string",
            "description": "TCR Campaign SID if the sender Phone Number was attached to TCR campaign at the sending moment.",
            "nullable": true
          },
          "messagingConfigSid": {
            "type": "string",
            "description": "Messaging Config SID at message sending moment.",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Outbound Message."
      },
      "OutboundMessageModelPaginatedResult": {
        "required": [
          "items"
        ],
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/OutboundMessageModel"
            }
          },
          "searchId": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "OutboundMessagePriority": {
        "enum": [
          "Urgent",
          "High",
          "Normal",
          "Low"
        ],
        "type": "string",
        "description": "\n<p>Possible values:</p>\n<ul>\n<li><b>Urgent</b>: Urgent</li>\n<li><b>High</b>: High</li>\n<li><b>Normal</b>: Normal</li>\n<li><b>Low</b>: Low</li>\n</ul>\n",
        "example": "Low"
      },
      "OutboundMessageRecipientModel": {
        "required": [
          "to"
        ],
        "type": "object",
        "properties": {
          "to": {
            "minLength": 1,
            "type": "string",
            "description": "Recipient Phone Number.",
            "example": "+19876543210"
          },
          "carrier": {
            "type": "string",
            "description": "Carrier name of `to` number.",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "OutboundMessageStatus": {
        "enum": [
          "Queued",
          "Sent",
          "Delivered",
          "Failed",
          "Expired"
        ],
        "type": "string",
        "description": "Message sending status\n<p>Possible values:</p>\n<ul>\n<li><b>Queued</b>: Message is queued for sending</li>\n<li><b>Sent</b>: Message is sent</li>\n<li><b>Delivered</b>: Message is sent, and the message is delivered to the recipient</li>\n<li><b>Failed</b>: Sending is failed, the error message is filled</li>\n<li><b>Expired</b>: The message has expiration time and the message couldn't be sent before this time. This may occur due to throttling if lots of outbound messages was queued previously, or during messaging config's sending time periods when messaging is not active.</li>\n</ul>\n",
        "example": "Queued"
      },
      "PhoneBaseModel": {
        "required": [
          "createdOn",
          "number",
          "voiceStatus"
        ],
        "type": "object",
        "properties": {
          "createdOn": {
            "type": "string",
            "description": "Date when the Phone Number was ordered/ported-in.",
            "format": "date-time"
          },
          "number": {
            "maxLength": 16,
            "type": "string",
            "description": "Phone Number.",
            "example": "+12345678900"
          },
          "name": {
            "maxLength": 1024,
            "type": "string",
            "description": "Phone Number Name to display in the Portal.",
            "nullable": true,
            "example": "My First Phone"
          },
          "messagingConfigSid": {
            "type": "string",
            "description": "Messaging Config Sid.",
            "nullable": true,
            "example": "MCf4f1e0ccde19431ebde74a9f2996afa0"
          },
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/DisplayPhoneStatus"
              }
            ],
            "description": "Phone Status, used in API response models.\n<p>Possible values:</p>\n<ul>\n<li><b>Active</b>: Phone number is ordered and active.</li>\n<li><b>Pending</b>: Phone number is ordering, but not active yet.</li>\n<li><b>PendingPortIn</b>: Phone number is in port-in process.</li>\n<li><b>PendingTcrCampaignChange</b>: Phone number is in process of changing TCR Campaign.</li>\n<li><b>PendingMessagingConfigAdd</b>: Phone number is ordered, but it's not associated with any MessagingConfig.</li>\n<li><b>PendingTcrCampaignAdd</b>: Phone number is ordered, but it's not associated with an approved TCR Campaign.</li>\n<li><b>CanadianTrafficOnly</b>: Phone number belongs to Canada and has no approved TCR Campaign. Only messages to Canada are allowed.</li>\n<li><b>Removed</b>: Phone number is Removed.</li>\n</ul>\n"
          },
          "voiceStatus": {
            "allOf": [
              {
                "$ref": "#/components/schemas/PhoneVoiceServiceStatus"
              }
            ],
            "description": "The status of the Voice Service of the Phone Number.\n<p>Possible values:</p>\n<ul>\n<li><b>OffPlatform</b>: Voice Service is not included in the Telgorithm platform for this Phone Number or Voice Feature is not enabled for your company.</li>\n<li><b>Active</b>: Voice Service is fully active</li>\n<li><b>Pending</b>: Phone Number (including Voice Service) purchase has been started, waiting for completion</li>\n<li><b>PendingPortIn</b>: Phone Number Voice port-in process has been started, waiting for completion</li>\n<li><b>FailedPortIn</b>: Phone Number Voice port-in process has failed: rejected by the carrier</li>\n</ul>\n"
          }
        },
        "additionalProperties": false,
        "description": "Phone Number information."
      },
      "PhoneCountry": {
        "enum": [
          "US",
          "CA"
        ],
        "type": "string",
        "description": "Specifies country where the phone is located\n<p>Possible values:</p>\n<ul>\n<li><b>US</b>: The United States of America</li>\n<li><b>CA</b>: Canada</li>\n</ul>\n"
      },
      "PhoneDetailsMessagingConfigModel": {
        "type": "object",
        "properties": {
          "sid": {
            "type": "string",
            "description": "Messaging Config SID.",
            "nullable": true,
            "example": "MCf4f1e0ccde19431ebde74a9f2996afa0"
          },
          "name": {
            "type": "string",
            "description": "Messaging Config name.",
            "nullable": true,
            "example": "Default outbound config"
          },
          "tcrCampaign": {
            "allOf": [
              {
                "$ref": "#/components/schemas/MessagingConfigTcrCampaignModel"
              }
            ],
            "description": "Linked TCR Campaign details.",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "PhoneDetailsModel": {
        "type": "object",
        "allOf": [
          {
            "$ref": "#/components/schemas/PhoneBaseModel"
          }
        ],
        "properties": {
          "messagingConfig": {
            "allOf": [
              {
                "$ref": "#/components/schemas/PhoneDetailsMessagingConfigModel"
              }
            ],
            "description": "Messaging Config details.",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Detailed Phone Number information for company-facing APIs."
      },
      "PhoneFeatures": {
        "enum": [
          "None",
          "SMS",
          "MMS",
          "VOICE"
        ],
        "type": "string",
        "description": "Phone features.\n<p>Possible values:</p>\n<ul>\n<li><b>None</b>: None.</li>\n<li><b>SMS</b></li>\n<li><b>MMS</b></li>\n<li><b>VOICE</b></li>\n</ul>\n"
      },
      "PhoneListRequest": {
        "required": [
          "phones"
        ],
        "type": "object",
        "properties": {
          "phones": {
            "minItems": 1,
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Company phones."
          }
        },
        "additionalProperties": false,
        "description": "Phone List Request."
      },
      "PhoneMessagingConfigModel": {
        "type": "object",
        "properties": {
          "sid": {
            "type": "string",
            "description": "Messaging Config SID.",
            "nullable": true,
            "example": "MCf4f1e0ccde19431ebde74a9f2996afa0"
          },
          "name": {
            "type": "string",
            "description": "Messaging Config name.",
            "nullable": true,
            "example": "Default outbound config"
          }
        },
        "additionalProperties": false
      },
      "PhoneModel": {
        "type": "object",
        "allOf": [
          {
            "$ref": "#/components/schemas/PhoneBaseModel"
          }
        ],
        "properties": {
          "messagingConfig": {
            "allOf": [
              {
                "$ref": "#/components/schemas/PhoneMessagingConfigModel"
              }
            ],
            "description": "Messaging Config details.",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Phone Number information."
      },
      "PhoneModelPaginatedResult": {
        "required": [
          "items"
        ],
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PhoneModel"
            }
          },
          "searchId": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "PhoneNumberBulkResult": {
        "type": "object",
        "properties": {
          "success": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Successfully processed.",
            "nullable": true,
            "readOnly": true
          },
          "failed": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Not processed.",
            "nullable": true,
            "readOnly": true
          }
        },
        "additionalProperties": false,
        "description": "Successfully processed and failed entities."
      },
      "PhoneNumberType": {
        "enum": [
          "TollFree",
          "TenDlc"
        ],
        "type": "string",
        "description": "\n<p>Possible values:</p>\n<ul>\n<li><b>TollFree</b></li>\n<li><b>TenDlc</b></li>\n</ul>\n"
      },
      "PhoneRequest": {
        "type": "object",
        "properties": {
          "messagingConfigSid": {
            "pattern": "^(MC)[0-9a-f]{32}$",
            "type": "string",
            "description": "Messaging Config Sid.",
            "nullable": true,
            "example": "MCf4f1e0ccde19431ebde74a9f2996afa0"
          },
          "name": {
            "maxLength": 1024,
            "type": "string",
            "description": "Name.",
            "nullable": true,
            "example": "My First Phone"
          }
        },
        "additionalProperties": false,
        "description": "Update Phone Request."
      },
      "PhoneVoiceModel": {
        "required": [
          "number",
          "voiceStatus"
        ],
        "type": "object",
        "properties": {
          "number": {
            "maxLength": 16,
            "type": "string",
            "description": "Phone Number.",
            "example": "+12345678900"
          },
          "name": {
            "maxLength": 1024,
            "type": "string",
            "description": "Phone Number name.",
            "nullable": true,
            "example": "My First Phone"
          },
          "callsForwardedTo": {
            "maxLength": 256,
            "type": "string",
            "description": "<p>\n            If specified, <b>Static Forwarding</b> of Inbound Calls is set up to the provided destination.\n            The destination can be either an E.164 Phone Number or a SIP URI.\n            If is not specified (`null`), <b>Dynamic Forwarding</b> is applied, requiring the\n            `InboundCallReceived` webhook to provide a Call Script on a per-call basis.\n            </p>\n<p>\n            If it is a SIP URI, it must start with the `sip:` or `sips:` prefix, and must be formatted\n            according to RFC 3261 standard. Examples of valid SIP URI:\n            <ul><li>`sip:user@server.com:5060`</li><li>`sip:user@server.com;transport=TLS`</li><li>`sip:user@server.com?header1=value1&header2=value2`</li><li>`sip:user@server.com:5060;transport=TCP?header=value`</li></ul></p>\n<p>\n            ⚠️ <b>To use SIP destinations with Static Forwarding</b>, the receiving system must be configured to accept SIP\n            traffic from the IP addresses below:\n            <ul><li>`137.192.78.201`</li><li>`137.192.80.201`</li></ul></p>\n<p>\n            These IPs should be added to the receiving system’s allowlist or firewall rules to ensure successful call\n            delivery.\n            </p>",
            "example": "+19876543210"
          },
          "recordInboundCalls": {
            "type": "boolean",
            "description": "Determines if all Inbound Calls to this Phone Number should be recorded by default.\nFor numbers with Dynamic Forwarding, this setting can be overridden per call in the Call Script response.",
            "example": "false"
          },
          "voiceStatus": {
            "allOf": [
              {
                "$ref": "#/components/schemas/PhoneVoiceServiceStatus"
              }
            ],
            "description": "The status of the Voice Service of the Phone Number.\n<p>Possible values:</p>\n<ul>\n<li><b>OffPlatform</b>: Voice Service is not included in the Telgorithm platform for this Phone Number or Voice Feature is not enabled for your company.</li>\n<li><b>Active</b>: Voice Service is fully active</li>\n<li><b>Pending</b>: Phone Number (including Voice Service) purchase has been started, waiting for completion</li>\n<li><b>PendingPortIn</b>: Phone Number Voice port-in process has been started, waiting for completion</li>\n<li><b>FailedPortIn</b>: Phone Number Voice port-in process has failed: rejected by the carrier</li>\n</ul>\n"
          }
        },
        "additionalProperties": false,
        "description": "Voice service information."
      },
      "PhoneVoiceRequest": {
        "type": "object",
        "properties": {
          "callsForwardedTo": {
            "maxLength": 256,
            "type": "string",
            "description": "<p>\n            If specified, <b>Static Forwarding</b> of Inbound Calls is set up to the provided destination.\n            The destination can be either an E.164 Phone Number or a SIP URI.\n            If is not specified (`null`), <b>Dynamic Forwarding</b> is applied, requiring the\n            `InboundCallReceived` webhook to provide a Call Script on a per-call basis.\n            </p>\n<p>\n            If it is a SIP URI, it must start with the `sip:` or `sips:` prefix, and must be formatted\n            according to RFC 3261 standard. Examples of valid SIP URI:\n            <ul><li>`sip:user@server.com:5060`</li><li>`sip:user@server.com;transport=TLS`</li><li>`sip:user@server.com?header1=value1&header2=value2`</li><li>`sip:user@server.com:5060;transport=TCP?header=value`</li></ul></p>\n<p>\n            ⚠️ <b>To use SIP destinations with Static Forwarding</b>, the receiving system must be configured to accept SIP\n            traffic from the IP addresses below:\n            <ul><li>`137.192.78.201`</li><li>`137.192.80.201`</li></ul></p>\n<p>\n            These IPs should be added to the receiving system’s allowlist or firewall rules to ensure successful call\n            delivery.\n            </p>",
            "nullable": true,
            "example": "+19876543210"
          },
          "recordInboundCalls": {
            "type": "boolean",
            "description": "Indicates whether all inbound calls to the Phone Number should be recorded by default.\nFor numbers with Dynamic Forwarding, this setting can be overridden per call in the Call Script response.",
            "nullable": true,
            "example": "false"
          }
        },
        "additionalProperties": false,
        "description": "Update voice settings request."
      },
      "PhoneVoiceServiceStatus": {
        "enum": [
          "OffPlatform",
          "Active",
          "Pending",
          "PendingPortIn",
          "FailedPortIn"
        ],
        "type": "string",
        "description": "The status of the Voice Service of the Phone Number.\n<p>Possible values:</p>\n<ul>\n<li><b>OffPlatform</b>: Voice Service is not included in the Telgorithm platform for this Phone Number or Voice Feature is not enabled for your company.</li>\n<li><b>Active</b>: Voice Service is fully active</li>\n<li><b>Pending</b>: Phone Number (including Voice Service) purchase has been started, waiting for completion</li>\n<li><b>PendingPortIn</b>: Phone Number Voice port-in process has been started, waiting for completion</li>\n<li><b>FailedPortIn</b>: Phone Number Voice port-in process has failed: rejected by the carrier</li>\n</ul>\n"
      },
      "PortInOrderModel": {
        "type": "object",
        "properties": {
          "phones": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PhoneModel"
            },
            "description": "Imported phones."
          }
        },
        "additionalProperties": false,
        "description": "Completed Port In order."
      },
      "PortInPhoneAuthModel": {
        "required": [
          "accountNumber",
          "accountPhoneNumber",
          "authorizationDate",
          "authorizerName"
        ],
        "type": "object",
        "properties": {
          "accountNumber": {
            "minLength": 1,
            "type": "string",
            "description": "Account number at the company from which the phone is being ported out.",
            "example": "012345"
          },
          "accountPhoneNumber": {
            "type": "string",
            "description": "Account (or Billing) Phone Number.\nOr the phone number that all of porting numbers may be listed under.",
            "example": "+12145678900"
          },
          "authorizerName": {
            "minLength": 1,
            "type": "string",
            "description": "Name of the person authorizing PortIn process.\nOr the person in charge of the account (admin on the account).",
            "example": "John Smith"
          },
          "authorizationDate": {
            "type": "string",
            "description": "Date of PortIn authorization, must be less than or equal to today’s date.",
            "format": "date",
            "example": "2023-01-01"
          },
          "accountPin": {
            "type": "string",
            "description": "Alphanumeric account PIN or password.",
            "nullable": true,
            "example": "123"
          }
        },
        "additionalProperties": false,
        "description": "Phone PortIn Authorization info"
      },
      "PortInPhoneEndUserModel": {
        "required": [
          "city",
          "name",
          "postalCode",
          "serviceType",
          "state",
          "streetName",
          "streetNumber"
        ],
        "type": "object",
        "properties": {
          "name": {
            "minLength": 1,
            "type": "string",
            "description": "End-User's Name.",
            "example": "John Smith"
          },
          "streetNumber": {
            "minLength": 1,
            "type": "string",
            "description": "End-User's Street Number.",
            "example": "123"
          },
          "streetDirectionPrefix": {
            "allOf": [
              {
                "$ref": "#/components/schemas/EndUserStreetDirection"
              }
            ],
            "description": "End-User's address street direction prefix.\n<p>Possible values:</p>\n<ul>\n<li><b>N</b>: North</li>\n<li><b>S</b>: South</li>\n<li><b>E</b>: East</li>\n<li><b>W</b>: West</li>\n<li><b>NE</b>: North-East</li>\n<li><b>NW</b>: North-West</li>\n<li><b>SE</b>: South-East</li>\n<li><b>SW</b>: South-West</li>\n</ul>\n",
            "nullable": true
          },
          "streetName": {
            "minLength": 1,
            "type": "string",
            "description": "End-User's address street name.",
            "example": "Highland"
          },
          "streetType": {
            "type": "string",
            "description": "End-User's address street type.",
            "nullable": true,
            "example": "St"
          },
          "streetDirectionPostfix": {
            "allOf": [
              {
                "$ref": "#/components/schemas/EndUserStreetDirection"
              }
            ],
            "description": "End-User's address street direction ending.\n<p>Possible values:</p>\n<ul>\n<li><b>N</b>: North</li>\n<li><b>S</b>: South</li>\n<li><b>E</b>: East</li>\n<li><b>W</b>: West</li>\n<li><b>NE</b>: North-East</li>\n<li><b>NW</b>: North-West</li>\n<li><b>SE</b>: South-East</li>\n<li><b>SW</b>: South-West</li>\n</ul>\n",
            "nullable": true
          },
          "locationType1": {
            "type": "string",
            "description": "End-User's address location type 1.",
            "nullable": true,
            "example": "Bld"
          },
          "locationValue1": {
            "type": "string",
            "description": "End-User's address location value 1.",
            "nullable": true,
            "example": "2B"
          },
          "locationType2": {
            "type": "string",
            "description": "End-User's address location type 2.",
            "nullable": true
          },
          "locationValue2": {
            "type": "string",
            "description": "End-User's address location value 2.",
            "nullable": true
          },
          "locationType3": {
            "type": "string",
            "description": "End-User's address location type 3.",
            "nullable": true
          },
          "locationValue3": {
            "type": "string",
            "description": "End-User's address location value 3.",
            "nullable": true
          },
          "city": {
            "minLength": 1,
            "type": "string",
            "description": "End-User's City.\n\n",
            "example": "Los Angeles"
          },
          "state": {
            "maxLength": 2,
            "minLength": 1,
            "type": "string",
            "description": "End-User's US State 2-char abbreviation.\n\n",
            "example": "CA"
          },
          "postalCode": {
            "maxLength": 10,
            "minLength": 5,
            "type": "string",
            "description": "End-User's US 5-10 digits Postal Code.\n\n",
            "example": "12345"
          },
          "serviceType": {
            "allOf": [
              {
                "$ref": "#/components/schemas/EndUserPhoneServiceType"
              }
            ],
            "description": "Is number going to be used by \"Business\" or by \"Residence\".\n<p>Possible values:</p>\n<ul>\n<li><b>Business</b>: Business.</li>\n<li><b>Residence</b>: Residence.</li>\n</ul>\n"
          }
        },
        "additionalProperties": false
      },
      "PortInPhoneFeatures": {
        "enum": [
          "Messaging",
          "Voice",
          "MessagingAndVoice"
        ],
        "type": "string",
        "description": "Phone features requested when porting.\n<p>Possible values:</p>\n<ul>\n<li><b>Messaging</b>: Includes only Messaging (SMS & MMS).</li>\n<li><b>Voice</b>: Includes only Voice.</li>\n<li><b>MessagingAndVoice</b>: Includes Messaging (SMS & MMS) and Voice.</li>\n</ul>\n",
        "example": "Messaging"
      },
      "PortInPhoneModel": {
        "required": [
          "phone"
        ],
        "type": "object",
        "properties": {
          "phone": {
            "type": "string",
            "description": "Phone number.",
            "example": "+12145678900"
          },
          "name": {
            "maxLength": 1024,
            "type": "string",
            "description": "Name.",
            "nullable": true,
            "example": "My Ported Phone"
          },
          "messagingConfigSid": {
            "pattern": "^(MC)[0-9a-f]{32}$",
            "type": "string",
            "description": "Messaging Config Sid to attach phone to.\nRequired for U.S. 10DLC numbers. Must be linked to a non-expired TCR campaign.",
            "nullable": true,
            "example": "MCf4f1e0ccde19431ebde74a9f2996afa0"
          },
          "authorization": {
            "allOf": [
              {
                "$ref": "#/components/schemas/PortInPhoneAuthModel"
              }
            ],
            "description": "PortIn Authorization information.\n\n\nRequired <b>only for 10DLC phones with Features set to MessagingAndVoice</b>.",
            "nullable": true
          },
          "endUser": {
            "allOf": [
              {
                "$ref": "#/components/schemas/PortInPhoneEndUserModel"
              }
            ],
            "description": "End-User's information.\n\n\nRequired <b>only for 10DLC phones with Features set to MessagingAndVoice</b>.",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "PortIn phone model."
      },
      "PortInPhonesModel": {
        "required": [
          "features",
          "phones"
        ],
        "type": "object",
        "properties": {
          "phones": {
            "maxItems": 2000,
            "minItems": 1,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PortInPhoneModel"
            },
            "description": "Phones collection to port in."
          },
          "features": {
            "allOf": [
              {
                "$ref": "#/components/schemas/PortInPhoneFeatures"
              }
            ],
            "description": "Sets features to port in.\n<p>Possible values:</p>\n<ul>\n<li><b>Messaging</b>: Includes only Messaging (SMS & MMS).</li>\n<li><b>Voice</b>: Includes only Voice.</li>\n<li><b>MessagingAndVoice</b>: Includes Messaging (SMS & MMS) and Voice.</li>\n</ul>\n"
          }
        },
        "additionalProperties": false,
        "description": "PortIn data model.\n See PortInPhonesModel model."
      },
      "PortInRequest": {
        "required": [
          "data",
          "files"
        ],
        "type": "object",
        "properties": {
          "data": {
            "allOf": [
              {
                "$ref": "#/components/schemas/PortInPhonesModel"
              }
            ],
            "description": "PortIn data model."
          },
          "files": {
            "minItems": 1,
            "type": "array",
            "items": {
              "type": "string",
              "format": "binary"
            },
            "description": "LOA Files"
          }
        },
        "additionalProperties": false
      },
      "ProblemDetails": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string"
          },
          "title": {
            "type": "string"
          },
          "status": {
            "type": "integer",
            "format": "int32"
          },
          "detail": {
            "type": "string",
            "nullable": true
          },
          "instance": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": { }
      },
      "RcsCardAlignment": {
        "enum": [
          "Left",
          "Right"
        ],
        "type": "string",
        "description": "\n<p>Possible values:</p>\n<ul>\n<li><b>Left</b></li>\n<li><b>Right</b></li>\n</ul>\n"
      },
      "RcsCardModel": {
        "type": "object",
        "properties": {
          "title": {
            "maxLength": 200,
            "type": "string",
            "description": "Title of the card.",
            "nullable": true,
            "example": "Welcome!"
          },
          "description": {
            "maxLength": 2000,
            "type": "string",
            "description": "Body text of the card.",
            "nullable": true,
            "example": "Check out our latest offer."
          },
          "media": {
            "allOf": [
              {
                "$ref": "#/components/schemas/RcsMediaModel"
              }
            ],
            "description": "Media (image or video) to display in the card.",
            "nullable": true
          },
          "suggestions": {
            "maxItems": 4,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RcsSuggestionModel"
            },
            "description": "Suggested replies or actions attached to this card.",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "A rich card containing optional title, description, media, and suggested actions."
      },
      "RcsCardOrientation": {
        "enum": [
          "Horizontal",
          "Vertical"
        ],
        "type": "string",
        "description": "\n<p>Possible values:</p>\n<ul>\n<li><b>Horizontal</b></li>\n<li><b>Vertical</b></li>\n</ul>\n"
      },
      "RcsCardWidth": {
        "enum": [
          "Small",
          "Medium"
        ],
        "type": "string",
        "description": "\n<p>Possible values:</p>\n<ul>\n<li><b>Small</b></li>\n<li><b>Medium</b></li>\n</ul>\n"
      },
      "RcsContentModel": {
        "required": [
          "alignment",
          "cards",
          "cardWidth",
          "file",
          "orientation",
          "text",
          "type"
        ],
        "type": "object",
        "properties": {
          "type": {
            "allOf": [
              {
                "$ref": "#/components/schemas/RcsContentType"
              }
            ],
            "description": "Content type of the RCS message.\n<p>Possible values:</p>\n<ul>\n<li><b>Text</b></li>\n<li><b>File</b></li>\n<li><b>Card</b></li>\n<li><b>Carousel</b></li>\n</ul>\n"
          },
          "text": {
            "maxLength": 3072,
            "minLength": 1,
            "type": "string",
            "description": "Text body of the message. Required when `type` is `Text`.",
            "example": "Hello from RCS!"
          },
          "file": {
            "allOf": [
              {
                "$ref": "#/components/schemas/RcsFileModel"
              }
            ],
            "description": "File content. Required when `type` is `File`."
          },
          "cards": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RcsCardModel"
            },
            "description": "Card(s) to include. Exactly one card required when `type` is `Card`;\n2–10 cards required when `type` is `Carousel`."
          },
          "suggestions": {
            "maxItems": 11,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RcsSuggestionModel"
            },
            "description": "Suggested replies or actions shown below the message.",
            "nullable": true
          },
          "orientation": {
            "allOf": [
              {
                "$ref": "#/components/schemas/RcsCardOrientation"
              }
            ],
            "description": "Orientation type defines orientation in `Card` message.\nRequired when `type` is `Card`.\n<p>Possible values:</p>\n<ul>\n<li><b>Horizontal</b></li>\n<li><b>Vertical</b></li>\n</ul>\n"
          },
          "alignment": {
            "allOf": [
              {
                "$ref": "#/components/schemas/RcsCardAlignment"
              }
            ],
            "description": "Image preview alignment for `Card` message with horizontal layout.\nRequired when `type` is `Card`.\n<p>Possible values:</p>\n<ul>\n<li><b>Left</b></li>\n<li><b>Right</b></li>\n</ul>\n"
          },
          "cardWidth": {
            "allOf": [
              {
                "$ref": "#/components/schemas/RcsCardWidth"
              }
            ],
            "description": "Width of cards contained within the `carousel`.\nRequired when `type` is `Carousel`.\n<p>Possible values:</p>\n<ul>\n<li><b>Small</b></li>\n<li><b>Medium</b></li>\n</ul>\n"
          }
        },
        "additionalProperties": false,
        "description": "RCS message content. The `type` field determines which other fields are required."
      },
      "RcsContentType": {
        "enum": [
          "Text",
          "File",
          "Card",
          "Carousel"
        ],
        "type": "string",
        "description": "\n<p>Possible values:</p>\n<ul>\n<li><b>Text</b></li>\n<li><b>File</b></li>\n<li><b>Card</b></li>\n<li><b>Carousel</b></li>\n</ul>\n"
      },
      "RcsEventItem": {
        "required": [
          "type"
        ],
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "description": "Type of the event to dispatch"
          }
        },
        "additionalProperties": false,
        "description": "A single RCS outbound event to dispatch",
        "discriminator": {
          "propertyName": "type",
          "mapping": {
            "Seen": "#/components/schemas/RcsSeenEventItem",
            "TypingIndicator": "#/components/schemas/RcsTypingIndicatorEventItem"
          }
        }
      },
      "RcsEventType": {
        "enum": [
          "Seen",
          "TypingIndicator"
        ],
        "type": "string",
        "description": "Type of RCS outbound event submitted by the customer\n<p>Possible values:</p>\n<ul>\n<li><b>Seen</b>: The customer's agent has read an inbound RCS message; notify the end-user</li>\n<li><b>TypingIndicator</b>: The customer's agent is typing a message</li>\n</ul>\n"
      },
      "RcsFallbackModel": {
        "required": [
          "from"
        ],
        "type": "object",
        "properties": {
          "from": {
            "type": "string",
            "description": "Sender phone number for the fallback SMS/MMS. Must be one of the Phone Numbers owned by you.",
            "example": "+12145678900"
          },
          "text": {
            "maxLength": 8000,
            "type": "string",
            "description": "Text of the fallback message. Can be empty only when `mediaUrls` is set.",
            "nullable": true,
            "example": "Glad to see you!"
          },
          "priority": {
            "allOf": [
              {
                "$ref": "#/components/schemas/OutboundMessagePriority"
              }
            ],
            "description": "Priority of the fallback message. `Normal` if not specified.\n<p>Possible values:</p>\n<ul>\n<li><b>Urgent</b>: Urgent</li>\n<li><b>High</b>: High</li>\n<li><b>Normal</b>: Normal</li>\n<li><b>Low</b>: Low</li>\n</ul>\n",
            "nullable": true,
            "example": "Normal"
          },
          "mediaUrls": {
            "maxItems": 5,
            "type": "array",
            "items": {
              "type": "string",
              "format": "uri"
            },
            "description": "Attachment URLs for the fallback message. If set, the fallback is treated as MMS.",
            "nullable": true,
            "example": null
          },
          "callbackUrlOverride": {
            "type": "string",
            "description": "If specified, fallback message delivery events will be sent to this URL.",
            "format": "uri",
            "nullable": true
          },
          "expiresOn": {
            "type": "string",
            "description": "UTC timestamp indicating when the fallback message will expire.\nIf `null` or exceeds 72 hours from submission, it will be overwritten to 72 hours from submission time.",
            "format": "date-time",
            "nullable": true,
            "example": "2025-06-01T15:00:00Z"
          },
          "conversationMetadata": {
            "maxLength": 2048,
            "type": "string",
            "description": "Conversation metadata value for the fallback SMS message. This metadata will be set to the conversation between\nthe Phone Number specified by `From` field in this object and `To` field in the parent RCS message\nobject. The metadata specified for the RCS message is not inherited by fallback messages and must be explicitly\nset by this field if needed.",
            "nullable": true
          },
          "ignoreSendingTimes": {
            "type": "boolean",
            "description": "If `true`, the fallback message will be sent regardless of Time Routing configured for the Messaging Config.",
            "nullable": true,
            "example": false
          }
        },
        "additionalProperties": false,
        "description": "SMS/MMS fallback payload sent when RCS delivery fails after all retry attempts."
      },
      "RcsFallbackType": {
        "enum": [
          "None",
          "Sms",
          "Mms",
          "AiGenerated"
        ],
        "type": "string",
        "description": "Type of fallback message configured for an RCS outbound message.\n<p>Possible values:</p>\n<ul>\n<li><b>None</b>: No fallback message is configured.</li>\n<li><b>Sms</b>: SMS fallback message is configured.</li>\n<li><b>Mms</b>: MMS fallback message is configured.</li>\n<li><b>AiGenerated</b>: AI-generated fallback message is configured.</li>\n</ul>\n"
      },
      "RcsFileModel": {
        "required": [
          "url"
        ],
        "type": "object",
        "properties": {
          "url": {
            "type": "string",
            "description": "Publicly accessible URL of the file to send.\nFor video files, `thumbnail` is required.",
            "format": "uri",
            "example": "https://example.com/image.jpg"
          },
          "thumbnail": {
            "type": "string",
            "description": "Publicly accessible URL of the thumbnail image.\nRequired when the file is a video (mp4, mpeg, mov, avi, webm, 3gp, etc.).",
            "format": "uri",
            "nullable": true,
            "example": "https://example.com/thumbnail.jpg"
          }
        },
        "additionalProperties": false,
        "description": "A file attachment for an RCS message."
      },
      "RcsInboundContentType": {
        "enum": [
          "Text",
          "Suggestion",
          "File",
          "Location"
        ],
        "type": "string",
        "description": "\n<p>Possible values:</p>\n<ul>\n<li><b>Text</b></li>\n<li><b>Suggestion</b></li>\n<li><b>File</b></li>\n<li><b>Location</b></li>\n</ul>\n"
      },
      "RcsInboundMessageContentModel": {
        "type": "object",
        "properties": {
          "type": {
            "allOf": [
              {
                "$ref": "#/components/schemas/RcsInboundContentType"
              }
            ],
            "description": "Content type.\n<p>Possible values:</p>\n<ul>\n<li><b>Text</b></li>\n<li><b>Suggestion</b></li>\n<li><b>File</b></li>\n<li><b>Location</b></li>\n</ul>\n"
          },
          "text": {
            "type": "string",
            "description": "Message body for text and suggestion content.",
            "nullable": true
          },
          "postbackData": {
            "type": "string",
            "description": "Postback data associated with a suggestion click.",
            "nullable": true
          },
          "url": {
            "type": "string",
            "description": "URL of the file sent in an incoming message.",
            "nullable": true
          },
          "contentType": {
            "type": "string",
            "description": "Content type of the file sent in an incoming message.",
            "nullable": true
          },
          "fileName": {
            "type": "string",
            "description": "Name of the file sent in an incoming message.",
            "nullable": true
          },
          "size": {
            "type": "integer",
            "description": "Size of the file sent in an incoming message, in bytes.",
            "format": "int64",
            "nullable": true
          },
          "latitude": {
            "type": "number",
            "description": "Latitude of the shared location.",
            "format": "double",
            "nullable": true
          },
          "longitude": {
            "type": "number",
            "description": "Longitude of the shared location.",
            "format": "double",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "RcsInboundMessageModel": {
        "required": [
          "agentId",
          "createdOn",
          "from",
          "sid"
        ],
        "type": "object",
        "properties": {
          "sid": {
            "maxLength": 128,
            "minLength": 1,
            "type": "string",
            "description": "Inbound RCS Message Sid.",
            "example": "RI08d9704f044a2fa13d3faa216fcf4574b64b19be32626243"
          },
          "from": {
            "type": "string",
            "description": "Sender phone number.",
            "example": "+19876543210"
          },
          "agentId": {
            "maxLength": 40,
            "minLength": 1,
            "type": "string",
            "description": "Recipient Agent ID (RCS identity).",
            "example": "TestAgent"
          },
          "createdOn": {
            "type": "string",
            "description": "Created date.",
            "format": "date-time",
            "example": "2026-01-01T00:00:00Z"
          },
          "content": {
            "allOf": [
              {
                "$ref": "#/components/schemas/RcsInboundMessageContentModel"
              }
            ],
            "description": "The rich media and text payload for the RCS message. Populated only when `IncludeContent=true`.",
            "nullable": true
          },
          "conversationMetadata": {
            "maxLength": 2048,
            "type": "string",
            "description": "Conversation metadata for this RCS message. Populated only when `IncludeConversationMetadata=true`.\n\nConversation metadata can be specified when sending an outbound RCS message. Our system automatically\nfills the metadata value for an inbound RCS message if it comes from the same recipient to the same RCS agent,\nusing the value provided with the most recent outbound RCS message to that recipient from that RCS agent.",
            "nullable": true
          },
          "fees": {
            "allOf": [
              {
                "$ref": "#/components/schemas/RcsMessageFeesModel"
              }
            ],
            "description": "Message processing fees. Populated only when `IncludeFees=true`.",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "RCS inbound message."
      },
      "RcsInboundMessageModelPaginatedResult": {
        "required": [
          "items"
        ],
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RcsInboundMessageModel"
            }
          },
          "searchId": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "RcsMediaHeight": {
        "enum": [
          "Short",
          "Medium",
          "Tall"
        ],
        "type": "string",
        "description": "\n<p>Possible values:</p>\n<ul>\n<li><b>Short</b></li>\n<li><b>Medium</b></li>\n<li><b>Tall</b></li>\n</ul>\n"
      },
      "RcsMediaModel": {
        "required": [
          "file"
        ],
        "type": "object",
        "properties": {
          "file": {
            "allOf": [
              {
                "$ref": "#/components/schemas/RcsFileModel"
              }
            ],
            "description": "The file to display as card media."
          },
          "mediaHeight": {
            "allOf": [
              {
                "$ref": "#/components/schemas/RcsMediaHeight"
              }
            ],
            "description": "Height of the media area in the card.\n<p>Possible values:</p>\n<ul>\n<li><b>Short</b></li>\n<li><b>Medium</b></li>\n<li><b>Tall</b></li>\n</ul>\n",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Media content (image or video) displayed inside a rich card."
      },
      "RcsMessageFeesModel": {
        "type": "object",
        "properties": {
          "platformFees": {
            "type": "array",
            "items": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/FeeGroupModel"
                },
                {
                  "$ref": "#/components/schemas/SegmentsGroupModel"
                }
              ],
              "description": "Group of units billed under the same price tier."
            },
            "description": "Per-group information on Telgorithm Platform fees.",
            "nullable": true
          },
          "passThroughFees": {
            "type": "array",
            "items": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/FeeGroupModel"
                },
                {
                  "$ref": "#/components/schemas/SegmentsGroupModel"
                }
              ],
              "description": "Group of units billed under the same price tier."
            },
            "description": "Per-group information on Telgorithm Pass-Through fees.",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Contains information on message processing fees.\nThere may be different platform fees per group due to tiered pricing."
      },
      "RcsMessageItem": {
        "required": [
          "agentId",
          "content",
          "to"
        ],
        "type": "object",
        "properties": {
          "agentId": {
            "maxLength": 40,
            "minLength": 1,
            "type": "string",
            "description": "RCS agent ID used as the sender. Must be an active RCS agent owned by your account.",
            "example": "TestAgent"
          },
          "to": {
            "type": "string",
            "description": "Recipient phone number in E.164 format.",
            "example": "+19876543210"
          },
          "content": {
            "allOf": [
              {
                "$ref": "#/components/schemas/RcsContentModel"
              }
            ],
            "description": "RCS message content. The `type` field determines which content fields are required."
          },
          "fallback": {
            "allOf": [
              {
                "$ref": "#/components/schemas/RcsFallbackModel"
              }
            ],
            "description": "Optional SMS/MMS fallback payload. If specified and RCS delivery fails after all retries,\nthe message is re-sent as SMS or MMS using this payload."
          },
          "callbackUrlOverride": {
            "maxLength": 512,
            "type": "string",
            "description": "If specified, RCS message delivery events will be sent to this URL.",
            "format": "uri",
            "nullable": true
          },
          "conversationMetadata": {
            "maxLength": 2048,
            "type": "string",
            "description": "Specifies new metadata value for this and subsequent messages in the current conversation.\n\nConversation metadata is an arbitrary text value\nassociated with an RCS conversation between a particular RCS agent (Sender), registered in our system,\nand an external phone number.\nOnce specified, all subsequent RCS Messages (both Inbound and Outbound) in the same conversation\nwill get this metadata value.\nConversation metadata can be overridden multiple times,\nbut this does not affect previous RCS messages in the conversation, only future messages are affected.\nNote that conversation metadata is not inherited by fallback SMS messages which are sent in case an RCS message\ncannot be delivered. You need to specify the metadata for those messages separately.",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "A single RCS message to send."
      },
      "RcsOpenUrlApplication": {
        "enum": [
          "Browser",
          "Webview"
        ],
        "type": "string",
        "description": "\n<p>Possible values:</p>\n<ul>\n<li><b>Browser</b>: Browser will be used on a mobile phone to open URL. If application not specified or if device does not support webviews, URL will be opened using browser.</li>\n<li><b>Webview</b>: Integrated webview window will be used on a mobile phone to open URL.</li>\n</ul>\n"
      },
      "RcsOutboundMessageModel": {
        "required": [
          "agentId",
          "createdOn",
          "fallbackType",
          "sid",
          "status",
          "to"
        ],
        "type": "object",
        "properties": {
          "sid": {
            "maxLength": 128,
            "minLength": 1,
            "type": "string",
            "description": "Outbound RCS Message Sid.",
            "example": "RO08d9704f044a2fa13d3faa216fcf4574b64b19be32626243"
          },
          "agentId": {
            "maxLength": 40,
            "minLength": 1,
            "type": "string",
            "description": "Sender Agent ID (RCS identity).",
            "example": "TestAgent"
          },
          "to": {
            "type": "string",
            "description": "Recipient phone number.",
            "example": "+19876543210"
          },
          "createdOn": {
            "type": "string",
            "description": "Created date.",
            "format": "date-time",
            "example": "2026-01-01T00:00:00Z"
          },
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/RcsOutboundMessageStatus"
              }
            ],
            "description": "Message sending status.\n<p>Possible values:</p>\n<ul>\n<li><b>Queued</b>: Message is queued for sending.</li>\n<li><b>Sent</b>: Message was accepted by the upstream provider.</li>\n<li><b>Delivered</b>: Message was delivered to the recipient.</li>\n<li><b>FallbackTriggered</b>: RCS delivery failed and SMS/MMS fallback was triggered.</li>\n<li><b>Failed</b>: Sending failed: spam filter blocked, retries exhausted, or non-retryable provider error.</li>\n</ul>\n"
          },
          "callbackUrlOverride": {
            "type": "string",
            "description": "Webhook URL used for this specific RCS message.",
            "nullable": true,
            "example": "https://example.com/rcs-callback"
          },
          "fallbackType": {
            "allOf": [
              {
                "$ref": "#/components/schemas/RcsFallbackType"
              }
            ],
            "description": "Type of fallback message configured for this RCS message.\n<p>Possible values:</p>\n<ul>\n<li><b>None</b>: No fallback message is configured.</li>\n<li><b>Sms</b>: SMS fallback message is configured.</li>\n<li><b>Mms</b>: MMS fallback message is configured.</li>\n<li><b>AiGenerated</b>: AI-generated fallback message is configured.</li>\n</ul>\n"
          },
          "seenOn": {
            "type": "string",
            "description": "UTC date and time when the user opened the message.",
            "format": "date-time",
            "nullable": true
          },
          "content": {
            "allOf": [
              {
                "$ref": "#/components/schemas/RcsContentModel"
              }
            ],
            "description": "The rich media and text payload for the RCS message. Populated only when `IncludeContent=true`.",
            "nullable": true
          },
          "conversationMetadata": {
            "maxLength": 2048,
            "type": "string",
            "description": "Conversation metadata for this RCS message. Populated only when `IncludeConversationMetadata=true`.\n\nConversation metadata can be specified when sending an outbound RCS message. If not specified, our system\nautomatically fills the metadata value for a new outbound RCS message if it comes from the same RCS agent to\nthe same recipient, using the value provided with the most recent outbound RCS message from the conversation.",
            "nullable": true
          },
          "fees": {
            "allOf": [
              {
                "$ref": "#/components/schemas/RcsMessageFeesModel"
              }
            ],
            "description": "Message processing fees. Populated only when `IncludeFees=true`.",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "RCS outbound message."
      },
      "RcsOutboundMessageModelPaginatedResult": {
        "required": [
          "items"
        ],
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RcsOutboundMessageModel"
            }
          },
          "searchId": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "RcsOutboundMessageResultItem": {
        "type": "object",
        "properties": {
          "sid": {
            "type": "string"
          }
        },
        "additionalProperties": false
      },
      "RcsOutboundMessageStatus": {
        "enum": [
          "Queued",
          "Sent",
          "Delivered",
          "FallbackTriggered",
          "Failed"
        ],
        "type": "string",
        "description": "RCS outbound message sending status.\n<remarks>```\n                                 RCS Status diagram:\n╔═══════════════════════════════════════════════════════════════════════════════════╗\n║                                      ( POST /v1/Rcs )                             ║\n║                                             │                                     ║\n║                                        ┌────▼────┐                                ║\n║                                        │ Queued  │                                ║\n║                                        └─────────┘                                ║\n║                                        SPAM_filter                                ║\n║                          ┌──success───┘           └──Internal_spam_block─┐        ║\n║                          ▼                                               │        ║\n║                     ┌─────────┐                                          │        ║\n║                     │  Sent   │                                          │        ║\n║                     └────┬────┘                                          │        ║\n║                          │                                               │        ║\n║              ┌───────────┼───────────────────────────┐                   │        ║\n║              │           │                           │                   │        ║\n║        DLR_Delivered  DLR_Rejected          DLR_Spam_(7016,_607)         │        ║\n║              │         (Non-Spam)      or_(Sync_5xx_and_fallback=null)   │        ║\n║              │           │                           │                   │        ║\n║              ▼           ▼                           ▼                   ▼        ║\n║        ┌───────────┐ ┌───────────────────┐         ┌───────────────────────┐      ║\n║        │ Delivered │ │ FallbackTriggered │         │        Failed         │      ║\n║        └───(End)───┘ └───────(End)───────┘         └─────────(End)─────────┘      ║\n╚═══════════════════════════════════════════════════════════════════════════════════╝\n```</remarks>\n<p>Possible values:</p>\n<ul>\n<li><b>Queued</b>: Message is queued for sending.</li>\n<li><b>Sent</b>: Message was accepted by the upstream provider.</li>\n<li><b>Delivered</b>: Message was delivered to the recipient.</li>\n<li><b>FallbackTriggered</b>: RCS delivery failed and SMS/MMS fallback was triggered.</li>\n<li><b>Failed</b>: Sending failed: spam filter blocked, retries exhausted, or non-retryable provider error.</li>\n</ul>\n",
        "example": "Queued"
      },
      "RcsSeenEventItem": {
        "required": [
          "messageSid"
        ],
        "type": "object",
        "allOf": [
          {
            "$ref": "#/components/schemas/RcsEventItem"
          }
        ],
        "properties": {
          "type": {
            "enum": [
              "Seen"
            ],
            "type": "string",
            "description": "Type of RCS outbound event submitted by the customer",
            "example": "Seen"
          },
          "messageSid": {
            "minLength": 1,
            "pattern": "^(RI)[0-9a-f]{48}$",
            "type": "string",
            "description": "Sid of the inbound RCS message that this event refers to",
            "example": "RIa1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3f4"
          }
        },
        "additionalProperties": false,
        "description": "Notification that an inbound RCS message has been seen"
      },
      "RcsSuggestionModel": {
        "required": [
          "endTime",
          "latitude",
          "longitude",
          "phoneNumber",
          "postbackData",
          "startTime",
          "text",
          "title",
          "type",
          "url",
          "webviewViewMode"
        ],
        "type": "object",
        "properties": {
          "type": {
            "allOf": [
              {
                "$ref": "#/components/schemas/RcsSuggestionType"
              }
            ],
            "description": "Type of suggestion. Determines which additional fields are required.\n<p>Possible values:</p>\n<ul>\n<li><b>Reply</b></li>\n<li><b>OpenUrl</b></li>\n<li><b>DialPhone</b></li>\n<li><b>ShowLocation</b></li>\n<li><b>RequestLocation</b></li>\n<li><b>CreateCalendarEvent</b></li>\n</ul>\n"
          },
          "text": {
            "maxLength": 25,
            "minLength": 1,
            "type": "string",
            "description": "Display label shown to the user on the suggestion chip.",
            "example": "Yes, please!"
          },
          "postbackData": {
            "maxLength": 2024,
            "minLength": 1,
            "type": "string",
            "description": "Payload sent back to the server when the user taps the suggestion.",
            "example": "reply_yes"
          },
          "url": {
            "type": "string",
            "description": "URL to open. Required for `OpenUrl` type.",
            "format": "uri",
            "example": "https://example.com"
          },
          "phoneNumber": {
            "type": "string",
            "description": "Phone number to dial. Required for `DialPhone` type.",
            "example": "+19876543210"
          },
          "latitude": {
            "maximum": 90,
            "minimum": -90,
            "type": "number",
            "description": "Latitude of the location to view. Required for `ShowLocation` type.",
            "format": "double",
            "example": 37.422
          },
          "longitude": {
            "maximum": 180,
            "minimum": -180,
            "type": "number",
            "description": "Longitude of the location to view. Required for `ShowLocation` type.",
            "format": "double",
            "example": -122.08406
          },
          "label": {
            "type": "string",
            "description": "Location label displayed on the map. Used with `ShowLocation` type.",
            "nullable": true,
            "example": "Googleplex"
          },
          "startTime": {
            "type": "string",
            "description": "Start time of the calendar event. Required for `CreateCalendarEvent` type.",
            "format": "date-time",
            "example": "2030-03-03T15:00:00.000+01:00"
          },
          "endTime": {
            "type": "string",
            "description": "End time of the calendar event. Required for `CreateCalendarEvent` type.",
            "format": "date-time",
            "example": "2030-03-03T17:00:00.000+01:00"
          },
          "title": {
            "minLength": 1,
            "type": "string",
            "description": "Title of the calendar event. Used with `CreateCalendarEvent` type.",
            "example": "Team Meeting"
          },
          "description": {
            "type": "string",
            "description": "Description of the calendar event. Used with `CreateCalendarEvent` type.",
            "nullable": true,
            "example": "Q2 planning sync"
          },
          "application": {
            "allOf": [
              {
                "$ref": "#/components/schemas/RcsOpenUrlApplication"
              }
            ],
            "description": "Type of the URL open application. It is used to define how URL will be opened on a mobile phone.\nCan be used only for `OpenUrl` type to override the default behavior (`Browser`).\n<p>Possible values:</p>\n<ul>\n<li><b>Browser</b>: Browser will be used on a mobile phone to open URL. If application not specified or if device does not support webviews, URL will be opened using browser.</li>\n<li><b>Webview</b>: Integrated webview window will be used on a mobile phone to open URL.</li>\n</ul>\n",
            "nullable": true
          },
          "webviewViewMode": {
            "allOf": [
              {
                "$ref": "#/components/schemas/RcsWebviewViewMode"
              }
            ],
            "description": "Webview display mode.\nCan be used only for `OpenUrl` and must be defined when application is set to `Webview`.\n<p>Possible values:</p>\n<ul>\n<li><b>Full</b></li>\n<li><b>Half</b></li>\n<li><b>Tall</b></li>\n</ul>\n"
          }
        },
        "additionalProperties": false,
        "description": "A suggested reply or action displayed below an RCS message or card."
      },
      "RcsSuggestionType": {
        "enum": [
          "Reply",
          "OpenUrl",
          "DialPhone",
          "ShowLocation",
          "RequestLocation",
          "CreateCalendarEvent"
        ],
        "type": "string",
        "description": "\n<p>Possible values:</p>\n<ul>\n<li><b>Reply</b></li>\n<li><b>OpenUrl</b></li>\n<li><b>DialPhone</b></li>\n<li><b>ShowLocation</b></li>\n<li><b>RequestLocation</b></li>\n<li><b>CreateCalendarEvent</b></li>\n</ul>\n"
      },
      "RcsTypingIndicatorEventItem": {
        "required": [
          "agentId",
          "to"
        ],
        "type": "object",
        "allOf": [
          {
            "$ref": "#/components/schemas/RcsEventItem"
          }
        ],
        "properties": {
          "type": {
            "enum": [
              "TypingIndicator"
            ],
            "type": "string",
            "description": "Type of RCS outbound event submitted by the customer",
            "example": "TypingIndicator"
          },
          "agentId": {
            "minLength": 1,
            "type": "string",
            "description": "Agent ID initiating the event"
          },
          "to": {
            "type": "string",
            "description": "Recipient phone number"
          }
        },
        "additionalProperties": false,
        "description": "Notification that an RCS agent is typing a message"
      },
      "RcsWebviewViewMode": {
        "enum": [
          "Full",
          "Half",
          "Tall"
        ],
        "type": "string",
        "description": "\n<p>Possible values:</p>\n<ul>\n<li><b>Full</b></li>\n<li><b>Half</b></li>\n<li><b>Tall</b></li>\n</ul>\n"
      },
      "SegmentsGroupModel": {
        "type": "object",
        "allOf": [
          {
            "$ref": "#/components/schemas/FeeGroupModel"
          }
        ],
        "properties": {
          "feePerSegment": {
            "type": "number",
            "description": "Fee per segment.\nThis value is positive or zero.",
            "format": "decimal",
            "readOnly": true,
            "deprecated": true
          }
        },
        "additionalProperties": false,
        "description": "Represents group of message segments billed under the same price tier."
      },
      "SendingTimesModel": {
        "required": [
          "periods",
          "timeZoneId"
        ],
        "type": "object",
        "properties": {
          "timeZoneId": {
            "minLength": 1,
            "type": "string",
            "description": "Specifies the ID of the time zone which is used for time values defined in `periods`.\n<p>Possible values:</p>\n<ul>\n<li><b>America/Juneau</b></li>\n<li><b>America/Los_Angeles</b></li>\n<li><b>America/Denver</b></li>\n<li><b>America/Chicago</b></li>\n<li><b>America/New_York</b></li>\n<li><b>UTC-12:00</b></li>\n<li><b>UTC-11:00</b></li>\n<li><b>UTC-10:00</b></li>\n<li><b>UTC-09:00</b></li>\n<li><b>UTC-08:00</b></li>\n<li><b>UTC-07:00</b></li>\n<li><b>UTC-06:00</b></li>\n<li><b>UTC-05:00</b></li>\n<li><b>UTC-04:00</b></li>\n<li><b>UTC-03:00</b></li>\n<li><b>UTC-02:00</b></li>\n<li><b>UTC-01:00</b></li>\n<li><b>UTC+00:00</b></li>\n<li><b>UTC+01:00</b></li>\n<li><b>UTC+02:00</b></li>\n<li><b>UTC+03:00</b></li>\n<li><b>UTC+04:00</b></li>\n<li><b>UTC+05:00</b></li>\n<li><b>UTC+06:00</b></li>\n<li><b>UTC+07:00</b></li>\n<li><b>UTC+08:00</b></li>\n<li><b>UTC+09:00</b></li>\n<li><b>UTC+10:00</b></li>\n<li><b>UTC+11:00</b></li>\n<li><b>UTC+12:00</b></li>\n<li><b>UTC+13:00</b></li>\n<li><b>UTC+14:00</b></li>\n</ul>\n",
            "example": "America/Los_Angeles"
          },
          "periods": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SendingTimesPeriodModel"
            },
            "description": "Specifies the set of time periods in the specified time zone when the messaging should be active.\nPeriods must not intersect or touch. The last period may have `to` less than `from` indicating\nthat the period crosses the midnight."
          }
        },
        "additionalProperties": false,
        "description": "Specifies the time zone and time periods in a day when the messaging should be active.\nSMS and MMS won't be sent outside of these intervals."
      },
      "SendingTimesPeriodModel": {
        "type": "object",
        "properties": {
          "from": {
            "type": "string",
            "description": "Defines time of day in a format `hh:mm:ss`, inclusive min boundary of the period.\nMust be in range from zero inclusive to 1 day exclusive.\nThe extent of the period cannot be less than 15 minutes or greater than\n1 day.",
            "format": "time",
            "example": "09:30:00"
          },
          "to": {
            "type": "string",
            "description": "Defines time of day in a format `hh:mm:ss`, inclusive max boundary of the period.\nMust be greater than `from` except the last period in a day - for it `to` may be less than `from`\nand is interpreted as the time period crossing the midnight.\nThe extent of the period cannot be less than 15 minutes or greater than\n1 day.",
            "format": "time",
            "example": "19:00:00"
          }
        },
        "additionalProperties": false,
        "description": "Defines inclusive boundaries of one Messaging Config's sending time period."
      },
      "SetCompanyCspIdRequest": {
        "type": "object",
        "properties": {
          "cspId": {
            "pattern": "^S[0-9A-Z]{6,127}$",
            "type": "string",
            "description": "CspId that is assigned to your Company by TCR.",
            "nullable": true,
            "example": "S123ABC"
          }
        },
        "additionalProperties": false,
        "description": "Request to set CspId for a Company."
      },
      "TMobileBrandTier": {
        "enum": [
          "Unknown",
          "SOLE_PROPRIETOR",
          "LOW",
          "LOWER_MID",
          "UPPER_MID",
          "TOP",
          "UNCAPPED"
        ],
        "type": "string",
        "description": "\n<p>Possible values:</p>\n<ul>\n<li><b>Unknown</b></li>\n<li><b>SOLE_PROPRIETOR</b></li>\n<li><b>LOW</b></li>\n<li><b>LOWER_MID</b></li>\n<li><b>UPPER_MID</b></li>\n<li><b>TOP</b></li>\n<li><b>UNCAPPED</b></li>\n</ul>\n"
      },
      "TimeZoneId": {
        "enum": [
          "America/Juneau",
          "America/Los_Angeles",
          "America/Denver",
          "America/Chicago",
          "America/New_York",
          "UTC-12:00",
          "UTC-11:00",
          "UTC-10:00",
          "UTC-09:00",
          "UTC-08:00",
          "UTC-07:00",
          "UTC-06:00",
          "UTC-05:00",
          "UTC-04:00",
          "UTC-03:00",
          "UTC-02:00",
          "UTC-01:00",
          "UTC+00:00",
          "UTC+01:00",
          "UTC+02:00",
          "UTC+03:00",
          "UTC+04:00",
          "UTC+05:00",
          "UTC+06:00",
          "UTC+07:00",
          "UTC+08:00",
          "UTC+09:00",
          "UTC+10:00",
          "UTC+11:00",
          "UTC+12:00",
          "UTC+13:00",
          "UTC+14:00"
        ],
        "type": "string",
        "description": "\n<p>Possible values:</p>\n<ul>\n<li><b>America/Juneau</b></li>\n<li><b>America/Los_Angeles</b></li>\n<li><b>America/Denver</b></li>\n<li><b>America/Chicago</b></li>\n<li><b>America/New_York</b></li>\n<li><b>UTC-12:00</b></li>\n<li><b>UTC-11:00</b></li>\n<li><b>UTC-10:00</b></li>\n<li><b>UTC-09:00</b></li>\n<li><b>UTC-08:00</b></li>\n<li><b>UTC-07:00</b></li>\n<li><b>UTC-06:00</b></li>\n<li><b>UTC-05:00</b></li>\n<li><b>UTC-04:00</b></li>\n<li><b>UTC-03:00</b></li>\n<li><b>UTC-02:00</b></li>\n<li><b>UTC-01:00</b></li>\n<li><b>UTC+00:00</b></li>\n<li><b>UTC+01:00</b></li>\n<li><b>UTC+02:00</b></li>\n<li><b>UTC+03:00</b></li>\n<li><b>UTC+04:00</b></li>\n<li><b>UTC+05:00</b></li>\n<li><b>UTC+06:00</b></li>\n<li><b>UTC+07:00</b></li>\n<li><b>UTC+08:00</b></li>\n<li><b>UTC+09:00</b></li>\n<li><b>UTC+10:00</b></li>\n<li><b>UTC+11:00</b></li>\n<li><b>UTC+12:00</b></li>\n<li><b>UTC+13:00</b></li>\n<li><b>UTC+14:00</b></li>\n</ul>\n"
      },
      "TimeZoneModel": {
        "required": [
          "id",
          "name"
        ],
        "type": "object",
        "properties": {
          "id": {
            "minLength": 1,
            "type": "string",
            "description": "Specifies the ID of the time zone.\n<p>Possible values:</p>\n<ul>\n<li><b>America/Juneau</b></li>\n<li><b>America/Los_Angeles</b></li>\n<li><b>America/Denver</b></li>\n<li><b>America/Chicago</b></li>\n<li><b>America/New_York</b></li>\n<li><b>UTC-12:00</b></li>\n<li><b>UTC-11:00</b></li>\n<li><b>UTC-10:00</b></li>\n<li><b>UTC-09:00</b></li>\n<li><b>UTC-08:00</b></li>\n<li><b>UTC-07:00</b></li>\n<li><b>UTC-06:00</b></li>\n<li><b>UTC-05:00</b></li>\n<li><b>UTC-04:00</b></li>\n<li><b>UTC-03:00</b></li>\n<li><b>UTC-02:00</b></li>\n<li><b>UTC-01:00</b></li>\n<li><b>UTC+00:00</b></li>\n<li><b>UTC+01:00</b></li>\n<li><b>UTC+02:00</b></li>\n<li><b>UTC+03:00</b></li>\n<li><b>UTC+04:00</b></li>\n<li><b>UTC+05:00</b></li>\n<li><b>UTC+06:00</b></li>\n<li><b>UTC+07:00</b></li>\n<li><b>UTC+08:00</b></li>\n<li><b>UTC+09:00</b></li>\n<li><b>UTC+10:00</b></li>\n<li><b>UTC+11:00</b></li>\n<li><b>UTC+12:00</b></li>\n<li><b>UTC+13:00</b></li>\n<li><b>UTC+14:00</b></li>\n</ul>\n",
            "readOnly": true,
            "example": "America/Los_Angeles"
          },
          "name": {
            "minLength": 1,
            "type": "string",
            "description": "Specifies the display name of the time zone.",
            "readOnly": true,
            "example": "Pacific Time (US & Canada)"
          }
        },
        "additionalProperties": false
      },
      "TimeZonesModel": {
        "required": [
          "timeZones"
        ],
        "type": "object",
        "properties": {
          "timeZones": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TimeZoneModel"
            },
            "description": "The list of supported time zones."
          }
        },
        "additionalProperties": false
      },
      "ValidationProblemDetails": {
        "type": "object",
        "properties": {
          "errors": {
            "type": "object",
            "additionalProperties": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          "type": {
            "type": "string"
          },
          "title": {
            "type": "string"
          },
          "status": {
            "type": "integer",
            "format": "int32"
          },
          "detail": {
            "type": "string",
            "nullable": true
          },
          "instance": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": { }
      },
      "WebhookAttemptModel": {
        "required": [
          "attemptNumber",
          "requestUrl",
          "resultCode"
        ],
        "type": "object",
        "properties": {
          "createdOn": {
            "type": "string",
            "description": "Date and time when webhook attempt was performed.",
            "format": "date-time"
          },
          "attemptNumber": {
            "type": "integer",
            "description": "Attempt number (starting from 1).",
            "format": "int32"
          },
          "resultCode": {
            "allOf": [
              {
                "$ref": "#/components/schemas/WebhookResultCode"
              }
            ],
            "description": "Possible result of trying to process a webhook.\n<p>Possible values:</p>\n<ul>\n<li><b>Success</b>: Webhook request completed successfully.</li>\n<li><b>InvalidEndpoint</b>: Configured webhook endpoint is invalid. For example leads to non-existing domain.</li>\n<li><b>NetworkError</b>: Network error occurred. This includes connection timeout, socket errors and so on.</li>\n<li><b>ErrorStatusCode</b>: Request completed, but HTTP status code is not in [200..299] range.</li>\n<li><b>InvalidResponse</b>: Request completed, but response was not in correct format. Used for</li>\n</ul>\n"
          },
          "requestUrl": {
            "maxLength": 512,
            "minLength": 1,
            "type": "string",
            "description": "Request URL."
          },
          "requestDuration": {
            "type": "string",
            "description": "Request duration.",
            "format": "date-span",
            "nullable": true
          },
          "responseStatusCode": {
            "type": "integer",
            "description": "Response HTTP status code.",
            "format": "int32",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "WebhookDetailsModel": {
        "type": "object",
        "allOf": [
          {
            "$ref": "#/components/schemas/WebhookModelBase"
          }
        ],
        "properties": {
          "attempts": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/WebhookAttemptModel"
            },
            "description": "All attempts to process this webhook."
          }
        },
        "additionalProperties": false
      },
      "WebhookModel": {
        "type": "object",
        "allOf": [
          {
            "$ref": "#/components/schemas/WebhookModelBase"
          }
        ],
        "properties": {
          "lastAttempt": {
            "allOf": [
              {
                "$ref": "#/components/schemas/WebhookAttemptModel"
              }
            ],
            "description": "Last attempt to process this webhook."
          }
        },
        "additionalProperties": false
      },
      "WebhookModelBase": {
        "required": [
          "payload",
          "sid",
          "status",
          "type"
        ],
        "type": "object",
        "properties": {
          "createdOn": {
            "type": "string",
            "description": "Date and time when webhook was created.",
            "format": "date-time"
          },
          "sid": {
            "maxLength": 128,
            "minLength": 1,
            "type": "string",
            "description": "Unique identifier of this webhook."
          },
          "type": {
            "allOf": [
              {
                "$ref": "#/components/schemas/WebhookType"
              }
            ],
            "description": "The list of the supported webhook types.\n<p>Possible values:</p>\n<ul>\n<li><b>TcrCampaignImported</b>: Notifies that new campaign was imported from TCR. This webhook is configured at company level via webhook subscription.</li>\n<li><b>PhoneNumberStatusChanged</b>: Notifies that phone number changed its status. This webhook is configured at company level via webhook subscription.</li>\n<li><b>PhoneNumberVoiceStatusChanged</b>: Phone number voice status changed. This webhook is configured at company level via webhook subscription.</li>\n<li><b>TrafficLimitAlert</b>: Traffic limit alert. This webhook is configured at company level via webhook subscription.</li>\n<li><b>InboundCallReceived</b>: Inbound call received. This webhook is configured at company level via webhook subscription.</li>\n<li><b>InboundCallReceivedFallback</b>: Inbound call received fallback. This webhook is configured at company level via webhook subscription.</li>\n<li><b>CallStatusChanged</b>: Call status changed. This webhook is configured at company level via webhook subscription.</li>\n<li><b>CallRecordingCompleted</b>: Call recording completed and available for download. This webhook is configured at company level via webhook subscription.</li>\n<li><b>OutboundMessageStatusChanged</b>: Outbound message status is changed. This webhook is configured at messaging config level.</li>\n<li><b>InboundMessageReceived</b>: Inbound message is received. This webhook is configured at messaging config level.</li>\n<li><b>OptInOutReceived</b>: Opt-in or opt-out is received. This webhook is configured at messaging config level.</li>\n<li><b>RcsOutboundMessageStatusChanged</b>: RCS outbound message status changed. This webhook is configured at company level via webhook subscription.</li>\n<li><b>RcsInboundMessageReceived</b>: RCS inbound message received. This webhook is configured at company level via webhook subscription.</li>\n<li><b>RcsInboundUserAction</b>: User has acted over a suggestion sent with the RCS message. This webhook is configured at company level via webhook subscription.</li>\n<li><b>RcsMessageSeen</b>: The recipient device confirmed that an RCS outbound message was seen. This webhook is configured at company level via webhook subscription.</li>\n<li><b>RcsTypingIndicator</b>: End user started typing in an RCS conversation. This webhook is configured at company level via webhook subscription.</li>\n</ul>\n"
          },
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/WebhookStatus"
              }
            ],
            "description": "Webhook processing status.\n<p>Possible values:</p>\n<ul>\n<li><b>Success</b>: Webhook is successfully processed.</li>\n<li><b>Failure</b>: All attempts to process this webhook failed.</li>\n<li><b>Reprocessing</b>: Webhook is being reprocessed.</li>\n</ul>\n"
          },
          "payload": {
            "minLength": 1,
            "type": "string",
            "description": "Webhook payload (HTTP POST body)."
          },
          "entitySid": {
            "maxLength": 128,
            "type": "string",
            "description": "SID of associated entity (if any).",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "WebhookModelPaginatedResult": {
        "required": [
          "items"
        ],
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/WebhookModel"
            }
          },
          "searchId": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "WebhookResultCode": {
        "enum": [
          "Success",
          "InvalidEndpoint",
          "NetworkError",
          "ErrorStatusCode",
          "InvalidResponse"
        ],
        "type": "string",
        "description": "Possible result of trying to process a webhook.\n<p>Possible values:</p>\n<ul>\n<li><b>Success</b>: Webhook request completed successfully.</li>\n<li><b>InvalidEndpoint</b>: Configured webhook endpoint is invalid. For example leads to non-existing domain.</li>\n<li><b>NetworkError</b>: Network error occurred. This includes connection timeout, socket errors and so on.</li>\n<li><b>ErrorStatusCode</b>: Request completed, but HTTP status code is not in [200..299] range.</li>\n<li><b>InvalidResponse</b>: Request completed, but response was not in correct format. Used for</li>\n</ul>\n"
      },
      "WebhookStatus": {
        "enum": [
          "Success",
          "Failure",
          "Reprocessing"
        ],
        "type": "string",
        "description": "Webhook processing status.\n<p>Possible values:</p>\n<ul>\n<li><b>Success</b>: Webhook is successfully processed.</li>\n<li><b>Failure</b>: All attempts to process this webhook failed.</li>\n<li><b>Reprocessing</b>: Webhook is being reprocessed.</li>\n</ul>\n"
      },
      "WebhookSubscriptionListModel": {
        "type": "object",
        "properties": {
          "webhookSubscriptions": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/WebhookSubscriptionModel"
            },
            "description": "List of webhook subscriptions according to your filter query."
          }
        },
        "additionalProperties": false,
        "description": "Webhook subscription list."
      },
      "WebhookSubscriptionModel": {
        "required": [
          "type",
          "url"
        ],
        "type": "object",
        "properties": {
          "type": {
            "allOf": [
              {
                "$ref": "#/components/schemas/WebhookSubscriptionType"
              }
            ],
            "description": "The list of the supported company-level webhook types.\n<p>Possible values:</p>\n<ul>\n<li><b>TcrCampaignImported</b>: Notifies that new campaign was imported from TCR.</li>\n<li><b>PhoneNumberStatusChanged</b>: Notifies that phone number changed its status.</li>\n<li><b>PhoneNumberVoiceStatusChanged</b>: Phone number voice status changed.</li>\n<li><b>TrafficLimitAlert</b>: Traffic limit alert.</li>\n<li><b>InboundCallReceived</b>: Inbound call received.</li>\n<li><b>InboundCallReceivedFallback</b>: Inbound call received fallback.</li>\n<li><b>CallStatusChanged</b>: Call status changed.</li>\n<li><b>CallRecordingCompleted</b>: Call recording completed and available for download.</li>\n<li><b>RcsOutboundMessageStatusChanged</b>: RCS outbound message status changed.</li>\n<li><b>RcsInboundMessageReceived</b>: RCS inbound message received.</li>\n<li><b>RcsInboundUserAction</b>: User has acted over a suggestion sent with the RCS message.</li>\n<li><b>RcsMessageSeen</b>: The recipient device confirmed that an RCS outbound message was seen.</li>\n<li><b>RcsTypingIndicator</b>: End user started typing in an RCS conversation.</li>\n</ul>\n"
          },
          "url": {
            "maxLength": 512,
            "minLength": 1,
            "type": "string",
            "description": "The URL to send webhooks to.",
            "format": "uri",
            "example": "https://example.com/webhook?source=telgorithm"
          },
          "authorizationBearer": {
            "maxLength": 256,
            "type": "string",
            "description": "If specified, the Authorization header is added to webhook requests using\nthe `Bearer` scheme and containing the value provided in this field.",
            "nullable": true,
            "example": "MySecretToken123"
          }
        },
        "additionalProperties": false,
        "description": "Webhook model."
      },
      "WebhookSubscriptionRequest": {
        "required": [
          "url"
        ],
        "type": "object",
        "properties": {
          "url": {
            "maxLength": 512,
            "minLength": 1,
            "type": "string",
            "description": "The URL to send webhooks to.",
            "format": "uri",
            "example": "https://example.com/webhook?source=telgorithm"
          },
          "authorizationBearer": {
            "maxLength": 256,
            "type": "string",
            "description": "If specified, the Authorization header is added to webhook requests using\nthe `Bearer` scheme and containing the value provided in this field.",
            "nullable": true,
            "example": "MySecretToken123"
          }
        },
        "additionalProperties": false,
        "description": "Webhook model."
      },
      "WebhookSubscriptionType": {
        "enum": [
          "TcrCampaignImported",
          "PhoneNumberStatusChanged",
          "PhoneNumberVoiceStatusChanged",
          "TrafficLimitAlert",
          "InboundCallReceived",
          "InboundCallReceivedFallback",
          "CallStatusChanged",
          "CallRecordingCompleted",
          "RcsOutboundMessageStatusChanged",
          "RcsInboundMessageReceived",
          "RcsInboundUserAction",
          "RcsMessageSeen",
          "RcsTypingIndicator"
        ],
        "type": "string",
        "description": "The list of the supported company-level webhook types.\n<p>Possible values:</p>\n<ul>\n<li><b>TcrCampaignImported</b>: Notifies that new campaign was imported from TCR.</li>\n<li><b>PhoneNumberStatusChanged</b>: Notifies that phone number changed its status.</li>\n<li><b>PhoneNumberVoiceStatusChanged</b>: Phone number voice status changed.</li>\n<li><b>TrafficLimitAlert</b>: Traffic limit alert.</li>\n<li><b>InboundCallReceived</b>: Inbound call received.</li>\n<li><b>InboundCallReceivedFallback</b>: Inbound call received fallback.</li>\n<li><b>CallStatusChanged</b>: Call status changed.</li>\n<li><b>CallRecordingCompleted</b>: Call recording completed and available for download.</li>\n<li><b>RcsOutboundMessageStatusChanged</b>: RCS outbound message status changed.</li>\n<li><b>RcsInboundMessageReceived</b>: RCS inbound message received.</li>\n<li><b>RcsInboundUserAction</b>: User has acted over a suggestion sent with the RCS message.</li>\n<li><b>RcsMessageSeen</b>: The recipient device confirmed that an RCS outbound message was seen.</li>\n<li><b>RcsTypingIndicator</b>: End user started typing in an RCS conversation.</li>\n</ul>\n"
      },
      "WebhookType": {
        "enum": [
          "TcrCampaignImported",
          "PhoneNumberStatusChanged",
          "PhoneNumberVoiceStatusChanged",
          "TrafficLimitAlert",
          "InboundCallReceived",
          "InboundCallReceivedFallback",
          "CallStatusChanged",
          "CallRecordingCompleted",
          "OutboundMessageStatusChanged",
          "InboundMessageReceived",
          "OptInOutReceived",
          "RcsOutboundMessageStatusChanged",
          "RcsInboundMessageReceived",
          "RcsInboundUserAction",
          "RcsMessageSeen",
          "RcsTypingIndicator"
        ],
        "type": "string",
        "description": "The list of the supported webhook types.\n<p>Possible values:</p>\n<ul>\n<li><b>TcrCampaignImported</b>: Notifies that new campaign was imported from TCR. This webhook is configured at company level via webhook subscription.</li>\n<li><b>PhoneNumberStatusChanged</b>: Notifies that phone number changed its status. This webhook is configured at company level via webhook subscription.</li>\n<li><b>PhoneNumberVoiceStatusChanged</b>: Phone number voice status changed. This webhook is configured at company level via webhook subscription.</li>\n<li><b>TrafficLimitAlert</b>: Traffic limit alert. This webhook is configured at company level via webhook subscription.</li>\n<li><b>InboundCallReceived</b>: Inbound call received. This webhook is configured at company level via webhook subscription.</li>\n<li><b>InboundCallReceivedFallback</b>: Inbound call received fallback. This webhook is configured at company level via webhook subscription.</li>\n<li><b>CallStatusChanged</b>: Call status changed. This webhook is configured at company level via webhook subscription.</li>\n<li><b>CallRecordingCompleted</b>: Call recording completed and available for download. This webhook is configured at company level via webhook subscription.</li>\n<li><b>OutboundMessageStatusChanged</b>: Outbound message status is changed. This webhook is configured at messaging config level.</li>\n<li><b>InboundMessageReceived</b>: Inbound message is received. This webhook is configured at messaging config level.</li>\n<li><b>OptInOutReceived</b>: Opt-in or opt-out is received. This webhook is configured at messaging config level.</li>\n<li><b>RcsOutboundMessageStatusChanged</b>: RCS outbound message status changed. This webhook is configured at company level via webhook subscription.</li>\n<li><b>RcsInboundMessageReceived</b>: RCS inbound message received. This webhook is configured at company level via webhook subscription.</li>\n<li><b>RcsInboundUserAction</b>: User has acted over a suggestion sent with the RCS message. This webhook is configured at company level via webhook subscription.</li>\n<li><b>RcsMessageSeen</b>: The recipient device confirmed that an RCS outbound message was seen. This webhook is configured at company level via webhook subscription.</li>\n<li><b>RcsTypingIndicator</b>: End user started typing in an RCS conversation. This webhook is configured at company level via webhook subscription.</li>\n</ul>\n"
      },
      "WebhookTypesResponseModel": {
        "type": "object",
        "properties": {
          "webhookTypes": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Values which can be specified for webhook type when subscribing or unsubscribing.",
            "readOnly": true
          }
        },
        "additionalProperties": false,
        "description": "Webhook types."
      },
      "WebhookUnsubscriptionResultModel": {
        "type": "object",
        "properties": {
          "wasRemoved": {
            "type": "boolean",
            "description": "Specified whether the subscription was successfully removed or not\n(i.e `true` whether the subscription existed before and `false` otherwise)."
          }
        },
        "additionalProperties": false,
        "description": "Holds the result of unsubscribe operation."
      }
    },
    "securitySchemes": {
      "basic": {
        "type": "http",
        "description": "Basic Authorization header using the BASIC scheme. Use a pair `companySid:token` to access the API.",
        "scheme": "basic"
      },
      "bearer": {
        "type": "http",
        "description": "Access token without Bearer prefix: `eyJhbGciOiJSUzI...`",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    }
  },
  "security": [
    {
      "basic": [ ]
    },
    {
      "bearer": [ ]
    }
  ],
  "tags": [
    {
      "name": "CallLegs",
      "description": "Provides information about Call Legs of the Inbound and Outbound Calls."
    },
    {
      "name": "Calls",
      "description": "Allows to initiate Outbound Calls and get information about Inbound and Outbound Calls,\nincluding their recordings."
    },
    {
      "name": "InboundMessages",
      "description": "Provides information about the Inbound Messages sent to your Phone Numbers."
    },
    {
      "name": "MessagingConfigs",
      "description": "Allows to manage and to get information about Messaging Configs.\nMain features include:\n<ul><li>Creating new and removing Messaging Configs</li><li>Associating and de-associating Phone Numbers with Messaging Configs and their configured TCR Campaigns</li><li>Managing Callback settings</li><li>Managing Time Routing (Sending Times)</li></ul>\nPlease keep in mind that associating and de-associating Phone Numbers from the TCR Campaign may take some time.\nUntil that operation is complete, your traffic may be considered P2P and be rate-limited accordingly\nand may even be rejected by SPAM filters at the carrier level."
    },
    {
      "name": "MyCompany",
      "description": "Provides information about your Company."
    },
    {
      "name": "OptOuts",
      "description": "Allows to get information about the recipients that have opted out from receiving text messages."
    },
    {
      "name": "OutboundMessages",
      "description": "Allows to send Outbound Messages, list and get individual Outbound Message information.\n\nSince the API methods have rate limits imposed, it is not advised to use the below GET methods\nto continually check the delivery status of the Outbound Messages.\nConsider using Outbound Message Callbacks instead."
    },
    {
      "name": "Phones",
      "description": "Allows to manage and get information about Phone Numbers.\nMain features include:\n<ul><li>Buying new or porting-in existing Phone Numbers to the account</li><li>Changing Phone Number to Messaging Config association</li><li>Managing voice services for the Phone Number</li><li>Deallocating Phone Number from the account</li></ul>"
    },
    {
      "name": "Static",
      "description": "Static Enumerations And Constants"
    },
    {
      "name": "TcrBrands",
      "description": "Provides information about your TCR Brands."
    },
    {
      "name": "TcrCampaigns",
      "description": "Allows to manage and to get information about TCR Campaigns that you've shared with Telgorithm."
    },
    {
      "name": "TimeZones",
      "description": "Provides the list of Time Zones that are supported for Messaging Config Sending Times (Time Routing)."
    },
    {
      "name": "Webhooks",
      "description": "Allows to get information and manage Webhook Subscriptions and their URLs."
    },
    {
      "name": "RcsEvents",
      "description": "Allows customers to submit Outbound RCS Events (e.g. \"Seen\" notifications) for forwarding to the upstream provider."
    },
    {
      "name": "RcsInboundMessages",
      "description": "Provides information about the RCS Inbound Messages"
    },
    {
      "name": "RcsOutboundMessages",
      "description": "Allows sending RCS Outbound Messages in single or batch mode"
    }
  ]
}