swagger.waba.json

{
  "openapi": "3.0.0",
  "info": {
    "description": "[1MSG.IO](https://1msg.io/) is the perfect WhatsApp management tool for your business. With us you get full access to the official Whatsapp API/webhooks.\n\nEvery API request must contain an Authorize HTTP header with a token. \nThis is your channel token, which can be found in your channel project on your profile page.\nPlease do not give the token to anyone or post it publicly.\n\nThe authorization token must be added to each request in the GET parameter 'token' and always passed to query string (?token={your_token}).\nParameters in GET queries pass query string. Parameters in POST requests — through the JSON-encoded request body. \n\nAll 'send' methods (except /sendTemplate) will only work when the dialog session with the user is open. Some of our solutions simplify and avoid such limitations, but we urge you to pay more attention to this detail",
    "version": "2.39.0",
    "title": "one_msg_waba_sdk",
    "contact": {
      "email": "hello@1msg.io"
    }
  },
  "tags": [
    {
      "name": "Channel",
      "description": "Manage your WhatsApp Business API channel"
    },
    {
      "name": "Webhooks",
      "description": "How to setup webhooks for the WhatsApp Business API"
    },
    {
      "name": "Messaging",
      "description": "This part of the documentation describes how to send and receive messages using the WhatsApp Business API"
    },
    {
      "name": "Templates",
      "description": "Template messaging via WhatsApp Business API"
    },
    {
      "name": "Products & Catalogs",
      "description": "How to build and send messages with single and multiple products"
    },
    {
      "name": "Media",
      "description": "Use the media node to upload, retrieve, or delete media"
    }
  ],
  "paths": {
    "/me": {
      "get": {
        "tags": [
          "Channel"
        ],
        "summary": "Get Profile Info",
        "description": "Use this edge to retrieve your profile's About info",
        "operationId": "getMe",
        "responses": {
          "200": {
            "$ref": "#/components/responses/GetMe"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          }
        },
        "security": [
          {
            "token": []
          }
        ]
      },
      "post": {
        "tags": [
          "Channel"
        ],
        "summary": "Change user info",
        "description": "Change user info",
        "operationId": "setMe",
        "responses": {
          "200": {
            "$ref": "#/components/responses/SetMe"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          }
        },
        "security": [
          {
            "token": []
          }
        ],
        "requestBody": {
          "$ref": "#/components/requestBodies/SetMe"
        }
      }
    },
    "/statistics": {
      "get": {
        "tags": [
          "Channel"
        ],
        "summary": "Get Channel statistics",
        "description": "Get channel usage statistics",
        "operationId": "getStatistics",
        "responses": {
          "200": {
            "$ref": "#/components/responses/channelStatistics"
          }
        },
        "security": [
          {
            "token": []
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/date"
          }
        ]
      }
    },
    "/extendedStatistics": {
      "get": {
        "tags": [
          "Channel"
        ],
        "summary": "Get Extended Channel statistics",
        "description": "Get channel usage extended statistics",
        "operationId": "getExtendedStatistics",
        "responses": {
          "200": {
            "$ref": "#/components/responses/channelExtendedStatistics"
          }
        },
        "security": [
          {
            "token": []
          }
        ]
      }
    },
    "/status": {
      "get": {
        "tags": [
          "Channel"
        ],
        "summary": " Get Status",
        "description": "Returns the status of your WhatsApp Business API client. Channel statuses:\n\n**connected**/**connecting** - everything is ok.\n\n**disconnected** - The Coreapp is not connected to the WhatsApp servers.\n\n**uninitialized** - The application could be in the process of upgrading or initializing the database schema. Try again in a few minutes and contact Support if you continue to see this status.\n\n**unregistered** - You need to register your WhatsApp Business API client. Either you have been blocked and need to take some action (contact Support)",
        "operationId": "getStatus",
        "responses": {
          "200": {
            "$ref": "#/components/responses/channelStatus"
          }
        },
        "security": [
          {
            "token": []
          }
        ]
      }
    },
    "/settings": {
      "get": {
        "tags": [
          "Channel"
        ],
        "summary": "Get Settings",
        "description": "**webhookUrl** - Http or https URL for receiving notifications.",
        "operationId": "getSettings",
        "responses": {
          "200": {
            "$ref": "#/components/responses/Settings"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          }
        },
        "security": [
          {
            "token": []
          }
        ]
      },
      "post": {
        "tags": [
          "Channel"
        ],
        "summary": "Set settings",
        "description": "**webhookUrl** - Http or https URL for receiving notifications.",
        "operationId": "setSettings",
        "responses": {
          "200": {
            "$ref": "#/components/responses/UpdateSettings"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          }
        },
        "security": [
          {
            "token": []
          }
        ],
        "requestBody": {
          "$ref": "#/components/requestBodies/UpdateSettings"
        }
      }
    },
    "/commerce": {
      "get": {
        "tags": [
          "Channel"
        ],
        "summary": "Get Commerce Settings",
        "description": "**is_catalog_visible** - Set to true to show catalog storefront icon or false to hide it.\n**is_cart_enabled** - Set to true to enable cart or false to disable it.",
        "operationId": "getCommerce",
        "responses": {
          "200": {
            "$ref": "#/components/responses/GetCommerce"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          }
        },
        "security": [
          {
            "token": []
          }
        ]
      },
      "post": {
        "tags": [
          "Products & Catalogs"
        ],
        "summary": "Set Commerce Settings",
        "description": "**is_catalog_visible** - Set to true to show catalog storefront icon or false to hide it.\n**is_cart_enabled** - Set to true to enable cart or false to disable it.",
        "operationId": "setCommerce",
        "responses": {
          "200": {
            "$ref": "#/components/responses/SetCommerce"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          }
        },
        "security": [
          {
            "token": []
          }
        ],
        "requestBody": {
          "$ref": "#/components/requestBodies/UpdateCommerce"
        }
      }
    },
    "/webhook": {
      "post": {
        "tags": [
          "Webhooks"
        ],
        "summary": "Set webhook",
        "description": "Sets the URL for receiving webhook notifications of new messages and message delivery events (ack).\n\n**API responses in \"Callbacks\" tab**",
        "operationId": "setWebhook",
        "responses": {
          "200": {
            "$ref": "#/components/responses/SetWebhookStatus"
          }
        },
        "security": [
          {
            "token": []
          }
        ],
        "requestBody": {
          "$ref": "#/components/requestBodies/SetWebhook"
        },
        "callbacks": {
          "messages": {
            "$ref": "#/components/callbacks/Messages"
          },
          "ack": {
            "$ref": "#/components/callbacks/Ack"
          }
        }
      }
    },
    "/sendList": {
      "post": {
        "tags": [
          "Messaging"
        ],
        "summary": "Send List Message",
        "description": "Send Interactive List Message to an existing chat. (Only if the dialogue has an Open Session). Only one of two parameters is needed to determine the destination - chatId or phone.",
        "operationId": "sendList",
        "responses": {
          "200": {
            "$ref": "#/components/responses/SendMessageStatus"
          }
        },
        "security": [
          {
            "token": []
          }
        ],
        "requestBody": {
          "$ref": "#/components/requestBodies/SendList"
        }
      }
    },
    "/sendFile": {
      "post": {
        "tags": [
          "Messaging"
        ],
        "summary": "Send a File",
        "description": "Send a file to an existing chat. (Only if the dialogue has an Open Session). Only one of two parameters is needed to determine the destination - chatId or phone.",
        "operationId": "sendFile",
        "responses": {
          "200": {
            "$ref": "#/components/responses/SendMessageStatus"
          }
        },
        "security": [
          {
            "token": []
          }
        ],
        "requestBody": {
          "$ref": "#/components/requestBodies/SendFile"
        }
      }
    },
    "/sendTemplate": {
      "post": {
        "tags": [
          "Templates"
        ],
        "summary": "Send Template Message",
        "description": "Send Template Message to a new or existing chat. Only one of two parameters is needed to determine the destination - chatId or phone.\n\nExample:\n\n{\"template\":\"template_name\",\"language\":{\"policy\":\"deterministic\",\"code\":\"en\"},\"namespace\":\"namespace_id\",\"params\":[{\"type\":\"header\",\"parameters\":[{\"type\":\"image\",\"image\": {\"link\":\"https://...\"}}]},{\"type\":\"body\",\"parameters\":[{\"type\":\"text\",\"text\":\"test\"}]}],\"phone\":\"556123122026\"}",
        "operationId": "sendTemplate",
        "responses": {
          "200": {
            "$ref": "#/components/responses/SendTemplate"
          }
        },
        "security": [
          {
            "token": []
          }
        ],
        "requestBody": {
          "$ref": "#/components/requestBodies/SendTemplate"
        }
      }
    },
    "/sendMessage": {
      "post": {
        "tags": [
          "Messaging"
        ],
        "summary": "Send a Message",
        "description": "Send a message to an existing chat. (Only if the dialogue has an Open Session). The message will be added to the queue for sending and delivered even if the phone is disconnected from the Internet or authorization is not passed.\n\nOnly one of two parameters is needed to determine the destination - chatId or phone.",
        "operationId": "sendMessage",
        "responses": {
          "200": {
            "$ref": "#/components/responses/SendMessageStatus"
          }
        },
        "security": [
          {
            "token": []
          }
        ],
        "requestBody": {
          "$ref": "#/components/requestBodies/SendMessage"
        }
      }
    },
    "/sendLocation": {
      "post": {
        "tags": [
          "Messaging"
        ],
        "summary": "Send a Location",
        "description": "Send a location to an existing chat. (Only if the dialogue has an Open Session). Only one of two parameters is needed to determine the destination - chatId or phone.",
        "operationId": "sendLocation",
        "responses": {
          "200": {
            "$ref": "#/components/responses/SendMessageStatus"
          }
        },
        "security": [
          {
            "token": []
          }
        ],
        "requestBody": {
          "$ref": "#/components/requestBodies/SendLocation"
        }
      }
    },
    "/sendContact": {
      "post": {
        "tags": [
          "Messaging"
        ],
        "summary": "Send a Contact",
        "description": "Send a contact to an existing chat. (Only if the dialogue has an Open Session). Only one of two parameters is needed to determine the destination - chatId or phone.",
        "operationId": "sendContact",
        "responses": {
          "200": {
            "$ref": "#/components/responses/SendMessageStatus"
          }
        },
        "security": [
          {
            "token": []
          }
        ],
        "requestBody": {
          "$ref": "#/components/requestBodies/SendContact"
        }
      }
    },
    "/sendProduct": {
      "post": {
        "tags": [
          "Products & Catalogs"
        ],
        "summary": "Send a Product",
        "description": "Send a single product or product list to a new or existing chat. (Only if the dialogue has an Open Session). Only one of two parameters is needed to determine the destination - chatId or phone.\n\nFirst, you need to upload your inventory to Facebook. You can use the API or Facebook’s Commerce Manager to do that. If you already have a Facebook catalog set up, we suggest that you leverage that catalog for WhatsApp commerce use cases.\n\n**You can not send products to Business WhatsApp clients.**",
        "operationId": "sendProduct",
        "responses": {
          "200": {
            "$ref": "#/components/responses/SendMessageStatus"
          }
        },
        "security": [
          {
            "token": []
          }
        ],
        "requestBody": {
          "$ref": "#/components/requestBodies/SendProduct"
        }
      }
    },
    "/addTemplate": {
      "post": {
        "tags": [
          "Templates"
        ],
        "summary": "Create template",
        "description": "Create new template for sending.",
        "operationId": "addTemplate",
        "responses": {
          "200": {
            "$ref": "#/components/responses/AddTemplate"
          }
        },
        "security": [
          {
            "token": []
          }
        ],
        "requestBody": {
          "$ref": "#/components/requestBodies/AddTemplate"
        }
      }
    },
    "/removeTemplate": {
      "post": {
        "tags": [
          "Templates"
        ],
        "summary": "Remove template",
        "description": "Deleted template can not be restored.",
        "operationId": "removeTemplate",
        "responses": {
          "200": {
            "$ref": "#/components/responses/RemoveTemplate"
          }
        },
        "security": [
          {
            "token": []
          }
        ],
        "requestBody": {
          "$ref": "#/components/requestBodies/RemoveTemplate"
        }
      }
    },
    "/templates": {
      "get": {
        "tags": [
          "Templates"
        ],
        "summary": "Get templates list",
        "description": "",
        "operationId": "templatesList",
        "responses": {
          "200": {
            "$ref": "#/components/responses/GetTemplates"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          }
        },
        "security": [
          {
            "token": []
          }
        ]
      }
    },
    "/uploadMedia": {
      "post": {
        "tags": [
          "Media"
        ],
        "summary": "Upload media & get mediaId",
        "description": "Upload media and get mediaId. Uploaded media can be sent in template",
        "operationId": "uploadMedia",
        "responses": {
          "200": {
            "$ref": "#/components/responses/UploadMedia"
          }
        },
        "security": [
          {
            "token": []
          }
        ],
        "requestBody": {
          "$ref": "#/components/requestBodies/UploadMedia"
        }
      }
    },
    "/messages": {
      "get": {
        "tags": [
          "Messaging"
        ],
        "summary": "Get messages list",
        "description": "",
        "operationId": "messagesList",
        "responses": {
          "200": {
            "$ref": "#/components/responses/GetMessages"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          }
        },
        "security": [
          {
            "token": []
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/last"
          },
          {
            "$ref": "#/components/parameters/lastMessageNumber"
          },
          {
            "$ref": "#/components/parameters/firstMessageNumber"
          },
          {
            "$ref": "#/components/parameters/limit"
          },
          {
            "$ref": "#/components/parameters/chatId"
          },
          {
            "$ref": "#/components/parameters/min_time"
          },
          {
            "$ref": "#/components/parameters/max_time"
          },
          {
            "$ref": "#/components/parameters/msgId"
          }
        ]
      }
    },
    "/hookInfo": {
      "get": {
        "tags": [
          "Webhooks"
        ],
        "summary": "Check ACKs",
        "description": "",
        "operationId": "ackHookInfo",
        "responses": {
          "200": {
            "$ref": "#/components/responses/GetAckInfo"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          }
        },
        "security": [
          {
            "token": []
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/messageId"
          }
        ]
      }
    },
    "/outputIP": {
      "get": {
        "tags": [
          "Channel"
        ],
        "summary": "Get channel server IP",
        "description": "",
        "operationId": "outputIP",
        "responses": {
          "200": {
            "$ref": "#/components/responses/GetIP"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          }
        },
        "security": [
          {
            "token": []
          }
        ]
      }
    },
    "/readMessage": {
      "post": {
        "tags": [
          "Messaging"
        ],
        "summary": "Mark message as read",
        "description": "",
        "operationId": "readMessage",
        "responses": {
          "200": {
            "$ref": "#/components/responses/ReadMessage"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          }
        },
        "security": [
          {
            "token": []
          }
        ],
        "requestBody": {
          "$ref": "#/components/requestBodies/ReadMessage"
        }
      }
    }
  },
  "servers": [
    {
      "url": "{protocol}://api.1msg.io/{channelId}",
      "description": "New common server url",
      "variables": {
        "channelId": {
          "default": "YOUR_INSTANCE_NUMBER",
          "description": "Your channel number"
        },
        "protocol": {
          "enum": [
            "http",
            "https"
          ],
          "default": "https"
        }
      }
    }
  ],
  "components": {
    "securitySchemes": {
      "token": {
        "type": "apiKey",
        "name": "token",
        "in": "query"
      }
    },
    "parameters": {
      "messageId": {
        "name": "messageId",
        "in": "query",
        "description": "Message ID. Example: 0XzkmGNn4prUAQlzsHApGNRXQ0U",
        "required": true,
        "example": "0XzkmGNn4prUAQlzsHApGNRXQ0U",
        "schema": {
          "type": "string"
        },
        "allowEmptyValue": false
      },
      "msgId": {
        "name": "msgId",
        "in": "query",
        "description": "Message ID. Example: 0XzkmGNn4prUAQlzsHApGNRXQ0U",
        "required": false,
        "example": "0XzkmGNn4prUAQlzsHApGNRXQ0U",
        "schema": {
          "type": "string"
        }
      },
      "phone": {
        "name": "phone",
        "in": "query",
        "description": "Phone number. Example: 556123122026",
        "required": true,
        "example": 556123122026,
        "schema": {
          "type": "string"
        }
      },
      "date": {
        "name": "date",
        "in": "query",
        "description": "Month and year in format mm.YYYY.",
        "example": "03.2022",
        "schema": {
          "type": "string"
        }
      },
      "lastMessageNumber": {
        "name": "lastMessageNumber",
        "in": "query",
        "description": "The lastMessageNumber parameter from the last response. Example: 100",
        "example": 100,
        "schema": {
          "type": "integer"
        }
      },
      "last": {
        "name": "last",
        "in": "query",
        "description": "Displays the last messages. If this parameter is passed, then lastMessageNumber is ignored.",
        "example": true,
        "schema": {
          "type": "boolean"
        }
      },
      "firstMessageNumber": {
        "name": "firstMessageNumber",
        "in": "query",
        "description": "The firstMessageNumber parameter from the last response. Example: 1",
        "example": 1,
        "schema": {
          "type": "integer"
        }
      },
      "limit": {
        "name": "limit",
        "in": "query",
        "description": "Sets length of the message list. Default 100. With value 0 returns all messages.",
        "example": 200,
        "schema": {
          "type": "integer"
        }
      },
      "chatId": {
        "name": "chatId",
        "in": "query",
        "description": "Filter messages by chatId\n\nChat ID from the message list. Example: 556123122026@c.us",
        "example": "556123122026@c.us",
        "schema": {
          "type": "string"
        }
      },
      "min_time": {
        "name": "min_time",
        "in": "query",
        "description": "Filter messages received after specified time. Example: 1665396610",
        "example": 1665396610,
        "schema": {
          "type": "integer"
        }
      },
      "max_time": {
        "name": "max_time",
        "in": "query",
        "description": "Filter messages received before specified time. Example: 1665396610",
        "example": 1665396610,
        "schema": {
          "type": "integer"
        }
      }
    },
    "schemas": {
      "AddTemplate": {
        "type": "object",
        "properties": {
        }
      },
      "TemplateCategoryProp": {
        "type": "string",
        "enum": [
          "MARKETING",
          "TRANSACTIONAL",
          "OTP"
        ],
        "example": "MARKETING",
        "description": "Template category"
      },
      "TemplateComponentsProp": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "enum": [
                "BODY",
                "HEADER",
                "FOOTER",
                "BUTTONS"
              ],
              "example": "BODY"
            },
            "format": {
              "type": "string",
              "description": "Only for HEADER type",
              "enum": [
                "TEXT",
                "IMAGE",
                "DOCUMENT",
                "VIDEO"
              ],
              "example": "TEXT"
            },
            "text": {
              "type": "string",
              "example": "header text {{1}}"
            },
            "example": {
              "type": "object"
            },
            "buttons": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "enum": [
                      "PHONE_NUMBER",
                      "URL",
                      "QUICK_REPLY"
                    ],
                    "example": "QUICK_REPLY"
                  },
                  "text": {
                    "type": "string",
                    "example": "phone-button-text"
                  },
                  "url": {
                    "type": "string",
                    "example": "https://www.website.com/{{1}}"
                  },
                  "phone_number": {
                    "type": "string",
                    "example": "+1(234) 235-5678"
                  },
                  "example": {
                    "type": "array",
                    "items": {}
                  }
                }
              }
            }
          }
        },
        "description": "Array of template components"
      },
      "TemplateLanguageProp": {
        "type": "string",
        "enum": [
          "af",
          "sq",
          "ar",
          "az",
          "bn",
          "bg",
          "ca",
          "zh_CN",
          "zh_HK",
          "zh_TW",
          "hr",
          "cs",
          "da",
          "nl",
          "en",
          "en_GB",
          "en_US",
          "et",
          "fil",
          "fi",
          "fr",
          "de",
          "el",
          "gu",
          "he",
          "hi",
          "hu",
          "id",
          "ga",
          "it",
          "ja",
          "kn",
          "kk",
          "ko",
          "lo",
          "lv",
          "lt",
          "mk",
          "ms",
          "mr",
          "nb",
          "fa",
          "pl",
          "pt_BR",
          "pt_PT",
          "pa",
          "ro",
          "ru",
          "sr",
          "sk",
          "sl",
          "es",
          "es_AR",
          "es_ES",
          "es_MX",
          "sw",
          "sv",
          "ta",
          "te",
          "th",
          "tr",
          "uk",
          "ur",
          "uz",
          "vi"
        ],
        "example": "en",
        "description": "Template language"
      },
      "TemplateNamespaceProp": {
        "type": "string",
        "description": "Can be found by method /templates",
        "example": "ca300906_cfbc_410b_99fb_dcee8e13d578"
      },
      "TemplateNamespaceField": {
        "type": "object",
        "properties": {
          "namespace": {
            "type": "string",
            "example": "ca300906_cfbc_410b_99fb_dcee8e13d578"
          }
        }
      },
      "Ack": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "unique id of message",
            "example": "true_12020721369@c.us_DF38E6A25B42CC8CCE13EC40F"
          },
          "chatId": {
            "type": "string",
            "description": "chat ID",
            "example": "12020721369@c.us"
          },
          "status": {
            "type": "string",
            "description": "type of the message status",
            "enum": [
              "delivered",
              "viewed",
              "sent"
            ],
            "example": "viewed"
          }
        }
      },
      "AddTemplateRequest": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "Name of template",
            "example": "start"
          },
          "category": {
            "$ref": "#/components/schemas/TemplateCategoryProp"
          },
          "components": {
            "$ref": "#/components/schemas/TemplateComponentsProp"
          },
          "language": {
            "$ref": "#/components/schemas/TemplateLanguageProp"
          }
        }
      },
      "ChatIdProp": {
        "type": "object",
        "properties": {
          "chatId": {
            "description": "**Required if phone is not set**\n\nChat ID from the message list. Examples: 12020721369@c.us\n. Used instead of the phone parameter.",
            "type": "string",
            "example": "12020721369@c.us"
          }
        }
      },
      "PhoneProp": {
        "type": "object",
        "properties": {
          "phone": {
            "description": "**Required if chatId is not set**\n\nA phone number starting with the country code. You do not\nneed to add your number. \n\nUSA example: 12020721369.",
            "type": "string",
            "example": "12020721369"
          }
        }
      },
      "MessageIdProp": {
        "type": "object",
        "properties": {
          "messageId": {
            "description": "Message ID. Example: 0XzkmGNn4prUAQlzsHApGNRXQ0U",
            "type": "string",
            "example": "0XzkmGNn4prUAQlzsHApGNRXQ0U"
          }
        }
      },
      "Message": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "unique id",
            "example": "ABGHYoIXMAmY13IKOick9az6QYmt4R"
          },
          "body": {
            "type": "string",
            "description": "text message for type \"chat\", or link to download the file for \"ptt\", \"image\", \"audio\", \"video\" and \"document\", or latitude and longitude for \"location\", or message \"[Call]\" for \"call_log\"",
            "example": "Ok!"
          },
          "fromMe": {
            "type": "boolean",
            "description": "true - outgoing, false - incoming",
            "example": true
          },
          "self": {
            "type": "integer",
            "description": "1 - generated by api, 0 - generated by app",
            "example": 0
          },
          "isForwarded": {
            "type": "boolean",
            "description": "true - forwarded message, false - direct message",
            "example": false
          },
          "author": {
            "type": "string",
            "description": "Author ID of the message",
            "example": "12020721369@c.us"
          },
          "time": {
            "type": "integer",
            "description": "send time, unix timestamp",
            "example": 1665396610
          },
          "chatId": {
            "type": "string",
            "description": "chat ID",
            "example": "12020721369@c.us"
          },
          "type": {
            "type": "string",
            "description": "type of the message",
            "enum": [
              "chat",
              "interactive",
              "image",
              "video",
              "document",
              "audio",
              "sticker",
              "voice"
            ],
            "example": "chat"
          },
          "senderName": {
            "type": "string",
            "description": "Sender name",
            "example": "John"
          },
          "caption": {
            "type": "string",
            "description": "File caption or filename",
            "example": "photo.jpg"
          },
          "quotedMsgId": {
            "type": "string",
            "description": "ID of quoted message",
            "example": "ABGHYoIXMAmYTwIKOick9az6QYmt4R"
          }
        }
      },
      "SetMe": {
        "type": "object",
        "properties": {
          "result": {
            "type": "string",
            "nullable": false,
            "example": "success"
          }
        }
      },
      "SetMeRequest": {
        "allOf": [
          {
            "$ref": "#/components/schemas/MeComponents"
          }
        ]
      },
      "MeComponents": {
        "type": "object",
        "properties": {
          "about": {
            "type": "string",
            "description": "Profile`s About section.",
            "example": "Some about info"
          },
          "address": {
            "type": "string",
            "description": "Address of the business",
            "example": "Neverland, Unexpected st."
          },
          "description": {
            "type": "string",
            "description": "Description of the business. Max 256 characters",
            "example": "Some company description"
          },
          "email": {
            "type": "string",
            "description": "Business email",
            "example": "john@neverland.play"
          },
          "phone": {
            "type": "string",
            "description": "Linked phone number",
            "example": "12020721369"
          },
          "vertical": {
            "type": "string",
            "enum": [
              "Automotive",
              "Beauty, Spa and Salon",
              "Clothing and Apparel",
              "Education",
              "Entertainment",
              "Event Planning and Service",
              "Finance and Banking",
              "Food and Grocery",
              "Public Service",
              "Hotel and Lodging",
              "Medical and Health",
              "Non-profit",
              "Professional Services",
              "Shopping and Retail",
              "Travel and Transportation",
              "Restaurant",
              "Other",
              ""
            ],
            "example": "Other",
            "description": "Industry of the business"
          },
          "photo": {
            "description": "HTTP link\n*https://...*\n\nOr base64-encoded file with mime data, for example\n*data:image/jpeg;base64,/9j/4AAQSkZJRgABAQ...* \n\nFile in form-data input field",
            "type": "string"
          }
        }
      },
      "GetMe": {
        "allOf": [
          {
            "$ref": "#/components/schemas/MeComponents"
          },
          {
            "type": "object",
            "properties": {
              "photo": {
                "type": "string",
                "nullable": false,
                "example": "https://pps.whatsapp.net/sample.jpg"
              }
            }
          }
        ]
      },
      "GetIP": {
        "type": "object",
        "properties": {
          "result": {
            "type": "string",
            "nullable": false,
            "example": "213.74.84.72"
          }
        }
      },
      "GetTemplates": {
        "type": "object",
        "properties": {
          "total": {
            "type": "integer",
            "nullable": false,
            "example": 3
          },
          "templates": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "category": {
                  "$ref": "#/components/schemas/TemplateCategoryProp"
                },
                "components": {
                  "$ref": "#/components/schemas/TemplateComponentsProp"
                },
                "language": {
                  "$ref": "#/components/schemas/TemplateLanguageProp"
                },
                "name": {
                  "type": "string",
                  "example": "start"
                },
                "namespace": {
                  "$ref": "#/components/schemas/TemplateNamespaceProp"
                },
                "rejected_reason": {
                  "type": "string",
                  "example": "NONE"
                },
                "status": {
                  "type": "string",
                  "example": "approved"
                }
              }
            }
          }
        }
      },
      "channelStatistics": {
        "type": "object",
        "properties": {
          "date": {
            "type": "string",
            "example": "03.2022"
          },
          "templates_cost": {
            "type": "number",
            "example": 400.0313
          }
        }
      },
      "channelExtendedStatistics": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "business_initiated_paid_quantity": {
              "type": "integer",
              "example": 1
            },
            "business_initiated_price": {
              "type": "number",
              "example": 0.0691
            },
            "business_initiated_quantity": {
              "type": "integer",
              "example": 2
            },
            "free_entry_point": {
              "type": "integer",
              "example": 0
            },
            "free_quantity": {
              "type": "integer",
              "example": 1
            },
            "free_tier": {
              "type": "integer",
              "example": 1
            },
            "paid_quantity": {
              "type": "integer",
              "example": 1
            },
            "period_date": {
              "type": "string",
              "example": "2022-11-01T00:00:00Z"
            },
            "quantity": {
              "type": "number",
              "example": 2
            },
            "total_price": {
              "type": "number",
              "example": 0.0691
            },
            "user_initiated_paid_quantity": {
              "type": "integer",
              "example": 1
            },
            "user_initiated_price": {
              "type": "number",
              "example": 0.0691
            },
            "user_initiated_quantity": {
              "type": "integer",
              "example": 2
            }
          }
        }
      },
      "channelStatus": {
        "type": "object",
        "properties": {
          "status": {
            "type": "string",
            "description": "channel Status",
            "enum": [
              "connected",
              "connecting",
              "disconnected",
              "uninitialized",
              "unregistered"
            ],
            "example": "connected"
          }
        }
      },
      "RemoveTemplateRequest": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "Template name",
            "example": "start"
          }
        }
      },
      "SendFileRequest": {
        "allOf": [
          {
            "type": "object",
            "properties": {
              "body": {
                "description": "HTTP link\n*https://...*\n\nOr base64-encoded file with mime data, for example\n*data:image/jpeg;base64,/9j/4AAQSkZJRgABAQ...* \n\nFile in form-data input field",
                "type": "string"
              },
              "filename": {
                "description": "File name, for *example 1.jpg* or *hello.xlsx*",
                "type": "string"
              },
              "caption": {
                "description": "Text under the file. When sending an image сan be used with mentionedPhones, example: this image for @556123122026",
                "type": "string"
              }
            },
            "required": [
              "body",
              "filename"
            ]
          },
          {
            "$ref": "#/components/schemas/ChatIdProp"
          },
          {
            "$ref": "#/components/schemas/PhoneProp"
          }
        ]
      },
      "SendListRequest": {
        "allOf": [
          {
            "type": "object",
            "properties": {
              "body": {
                "type": "string",
                "description": "Main message text",
                "example": "Please choose option"
              },
              "header": {
                "type": "string",
                "description": "Header will be located above message text",
                "example": "Some options"
              },
              "footer": {
                "type": "string",
                "description": "Footer will be placed under message text",
                "example": "Thank you"
              },
              "action": {
                "type": "string",
                "description": "Action for open list",
                "example": "List"
              },
              "sections": {
                "type": "array",
                "description": "Up to 10 sections from which the client can choose.\n\nEach section is object with fields:\n\n*title* - Title of section, up to 24 symbols. Required if there are more then 1 section\n\n*rows* - available options. Required\n\n\n\nEach option is object with fields:\n\n*id* - Unique id for option, up to 200 symbols. Required\n\n*title* - Title of option, up to 24 symbols. Required\n\n*description* - Description of option, up to 72 symbols\n\n\n\nExample:\n\n[{\"title\":\"Section 1\",\"rows\":[{\"id\":\"1\",\"title\":\"Option 1\",\"description\":\"Description 1\"}]},{\"title\":\"Section 2\",\"rows\":[{\"id\":\"2\",\"title\":\"Option 2\",\"description\":\"Description 2\"}]}]",
                "example": [
                  {
                    "title": "Section 1",
                    "rows": [
                      {
                        "id": "1",
                        "title": "Option 1",
                        "description": "Description 1"
                      }
                    ]
                  },
                  {
                    "title": "Section 2",
                    "rows": [
                      {
                        "id": "2",
                        "title": "Option 2",
                        "description": "Description 2"
                      }
                    ]
                  }
                ],
                "items": {
                  "type": "object",
                  "properties": {
                    "title": {
                      "type": "string",
                      "example": "Some title",
                      "description": "Title of section, up to 24 symbols. Required if there are more then 1 section"
                    },
                    "rows": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "Unique id for option, up to 200 symbols",
                            "example": "1"
                          },
                          "title": {
                            "type": "string",
                            "description": "Title of option, up to 24 symbols.",
                            "example": "Some option"
                          },
                          "description": {
                            "type": "string",
                            "description": "Description of option, up to 72 symbols",
                            "example": "Some description"
                          }
                        },
                        "required": [
                          "id",
                          "title"
                        ]
                      }
                    }
                  },
                  "required": [
                    "rows"
                  ]
                }
              }
            },
            "required": [
              "body",
              "action",
              "sections"
            ]
          },
          {
            "$ref": "#/components/schemas/ChatIdProp"
          },
          {
            "$ref": "#/components/schemas/PhoneProp"
          }
        ]
      },
      "SendMessageRequest": {
        "allOf": [
          {
            "type": "object",
            "properties": {
              "body": {
                "description": "Message text, UTF-8 or UTF-16 string with emoji 🍏. Can be used with mentionedPhones, example: this text for @556123122026",
                "type": "string"
              }
            },
            "required": [
              "body"
            ]
          },
          {
            "$ref": "#/components/schemas/ChatIdProp"
          },
          {
            "$ref": "#/components/schemas/PhoneProp"
          }
        ]
      },
      "SendLocationRequest": {
        "allOf": [
          {
            "type": "object",
            "properties": {
              "lat": {
                "description": "Latitude of the location. Example: 45.018337",
                "type": "string",
                "example": "45.018337"
              },
              "lng": {
                "description": "Longitude of the location. Example: -73.968285",
                "type": "string",
                "example": "-73.968285"
              },
              "address": {
                "description": "Address of the location. Only displayed if name is present. Example: 9766 Valley View St., New York, NY 10024",
                "type": "string",
                "example": "9766 Valley View St., New York, NY 10024"
              },
              "name": {
                "description": "Name of the location. Example: Facebook HQ",
                "type": "string",
                "example": "Facebook HQ"
              }
            },
            "required": [
              "lat",
              "name",
              "lng"
            ]
          },
          {
            "$ref": "#/components/schemas/ChatIdProp"
          },
          {
            "$ref": "#/components/schemas/PhoneProp"
          }
        ]
      },
      "SendContactRequest": {
        "allOf": [
          {
            "type": "object",
            "properties": {
              "contacts": {
                "description": "Array containing contact objects.\n\nContact object parameters:\n\n**name** - full contact name. Required. Object with properties:\n\n* formatted_name - Full name, as it normally appears. Example: Lord Adam John Smith Junior. You have to use at least one additional parameter (first_name, last_name, middle_name, suffix, prefix)\n\n* first_name - First name. Example: Adam\n\n* last_name - Last name. Example: Smith\n\n* middle_name - Middle name. Example: John\n\n* suffix - Name suffix. Example: Junior\n\n* prefix - Name prefix. Example: Lord\n\n**birthday** - YYYY-MM-DD formatted string. Example: 2012-08-18\n\n**addresses** - array containing address objects with parameters:\n\n* street - Street number and name. Example: 1 Hacker Way\n\n* city - City name. Example: Menlo Park\n\n* state - State abbreviation. Example: CA\n\n* zip - ZIP code. Example: 94025\n\n* country - Full country name. Example: United States\n\n* country_code - Two-letter country abbreviation. Example: us\n\n* type - Standard Values: HOME, WORK. Example: HOME\n\n**emails** - array containing email objects with parameters:\n\n* email - Email address. Example: test@fb.com\n\n* type - Standard Values: HOME, WORK. Example: WORK\n\n**org** - object containing parameters:\n\n* company - Name of the contact's company. Example: WhatsApp\n\n* department - Name of the contact's department. Example: Design\n\n* title - Contact's business title. Example: Manager\n\n**phones** - array containing phone objects with parameters:\n\n* phone - Automatically populated with the wa_id value as a formatted phone number. Example: +1 (940) 555-1234\n\n* type - Standard Values: CELL, MAIN, IPHONE, HOME, WORK. Example: HOME\n\n* wa_id - WhatsApp ID. Example: 19405551234\n\n**urls** - array containing url objects with parameters:\n\n* url - URL. Example: https://www.facebook.com\n\n* type - Standard Values: HOME, WORK. Example: WORK\n\nExample: [{\"addresses\":[{\"city\":\"Menlo Park\",\"country\":\"United States\",\"country_code\":\"us\",\"state\":\"CA\",\"street\":\"1 Hacker Way\",\"type\":\"HOME\",\"zip\":\"94025\"},{\"city\":\"Menlo Park\",\"country\":\"United States\",\"country_code\":\"us\",\"state\":\"CA\",\"street\":\"200 Jefferson Dr\",\"type\":\"WORK\",\"zip\":\"94025\"}],\"birthday\":\"2012-08-18\",\"emails\":[{\"email\":\"test@fb.com\",\"type\":\"WORK\"},{\"email\":\"test@whatsapp.com\",\"type\":\"WORK\"}],\"name\":{\"first_name\":\"John\",\"formatted_name\":\"John Smith\",\"last_name\":\"Smith\"},\"org\":{\"company\":\"WhatsApp\",\"department\":\"Design\",\"title\":\"Manager\"},\"phones\":[{\"phone\":\"+1 (940) 555-1234\",\"type\":\"HOME\"},{\"phone\":\"+1 (650) 555-1234\",\"type\":\"WORK\",\"wa_id\":\"16505551234\"}],\"urls\":[{\"url\":\"https://www.facebook.com\",\"type\":\"WORK\"}]}]",
                "type": "array",
                "items": {
                  "type": "object"
                },
                "example": "[{\"addresses\":[{\"city\":\"Menlo Park\",\"country\":\"United States\",\"country_code\":\"us\",\"state\":\"CA\",\"street\":\"1 Hacker Way\",\"type\":\"HOME\",\"zip\":\"94025\"},{\"city\":\"Menlo Park\",\"country\":\"United States\",\"country_code\":\"us\",\"state\":\"CA\",\"street\":\"200 Jefferson Dr\",\"type\":\"WORK\",\"zip\":\"94025\"}],\"birthday\":\"2012-08-18\",\"emails\":[{\"email\":\"test@fb.com\",\"type\":\"WORK\"},{\"email\":\"test@whatsapp.com\",\"type\":\"WORK\"}],\"name\":{\"first_name\":\"John\",\"formatted_name\":\"John Smith\",\"last_name\":\"Smith\"},\"org\":{\"company\":\"WhatsApp\",\"department\":\"Design\",\"title\":\"Manager\"},\"phones\":[{\"phone\":\"+1 (940) 555-1234\",\"type\":\"HOME\"},{\"phone\":\"+1 (650) 555-1234\",\"type\":\"WORK\",\"wa_id\":\"16505551234\"}],\"urls\":[{\"url\":\"https://www.facebook.com\",\"type\":\"WORK\"}]}]"
              }
            },
            "required": [
              "body"
            ]
          },
          {
            "$ref": "#/components/schemas/ChatIdProp"
          },
          {
            "$ref": "#/components/schemas/PhoneProp"
          }
        ]
      },
      "SendMessageStatus": {
        "type": "object",
        "properties": {
          "sent": {
            "type": "boolean",
            "example": true
          },
          "id": {
            "type": "string",
            "description": "unique message id",
            "example": "gBGGeRhGZTEfAgkJCh2wAz4ZH-8"
          },
          "message": {
            "type": "string",
            "description": "Posting status message",
            "example": "Sent to 556123122026@c.us"
          },
          "description": {
            "type": "string",
            "description": "Result description",
            "example": "Message has been sent to the provider"
          }
        }
      },
      "SendTemplateRequest": {
        "allOf": [
          {
            "type": "object",
            "properties": {
              "namespace": {
                "type": "string",
                "description": "Can be found by method /templates",
                "example": "ca300906_cfbc_410b_99fb_dcee1t39d578"
              },
              "template": {
                "type": "string",
                "description": "Name of template",
                "example": "start"
              },
              "language": {
                "type": "object",
                "properties": {
                  "policy": {
                    "type": "string",
                    "enum": [
                      "deterministic"
                    ],
                    "example": "deterministic"
                  },
                  "code": {
                    "$ref": "#/components/schemas/TemplateLanguageProp"
                  }
                },
                "description": "Object, containing fields \"policy\" and \"code\".\n\n**policy** - now \"deterministic\" is only available option;\n\n**code** - one of supported language codes"
              },
              "params": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "default": {
                      "type": "string",
                      "example": "Some title"
                    },
                    "currency": {
                      "type": "object",
                      "properties": {
                        "currency_code": {
                          "type": "string",
                          "example": "USD"
                        },
                        "amount_1000": {
                          "type": "integer",
                          "example": "100990"
                        }
                      }
                    },
                    "date_time": {
                      "type": "object",
                      "properties": {
                        "component": {
                          "type": "object",
                          "properties": {
                            "day_of_week": {
                              "type": "string",
                              "enum": [
                                "MONDAY",
                                "TUESDAY",
                                "WEDNESDAY",
                                "THURSDAY",
                                "FRIDAY",
                                "SATURDAY",
                                "SUNDAY",
                                1,
                                2,
                                3,
                                4,
                                5,
                                6,
                                7
                              ],
                              "example": "FRIDAY"
                            },
                            "year": {
                              "type": "integer",
                              "example": 2001
                            },
                            "month": {
                              "type": "integer",
                              "example": 4
                            },
                            "day_of_month": {
                              "type": "integer",
                              "example": 13
                            },
                            "hour": {
                              "type": "integer",
                              "example": "17"
                            },
                            "minute": {
                              "type": "integer",
                              "example": 20
                            },
                            "calendar": {
                              "type": "string",
                              "enum": [
                                "GREGORIAN",
                                "SOLAR_HIJRI"
                              ],
                              "example": "GREGORIAN"
                            }
                          }
                        },
                        "unix_epoch": {
                          "type": "object",
                          "properties": {
                            "timestamp": {
                              "type": "integer",
                              "example": 987168000
                            }
                          }
                        }
                      }
                    }
                  }
                },
                "description": "Array of localizable parameters to be substituted into the template. Each parameter is object contains the following field:\n\n**type** - section of parameters - header, body, footer, button\n\n**parameters** - variables for section.\n\nEach variable is an object that can contain the following fields:\n\n**type** - can be text, currency, date_time, image, document or video\n\n**video**- id (mediaId)\n\n**document** \n\n* id (mediaId)\n\n* filename(optional)\n\n**image** - object with field link (image url)\n\n**currency** - object containing parameters currency_code and amount_1000.\n\n* *currency_code* - Currency code as defined in ISO 4217.\n\n* *amount_1000* - Amount multiplied by 1000.\n\n* *fallback_value* - Default text if localization fails.\n\n**date_time** - If the date_time object is used, further definition of the date and time is required.\n\n* *component* - The time is assembled from components (i.e., day of the week, month, hour, etc.) The time specified will be the same, regardless of the time zone the client is in.\n\n* *unix_epoch* - The time to be displayed is dependent on the time zone the client is in.\n\n* *fallback_value* - Default text if localization fails.\n\n**button** - if button has parameter \n\n* sub_type (url/quick_reply)\n\n* parameters (array to fill button variable)\n\n* index - button position.\n\n**The number of parameters passed must match the number of parameters in the template**"
              }
            },
            "required": [
              "namespace",
              "template",
              "language"
            ]
          },
          {
            "$ref": "#/components/schemas/TemplateNamespaceField"
          },
          {
            "$ref": "#/components/schemas/ChatIdProp"
          },
          {
            "$ref": "#/components/schemas/PhoneProp"
          }
        ]
      },
      "SendProductRequest": {
        "allOf": [
          {
            "type": "object",
            "properties": {
              "action": {
                "description": "Object containing info about product or catalog. Can contain the following fields:\n\n**catalog_id** - id of catalog\n\n**product_retailer_id** - id of product. Only for sending single product.\n\n**sections** - used for sending multiply products. It`s array containing objects with catalog info. See example below.\n\nExample: {\"catalog_id\":\"{{catalog_id}}\",\"sections\":[{\"title\":\"the-section-title\",\"product_items\":[{\"product_retailer_id\":\"{{SKU-1}}\"},{\"product_retailer_id\":\"{{SKU-2}}\"}]},{\"title\":\"the-section-title2\",\"product_items\":[{\"product_retailer_id\":\"{{SKU-1}}\"}]}]}",
                "type": "object",
                "properties": {
                  "catalog_id": {
                    "type": "string",
                    "description": "id of the catalog",
                    "example": "407921857496983"
                  },
                  "product_retailer_id": {
                    "type": "string",
                    "description": "id of the product",
                    "example": "product-1"
                  },
                  "sections": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "title": {
                          "type": "string",
                          "description": "Title of the section. Example: the-section-title",
                          "example": "the-section-title"
                        },
                        "product_items": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "product_retailer_id": {
                                "type": "string",
                                "description": "id of the product",
                                "example": "product-1"
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                },
                "example": "{\"catalog_id\":\"{{catalog_id}}\",\"sections\":[{\"title\":\"the-section-title\",\"product_items\":[{\"product_retailer_id\":\"{{SKU-1}}\"},{\"product_retailer_id\":\"{{SKU-2}}\"}]},{\"title\":\"the-section-title2\",\"product_items\":[{\"product_retailer_id\":\"{{SKU-1}}\"}]}]}"
              },
              "body": {
                "type": "string",
                "description": "Text of message. Example: Some text.",
                "example": "Some text"
              },
              "footer": {
                "type": "string",
                "description": "Located under the message text. Example: Footer.",
                "example": "Footer"
              },
              "header": {
                "type": "string",
                "description": "Header of catalog. Example: Header.\n\n**Required when sending the catalog.**",
                "example": "Header"
              }
            },
            "required": [
              "action"
            ]
          },
          {
            "$ref": "#/components/schemas/ChatIdProp"
          },
          {
            "$ref": "#/components/schemas/PhoneProp"
          }
        ]
      },
      "Settings": {
        "type": "object",
        "properties": {
          "webhookUrl": {
            "type": "string",
            "nullable": true,
            "example": "https://bin.1msg.io/1f9aj261"
          }
        }
      },
      "Commerce": {
        "type": "object",
        "properties": {
          "params": {
            "type": "object",
            "required": [
              "is_cart_enabled",
              "is_catalog_visible"
            ],
            "properties": {
              "is_cart_enabled": {
                "type": "boolean",
                "example": true
              },
              "is_catalog_visible": {
                "type": "boolean",
                "example": true
              }
            }
          }
        }
      },
      "GetCommerce": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "example": "789887292550821"
            },
            "is_cart_enabled": {
              "type": "boolean",
              "example": true
            },
            "is_catalog_visible": {
              "type": "boolean",
              "example": true
            }
          }
        }
      },
      "SetCommerce": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "example": true
          }
        }
      },
      "SetWebhookStatus": {
        "type": "object",
        "properties": {
          "set": {
            "type": "boolean",
            "description": "Flag indicating that the current request has changed webhook",
            "example": true
          },
          "message": {
            "type": "string",
            "example": "https://bin.1msg.io/1f9aj261"
          }
        }
      },
      "WebhookUrl": {
        "type": "object",
        "properties": {
          "webhookUrl": {
            "description": "Http or https URL for receiving notifications. For testing, we recommend using [our RequestBin](http://bin.1msg.io).",
            "type": "string"
          }
        },
        "required": [
          "webhookUrl"
        ]
      },
      "Contacts": {
        "type": "object",
        "properties": {
          "contacts": {
            "description": "List of checked numbers",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "input": {
                  "type": "string",
                  "description": "Sent value",
                  "example": "16315551000"
                },
                "status": {
                  "type": "string",
                  "description": "Contacts status: \n\n*failed* - got error on processing\n\n*processing* - still not detected\n\n*invalid* - unavailable for sending\n\n*valid* - available for sending",
                  "example": "valid"
                },
                "wa_id": {
                  "type": "string",
                  "description": "Formatted contact phone",
                  "example": "16315551000"
                }
              }
            }
          }
        }
      },
      "ContactsRequest": {
        "type": "object",
        "required": [
          "contacts"
        ],
        "properties": {
          "blocking": {
            "type": "string",
            "description": "Operating mode:\n\n*wait* - synchronous\n\n*no_wait* - asynchronous (default)",
            "example": "wait"
          },
          "force_check": {
            "type": "boolean",
            "description": "Using cache:\n\n*true* - ignore cache\n\n*false* - use cache (default)",
            "example": true
          },
          "contacts": {
            "type": "array",
            "description": "Array of contact numbers for checking. Recommended format is +16315551001\n\nExample:\n\n[\"16315551000\",\"+1 631 555 1001\",\"6315551002\",\"+1 (631) 555-1004\",\"1-631-555-1005\"]",
            "items": {
              "type": "string"
            },
            "example": [
              "16315551000",
              "+1 631 555 1001",
              "6315551002",
              "+1 (631) 555-1004",
              "1-631-555-1005"
            ]
          }
        }
      },
      "ReadMessageRequest": {
        "allOf": [
          {
            "$ref": "#/components/schemas/MessageIdProp"
          }
        ]
      },
      "UploadMedia": {
        "allOf": [
          {
            "type": "object",
            "properties": {
              "body": {
                "description": "HTTP link\n*https://...*\n\nOr base64-encoded file with mime data, for example\n*data:image/jpeg;base64,/9j/4AAQSkZJRgABAQ...* \n\nFile in form-data input field",
                "type": "string"
              }
            },
            "required": [
              "body"
            ]
          }
        ]
      },
      "MediaId": {
        "type": "object",
        "properties": {
          "mediaId": {
            "type": "string",
            "example": "ed2c7be7-b779-4ba8-a17c-6722f37be2a7"
          }
        }
      },
      "GetMessages": {
        "type": "object",
        "properties": {
          "messages": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "messageNumber": {
                  "type": "integer",
                  "example": 1
                },
                "id": {
                  "type": "string",
                  "example": "0XzkmGNn4prUAQlzsHApGNRXQ0U"
                },
                "body": {
                  "type": "string",
                  "example": "Test message"
                },
                "fromMe": {
                  "type": "boolean",
                  "example": true
                },
                "self": {
                  "type": "integer",
                  "example": 1
                },
                "isForwarded": {
                  "type": "integer",
                  "example": 0
                },
                "author": {
                  "type": "string",
                  "example": "556123122026@c.us"
                },
                "time": {
                  "type": "integer",
                  "example": 1665396610
                },
                "chatId": {
                  "type": "string",
                  "example": "556123122026@c.us"
                },
                "type": {
                  "type": "string",
                  "example": "chat"
                },
                "senderName": {
                  "type": "string",
                  "example": "780005553535@c.us"
                },
                "caption": {
                  "type": "string",
                  "example": null
                },
                "quotedMsgId": {
                  "type": "string",
                  "example": null
                },
                "metadata": {
                  "type": "object",
                  "example": {}
                },
                "chatName": {
                  "type": "string",
                  "example": "556123122026"
                }
              }
            }
          }
        }
      },
      "GetAckInfo": {
        "type": "object",
        "properties": {
          "hooks": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "example": "gBGGeSaGViBfAgnlzOSHEwK9O6F"
                },
                "type": {
                  "type": "string",
                  "example": "message"
                },
                "status": {
                  "type": "string",
                  "example": "sent"
                },
                "pricing": {
                  "type": "object",
                  "example": {
                    "billable": true,
                    "category": "business_initiated",
                    "pricing_model": "CBP"
                  }
                },
                "timestamp": {
                  "type": "string",
                  "example": "1654864094"
                },
                "conversation": {
                  "type": "object",
                  "example": {
                    "id": "c1f5a3a1b9ff6f2e1c43fd31543137e0",
                    "origin": {
                      "type": "business_initiated"
                    },
                    "expiration_timestamp": 1654943940
                  }
                },
                "recipient_id": {
                  "type": "string",
                  "example": "556123122026"
                }
              }
            }
          }
        }
      }
    },
    "responses": {
      "AddTemplate": {
        "description": "Server response example",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/AddTemplate"
            }
          }
        }
      },
      "channelStatistics": {
        "description": "Server response example",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/channelStatistics"
            }
          }
        }
      },
      "channelExtendedStatistics": {
        "description": "Server response example",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/channelExtendedStatistics"
            }
          }
        }
      },
      "channelStatus": {
        "description": "Server response example",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/channelStatus"
            }
          }
        }
      },
      "GetMe": {
        "description": "Server response example",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/GetMe"
            }
          }
        }
      },
      "GetTemplates": {
        "description": "Server response example",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/GetTemplates"
            }
          }
        }
      },
      "RemoveTemplate": {
        "description": "Server response example",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/SetMe"
            }
          }
        }
      },
      "SendMessageStatus": {
        "description": "Server response example",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/SendMessageStatus"
            }
          }
        }
      },
      "SendTemplate": {
        "description": "Server response example",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/SendMessageStatus"
            }
          }
        }
      },
      "SetMe": {
        "description": "Server response example",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/SetMe"
            }
          }
        }
      },
      "Settings": {
        "description": "Server response example",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Settings"
            }
          }
        }
      },
      "GetCommerce": {
        "description": "Server response example",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/GetCommerce"
            }
          }
        }
      },
      "SetCommerce": {
        "description": "Server response example",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/SetCommerce"
            }
          }
        }
      },
      "SetWebhookStatus": {
        "description": "Server response example",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/SetWebhookStatus"
            }
          }
        }
      },
      "Unauthorized": {
        "description": "Invalid token",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "error": {
                  "type": "string",
                  "example": "Wrong token \"xxx7i1crxjxpkxxx\" for channel \"123\". Please provide token as a GET parameter."
                }
              }
            }
          }
        }
      },
      "UpdateSettings": {
        "description": "Server response example",
        "content": {
          "application/json": {
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/Settings"
                },
                {
                  "type": "object",
                  "required": [
                    "update"
                  ],
                  "properties": {
                    "update": {
                      "allOf": [
                        {
                          "$ref": "#/components/schemas/Settings"
                        },
                        {
                          "description": "An object that lists the fields changed in the request"
                        }
                      ]
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "UploadMedia": {
        "description": "Server response example",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/MediaId"
            }
          }
        }
      },
      "GetMessages": {
        "description": "Server response example",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/GetMessages"
            }
          }
        }
      },
      "GetAckInfo": {
        "description": "Server response example",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/GetAckInfo"
            }
          }
        }
      },
      "GetIP": {
        "description": "Server response example",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/GetIP"
            }
          }
        }
      },
      "ReadMessage": {
        "description": "Server response example",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/SetMe"
            }
          }
        }
      }
    },
    "requestBodies": {
      "Ack": {
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "ack": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/Ack"
                  }
                }
              }
            }
          }
        }
      },
      "AddTemplate": {
        "required": true,
        "content": {

          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/AddTemplateRequest"
            }
          },
          "application/x-www-form-urlencoded": {
            "schema": {
              "$ref": "#/components/schemas/AddTemplateRequest"
            }
          }
        }
      },
      "Messages": {
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "messages": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/Message"
                  }
                }
              }
            }
          }
        }
      },
      "UpdateSettings": {
        "required": true,
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Settings"
            }
          },
          "application/x-www-form-urlencoded": {
            "schema": {
              "$ref": "#/components/schemas/Settings"
            }
          }
        }
      },
      "UpdateCommerce": {
        "required": true,
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Commerce"
            }
          },
          "application/x-www-form-urlencoded": {
            "schema": {
              "$ref": "#/components/schemas/Commerce"
            }
          }
        }
      },
      "RemoveTemplate": {
        "required": true,
        "content": {

          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/RemoveTemplateRequest"
            }
          },
          "application/x-www-form-urlencoded": {
            "schema": {
              "$ref": "#/components/schemas/RemoveTemplateRequest"
            }
          }
        }
      },
      "SendMessage": {
        "required": true,
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/SendMessageRequest"
            }
          },
          "application/x-www-form-urlencoded": {
            "schema": {
              "$ref": "#/components/schemas/SendMessageRequest"
            }
          }
        }
      },
      "SendLocation": {
        "required": true,
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/SendLocationRequest"
            }
          },
          "application/x-www-form-urlencoded": {
            "schema": {
              "$ref": "#/components/schemas/SendLocationRequest"
            }
          }
        }
      },
      "SendContact": {
        "required": true,
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/SendContactRequest"
            }
          },
          "application/x-www-form-urlencoded": {
            "schema": {
              "$ref": "#/components/schemas/SendContactRequest"
            }
          }
        }
      },
      "SendTemplate": {
        "required": true,
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/SendTemplateRequest"
            }
          },
          "application/x-www-form-urlencoded": {
            "schema": {
              "$ref": "#/components/schemas/SendTemplateRequest"
            }
          }
        }
      },
      "SendFile": {
        "required": true,
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/SendFileRequest"
            }
          },
          "application/x-www-form-urlencoded": {
            "schema": {
              "$ref": "#/components/schemas/SendFileRequest"
            }
          }
        }
      },
      "SendList": {
        "required": true,
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/SendListRequest"
            }
          },
          "application/x-www-form-urlencoded": {
            "schema": {
              "$ref": "#/components/schemas/SendListRequest"
            }
          }
        }
      },
      "SendProduct": {
        "required": true,
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/SendProductRequest"
            }
          },
          "application/x-www-form-urlencoded": {
            "schema": {
              "$ref": "#/components/schemas/SendProductRequest"
            }
          }
        }
      },
      "SetMe": {
        "required": true,
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/SetMeRequest"
            }
          },
          "application/x-www-form-urlencoded": {
            "schema": {
              "$ref": "#/components/schemas/SetMeRequest"
            }
          }
        }
      },
      "SetWebhook": {
        "required": true,
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/WebhookUrl"
            }
          },
          "application/x-www-form-urlencoded": {
            "schema": {
              "$ref": "#/components/schemas/WebhookUrl"
            }
          }
        }
      },
      "UploadMedia": {
        "required": true,
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/UploadMedia"
            }
          },
          "application/x-www-form-urlencoded": {
            "schema": {
              "$ref": "#/components/schemas/UploadMedia"
            }
          }
        }
      },
      "ReadMessage": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ReadMessageRequest"
            }
          },
          "application/x-www-form-urlencoded": {
            "schema": {
              "$ref": "#/components/schemas/ReadMessageRequest"
            }
          }
        }
      }
    },
    "callbacks": {
      "Messages": {
        "{$request.body#/webhookUrl}": {
          "post": {
            "tags": [
              "Webhooks"
            ],
            "summary": "New message notification",
            "description": "Sent on every new incoming or outgoing message to the URL specified in the settings in the field **webhookUrl**",
            "operationId": "webhookMessages",
            "requestBody": {
              "$ref": "#/components/requestBodies/Messages"
            },
            "responses": {
              "200": {
                "description": "OK"
              }
            }
          }
        }
      },
      "Ack": {
        "{$request.body#/webhookUrl}": {
          "post": {
            "tags": [
              "Webhooks"
            ],
            "summary": "Message delivery status notification",
            "description": "Sent on outgoing message status updates (delivered, read) to the address set in **webhookUrl** in settings \n\nIt works only if the settings **webhookUrl** and **ackNotificationsOn**",
            "operationId": "webhookAck",
            "requestBody": {
              "$ref": "#/components/requestBodies/Ack"
            },
            "responses": {
              "200": {
                "description": "OK"
              }
            }
          }
        }
      }
    }
  }
}