{
  "openapi": "3.0.3",
  "info": {
    "title": "Ctech SMS Gateway",
    "version": "2.0.0"
  },
  "servers": [
    {
      "url": "https://sms-gateway-api.ctechapp.com/api/v1"
    }
  ],
  "components": {
    "securitySchemes": {
      "bearer": {
        "type": "http",
        "scheme": "bearer"
      }
    }
  },
  "security": [
    {
      "bearer": []
    }
  ],
  "paths": {
    "/auth/token": {
      "post": {
        "summary": "Exchange client ID and secret for a Bearer token",
        "responses": {
          "200": {
            "description": "Success"
          },
          "401": {
            "description": "Unauthenticated"
          },
          "403": {
            "description": "Access denied"
          },
          "422": {
            "description": "Validation failed"
          },
          "429": {
            "description": "Rate limit exceeded"
          }
        },
        "security": [],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "client_id",
                  "client_secret"
                ],
                "properties": {
                  "client_id": {
                    "type": "string"
                  },
                  "client_secret": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/account": {
      "get": {
        "summary": "Read balance and assigned sender ID",
        "responses": {
          "200": {
            "description": "Success"
          },
          "401": {
            "description": "Unauthenticated"
          },
          "403": {
            "description": "Access denied"
          },
          "422": {
            "description": "Validation failed"
          },
          "429": {
            "description": "Rate limit exceeded"
          }
        }
      }
    },
    "/sms/requests": {
      "post": {
        "summary": "Reserve credits and queue a message request",
        "responses": {
          "200": {
            "description": "Success"
          },
          "401": {
            "description": "Unauthenticated"
          },
          "403": {
            "description": "Access denied"
          },
          "422": {
            "description": "Validation failed"
          },
          "429": {
            "description": "Rate limit exceeded"
          },
          "202": {
            "description": "Request queued"
          },
          "409": {
            "description": "Idempotency conflict or configuration pending"
          }
        },
        "parameters": [
          {
            "name": "Idempotency-Key",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "maxLength": 120
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "recipients"
                ],
                "properties": {
                  "message": {
                    "type": "string",
                    "maxLength": 1000
                  },
                  "recipients": {
                    "type": "array",
                    "minItems": 1,
                    "maxItems": 1000,
                    "items": {
                      "type": "object",
                      "required": [
                        "phone"
                      ],
                      "properties": {
                        "phone": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string",
                          "maxLength": 1000
                        },
                        "external_reference": {
                          "type": "string",
                          "maxLength": 255
                        }
                      }
                    }
                  },
                  "sender_id": {
                    "type": "string",
                    "maxLength": 20
                  },
                  "callback_url": {
                    "type": "string",
                    "format": "uri"
                  },
                  "metadata": {
                    "type": "object"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/sms/requests/{request_id}": {
      "get": {
        "summary": "Read this account\u2019s request status",
        "responses": {
          "200": {
            "description": "Success"
          },
          "401": {
            "description": "Unauthenticated"
          },
          "403": {
            "description": "Access denied"
          },
          "422": {
            "description": "Validation failed"
          },
          "429": {
            "description": "Rate limit exceeded"
          }
        },
        "parameters": [
          {
            "name": "request_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ]
      }
    },
    "/sms/requests/{request_id}/recipients": {
      "get": {
        "summary": "Read paginated recipient outcomes",
        "responses": {
          "200": {
            "description": "Success"
          },
          "401": {
            "description": "Unauthenticated"
          },
          "403": {
            "description": "Access denied"
          },
          "422": {
            "description": "Validation failed"
          },
          "429": {
            "description": "Rate limit exceeded"
          }
        },
        "parameters": [
          {
            "name": "request_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ]
      }
    }
  }
}
