{
  "info": {
    "name": "Siel SMS API",
    "description": "The REST API of Siel's SMS gateway. Every request carries one of your API\nkeys as a bearer token. Amounts are integers in micros, millionths of your\naccount's currency: 30000 is 0.03. Times are RFC 3339.\n\nGuides, examples in eight languages and the error codes are at\nhttps://docs.siellabs.com.\n\nSet the collection's apiKey variable to one of your API keys.",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
  },
  "auth": {
    "type": "bearer",
    "bearer": [
      {
        "key": "token",
        "value": "{{apiKey}}",
        "type": "string"
      }
    ]
  },
  "variable": [
    {
      "key": "baseUrl",
      "value": "https://api.siellabs.com"
    },
    {
      "key": "apiKey",
      "value": ""
    }
  ],
  "item": [
    {
      "name": "Messages",
      "item": [
        {
          "name": "Send a message",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "",
                "description": "Up to 255 characters, unique per message. A retry with the same key returns the original instead of sending again.",
                "disabled": true
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"to\": \"+447700900123\",\n  \"from\": \"YourBrand\",\n  \"body\": \"Your order #4821 has shipped\",\n  \"client_reference\": \"order-4821\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "url": {
              "raw": "{{baseUrl}}/v1/messages",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "messages"
              ]
            },
            "description": "Validates and prices a message, charges your balance and queues it.\nAnswers at once; delivery is reported by webhooks. Send `body`, or\n`template_id` with `variables`.\n\nKey permission: messages."
          }
        },
        {
          "name": "List messages",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/messages",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "messages"
              ],
              "query": [
                {
                  "key": "limit",
                  "value": "",
                  "description": "1 to 200. Default 50.",
                  "disabled": true
                }
              ]
            },
            "description": "Your most recent messages, newest first, however they were sent.\n\nKey permission: read."
          }
        },
        {
          "name": "Send a batch",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "",
                "description": "Up to 255 characters, unique per message. A retry with the same key returns the original instead of sending again.",
                "disabled": true
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"from\": \"YourBrand\",\n  \"body\": \"Hi {{name}}, your table is booked for {{time}}.\",\n  \"variables\": {\n    \"time\": \"19:30\"\n  },\n  \"messages\": [\n    {\n      \"to\": \"+447700900123\",\n      \"variables\": {\n        \"name\": \"Amy\"\n      },\n      \"client_reference\": \"booking-311\"\n    },\n    {\n      \"to\": \"+447700900456\",\n      \"variables\": {\n        \"name\": \"Ben\",\n        \"time\": \"20:00\"\n      }\n    }\n  ]\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "url": {
              "raw": "{{baseUrl}}/v1/messages/batch",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "messages",
                "batch"
              ]
            },
            "description": "One text or template to up to 100 numbers, each with its own\nvariables and reference. What applies to every message is checked\nfirst and fails the whole call; then each message is sent and answers\nfor itself. A batch waits its turn under your messages per second for\nup to 25 seconds; messages that would wait longer come back\n`rate_limited`.\n\nKey permission: messages."
          }
        },
        {
          "name": "Retrieve a message",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/messages/:id",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "messages",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": ""
                }
              ]
            },
            "description": "A message as it is now, with each part's delivery receipt and its short links.\n\nKey permission: read."
          }
        }
      ]
    },
    {
      "name": "Account",
      "item": [
        {
          "name": "Balance",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/balance",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "balance"
              ]
            },
            "description": "What your account has to send with, as of now.\n\nKey permission: read."
          }
        },
        {
          "name": "Prices",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/prices",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "prices"
              ],
              "query": [
                {
                  "key": "country",
                  "value": "",
                  "description": "Only this country's prices, ISO 3166-1 alpha-2.",
                  "disabled": true
                }
              ]
            },
            "description": "What you pay per part, by country and network, under your key's product, with announced changes.\n\nKey permission: read."
          }
        }
      ]
    },
    {
      "name": "OTP",
      "item": [
        {
          "name": "Send a code",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"to\": \"+447700900123\",\n  \"channels\": [\n    \"telegram\",\n    \"sms\"\n  ]\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "url": {
              "raw": "{{baseUrl}}/v1/verifications",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "verifications"
              ]
            },
            "description": "Makes a code and sends it by the first channel that can take it, falling back to the next.\n\nKey permission: otp."
          }
        },
        {
          "name": "List codes",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/verifications",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "verifications"
              ],
              "query": [
                {
                  "key": "to",
                  "value": "",
                  "description": "Only this number.",
                  "disabled": true
                },
                {
                  "key": "status",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "channel",
                  "value": "",
                  "description": "Only codes now carried by this channel.",
                  "disabled": true
                },
                {
                  "key": "limit",
                  "value": "",
                  "description": "1 to 200. Default 50.",
                  "disabled": true
                }
              ]
            },
            "description": "Key permission: otp."
          }
        },
        {
          "name": "Look a code up",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/verifications/:id",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "verifications",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": ""
                }
              ]
            },
            "description": "Key permission: otp."
          }
        },
        {
          "name": "Check a code",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"code\": \"\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "url": {
              "raw": "{{baseUrl}}/v1/verifications/:id/check",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "verifications",
                ":id",
                "check"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": ""
                }
              ]
            },
            "description": "Key permission: otp."
          }
        },
        {
          "name": "Check a code by number",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"to\": \"\",\n  \"code\": \"\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "url": {
              "raw": "{{baseUrl}}/v1/verifications/check",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "verifications",
                "check"
              ]
            },
            "description": "Checks the latest code sent to a number, for when you didn't keep its id.\n\nKey permission: otp."
          }
        }
      ]
    },
    {
      "name": "Templates",
      "item": [
        {
          "name": "List templates",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/templates",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "templates"
              ],
              "query": [
                {
                  "key": "name",
                  "value": "",
                  "description": "Only templates whose name starts with this.",
                  "disabled": true
                }
              ]
            },
            "description": "Key permission: templates."
          }
        },
        {
          "name": "Create a template",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"\",\n  \"body\": \"\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "url": {
              "raw": "{{baseUrl}}/v1/templates",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "templates"
              ]
            },
            "description": "Key permission: templates."
          }
        },
        {
          "name": "Retrieve a template",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/templates/:id",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "templates",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": ""
                }
              ]
            },
            "description": "Key permission: templates."
          }
        },
        {
          "name": "Update a template",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"\",\n  \"body\": \"\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "url": {
              "raw": "{{baseUrl}}/v1/templates/:id",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "templates",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": ""
                }
              ]
            },
            "description": "Key permission: templates."
          }
        },
        {
          "name": "Delete a template",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/templates/:id",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "templates",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": ""
                }
              ]
            },
            "description": "Key permission: templates."
          }
        }
      ]
    },
    {
      "name": "Sender IDs",
      "item": [
        {
          "name": "List sender IDs",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/senders",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "senders"
              ],
              "query": [
                {
                  "key": "status",
                  "value": "",
                  "description": "",
                  "disabled": true
                }
              ]
            },
            "description": "Registering one happens in the web app, where it's reviewed.\n\nKey permission: read."
          }
        },
        {
          "name": "Retrieve a sender ID",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/senders/:id",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "senders",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": ""
                }
              ]
            },
            "description": "Key permission: read."
          }
        }
      ]
    },
    {
      "name": "Webhooks",
      "item": [
        {
          "name": "List webhooks",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/webhooks",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "webhooks"
              ]
            },
            "description": "Where OTP events go. Message status events go to each message's callback URL instead.\n\nKey permission: webhooks."
          }
        },
        {
          "name": "Create a webhook",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"url\": \"\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "url": {
              "raw": "{{baseUrl}}/v1/webhooks",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "webhooks"
              ]
            },
            "description": "Key permission: webhooks."
          }
        },
        {
          "name": "Retrieve a webhook",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/webhooks/:id",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "webhooks",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": ""
                }
              ]
            },
            "description": "Key permission: webhooks."
          }
        },
        {
          "name": "Update a webhook",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"url\": \"\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "url": {
              "raw": "{{baseUrl}}/v1/webhooks/:id",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "webhooks",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": ""
                }
              ]
            },
            "description": "Key permission: webhooks."
          }
        },
        {
          "name": "Delete a webhook",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/webhooks/:id",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "webhooks",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": ""
                }
              ]
            },
            "description": "Key permission: webhooks."
          }
        }
      ]
    }
  ]
}