{ "openapi": "3.1.0", "info": { "title": "TextMe API", "version": "1.0.0", "summary": "SMS, voice, OTP and campaign API.", "description": "Unified SMS, voice, OTP and campaign API.\n\nThe API is RPC-shaped: one URL, and the root element of the body selects the operation. That is described here faithfully as a single path with a `oneOf` request body. Note that most tool-calling clients flatten this into one opaque operation; a path-per-operation variant can be generated with `--aliases`.\n\n**Errors do not use HTTP status codes.** Every response is `200`; branch on the\n`status` field in the body.\n\n**Access requires an IP allowlist** in addition to the bearer token, so an agent on\nephemeral cloud infrastructure cannot authenticate without pre-registration.\n\nFull documentation: https://textme-docs.matat.io", "contact": { "name": "TextMe support", "url": "https://textme-docs.matat.io", "email": "hi@textme.co.il" } }, "servers": [ { "url": "https://my.textme.co.il", "description": "Production" } ], "security": [ { "bearerAuth": [] } ], "paths": { "/api": { "post": { "operationId": "call", "summary": "Call any TextMe operation", "description": "One endpoint for all 30 operations. The root element of the body selects which one: `sms` sends a message, `dlr` pulls delivery reports, and so on. Full list at https://textme-docs.matat.io/endpoints/overview.", "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TokenCreateRequest" }, { "$ref": "#/components/schemas/TokenCurrentRequest" }, { "$ref": "#/components/schemas/SendMinimalRequest" }, { "$ref": "#/components/schemas/SendSmsRequest" }, { "$ref": "#/components/schemas/SendBulkRequest" }, { "$ref": "#/components/schemas/SendTtsRequest" }, { "$ref": "#/components/schemas/OtpSendRequest" }, { "$ref": "#/components/schemas/OtpValidateRequest" }, { "$ref": "#/components/schemas/BalanceRequest" }, { "$ref": "#/components/schemas/DlrRequest" }, { "$ref": "#/components/schemas/DlrByDateRequest" }, { "$ref": "#/components/schemas/IncomingRequest" }, { "$ref": "#/components/schemas/BlacklistGetRequest" }, { "$ref": "#/components/schemas/BlacklistAddRequest" }, { "$ref": "#/components/schemas/BlacklistRemoveRequest" }, { "$ref": "#/components/schemas/ClCreateRequest" }, { "$ref": "#/components/schemas/ClRemoveRequest" }, { "$ref": "#/components/schemas/ClAddNumbersRequest" }, { "$ref": "#/components/schemas/ClRemoveNumbersRequest" }, { "$ref": "#/components/schemas/ClGetAllRequest" }, { "$ref": "#/components/schemas/ClGetByIdRequest" }, { "$ref": "#/components/schemas/CampaignCancelByIdRequest" }, { "$ref": "#/components/schemas/CampaignCancelByNameRequest" }, { "$ref": "#/components/schemas/BirthdayListRequest" }, { "$ref": "#/components/schemas/BirthdayEditRequest" }, { "$ref": "#/components/schemas/VerifyPhoneRequest" }, { "$ref": "#/components/schemas/VerifiedPhonesRequest" }, { "$ref": "#/components/schemas/SubscriberAddRequest" }, { "$ref": "#/components/schemas/SubscriberWalletRequest" }, { "$ref": "#/components/schemas/SubscriberBalancesRequest" } ], "description": "Exactly one root element, which selects the operation. There is no discriminator property: the operation is identified by *which* key is present, which OpenAPI cannot express as a discriminator." } }, "application/xml": { "schema": { "type": "string", "description": "The same document as XML. Each request schema shows the equivalent." } } } }, "responses": { "200": { "description": "Always 200, including for authentication and validation failures. Branch on the `status` field in the body, never on the HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TokenCreateResponse" }, { "$ref": "#/components/schemas/TokenCurrentResponse" }, { "$ref": "#/components/schemas/SendMinimalResponse" }, { "$ref": "#/components/schemas/SendSmsResponse" }, { "$ref": "#/components/schemas/SendBulkResponse" }, { "$ref": "#/components/schemas/SendTtsResponse" }, { "$ref": "#/components/schemas/OtpSendResponse" }, { "$ref": "#/components/schemas/OtpValidateResponse" }, { "$ref": "#/components/schemas/BalanceResponse" }, { "$ref": "#/components/schemas/DlrResponse" }, { "$ref": "#/components/schemas/DlrByDateResponse" }, { "$ref": "#/components/schemas/IncomingResponse" }, { "$ref": "#/components/schemas/BlacklistGetResponse" }, { "$ref": "#/components/schemas/BlacklistAddResponse" }, { "$ref": "#/components/schemas/BlacklistRemoveResponse" }, { "$ref": "#/components/schemas/ClCreateResponse" }, { "$ref": "#/components/schemas/ClRemoveResponse" }, { "$ref": "#/components/schemas/ClAddNumbersResponse" }, { "$ref": "#/components/schemas/ClRemoveNumbersResponse" }, { "$ref": "#/components/schemas/ClGetAllResponse" }, { "$ref": "#/components/schemas/ClGetByIdResponse" }, { "$ref": "#/components/schemas/CampaignCancelByIdResponse" }, { "$ref": "#/components/schemas/CampaignCancelByNameResponse" }, { "$ref": "#/components/schemas/BirthdayListResponse" }, { "$ref": "#/components/schemas/BirthdayEditResponse" }, { "$ref": "#/components/schemas/VerifyPhoneResponse" }, { "$ref": "#/components/schemas/VerifiedPhonesResponse" }, { "$ref": "#/components/schemas/SubscriberAddResponse" }, { "$ref": "#/components/schemas/SubscriberWalletResponse" }, { "$ref": "#/components/schemas/SubscriberBalancesResponse" } ] } } } } } } }, "/api/test": { "post": { "operationId": "callTest", "summary": "Validate a payload without performing it", "description": "Parses and permission-checks the body and answers in the same shape, but performs no action: nothing is sent, no credit is spent, no list is modified.", "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TokenCreateRequest" }, { "$ref": "#/components/schemas/TokenCurrentRequest" }, { "$ref": "#/components/schemas/SendMinimalRequest" }, { "$ref": "#/components/schemas/SendSmsRequest" }, { "$ref": "#/components/schemas/SendBulkRequest" }, { "$ref": "#/components/schemas/SendTtsRequest" }, { "$ref": "#/components/schemas/OtpSendRequest" }, { "$ref": "#/components/schemas/OtpValidateRequest" }, { "$ref": "#/components/schemas/BalanceRequest" }, { "$ref": "#/components/schemas/DlrRequest" }, { "$ref": "#/components/schemas/DlrByDateRequest" }, { "$ref": "#/components/schemas/IncomingRequest" }, { "$ref": "#/components/schemas/BlacklistGetRequest" }, { "$ref": "#/components/schemas/BlacklistAddRequest" }, { "$ref": "#/components/schemas/BlacklistRemoveRequest" }, { "$ref": "#/components/schemas/ClCreateRequest" }, { "$ref": "#/components/schemas/ClRemoveRequest" }, { "$ref": "#/components/schemas/ClAddNumbersRequest" }, { "$ref": "#/components/schemas/ClRemoveNumbersRequest" }, { "$ref": "#/components/schemas/ClGetAllRequest" }, { "$ref": "#/components/schemas/ClGetByIdRequest" }, { "$ref": "#/components/schemas/CampaignCancelByIdRequest" }, { "$ref": "#/components/schemas/CampaignCancelByNameRequest" }, { "$ref": "#/components/schemas/BirthdayListRequest" }, { "$ref": "#/components/schemas/BirthdayEditRequest" }, { "$ref": "#/components/schemas/VerifyPhoneRequest" }, { "$ref": "#/components/schemas/VerifiedPhonesRequest" }, { "$ref": "#/components/schemas/SubscriberAddRequest" }, { "$ref": "#/components/schemas/SubscriberWalletRequest" }, { "$ref": "#/components/schemas/SubscriberBalancesRequest" } ], "description": "Exactly one root element, which selects the operation. There is no discriminator property: the operation is identified by *which* key is present, which OpenAPI cannot express as a discriminator." } }, "application/xml": { "schema": { "type": "string", "description": "The same document as XML. Each request schema shows the equivalent." } } } }, "responses": { "200": { "description": "Always 200, including for authentication and validation failures. Branch on the `status` field in the body, never on the HTTP status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TokenCreateResponse" }, { "$ref": "#/components/schemas/TokenCurrentResponse" }, { "$ref": "#/components/schemas/SendMinimalResponse" }, { "$ref": "#/components/schemas/SendSmsResponse" }, { "$ref": "#/components/schemas/SendBulkResponse" }, { "$ref": "#/components/schemas/SendTtsResponse" }, { "$ref": "#/components/schemas/OtpSendResponse" }, { "$ref": "#/components/schemas/OtpValidateResponse" }, { "$ref": "#/components/schemas/BalanceResponse" }, { "$ref": "#/components/schemas/DlrResponse" }, { "$ref": "#/components/schemas/DlrByDateResponse" }, { "$ref": "#/components/schemas/IncomingResponse" }, { "$ref": "#/components/schemas/BlacklistGetResponse" }, { "$ref": "#/components/schemas/BlacklistAddResponse" }, { "$ref": "#/components/schemas/BlacklistRemoveResponse" }, { "$ref": "#/components/schemas/ClCreateResponse" }, { "$ref": "#/components/schemas/ClRemoveResponse" }, { "$ref": "#/components/schemas/ClAddNumbersResponse" }, { "$ref": "#/components/schemas/ClRemoveNumbersResponse" }, { "$ref": "#/components/schemas/ClGetAllResponse" }, { "$ref": "#/components/schemas/ClGetByIdResponse" }, { "$ref": "#/components/schemas/CampaignCancelByIdResponse" }, { "$ref": "#/components/schemas/CampaignCancelByNameResponse" }, { "$ref": "#/components/schemas/BirthdayListResponse" }, { "$ref": "#/components/schemas/BirthdayEditResponse" }, { "$ref": "#/components/schemas/VerifyPhoneResponse" }, { "$ref": "#/components/schemas/VerifiedPhonesResponse" }, { "$ref": "#/components/schemas/SubscriberAddResponse" }, { "$ref": "#/components/schemas/SubscriberWalletResponse" }, { "$ref": "#/components/schemas/SubscriberBalancesResponse" } ] } } } } } } } }, "webhooks": { "deliveryReport": { "post": { "operationId": "onDeliveryReport", "summary": "Delivery report", "description": "Sent as each delivery status arrives. See https://textme-docs.matat.io/endpoints/push.", "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "external_id": { "type": "string", "description": "The id you set on the `phone` element when sending." }, "status": { "type": "string", "description": "Delivery status. See https://textme-docs.matat.io/reference/dlr-statuses." }, "he_message": { "type": "string", "description": "Status text in Hebrew." }, "en_message": { "type": "string", "description": "Status text in English." }, "date": { "type": "string", "description": "When recorded, `dd/mm/yy hh:mm:ss`." }, "phone": { "type": "string", "description": "Destination in international form." }, "operaor": { "type": "string", "description": "Carrier. Spelled without the `t` in the push payload; `operator` when polled." }, "shipment_id": { "type": "string", "description": "The campaign the message belonged to." } } } } } }, "responses": { "200": { "description": "Return 200 promptly. Anything else is treated as a failure, and after several the feed is disabled silently." } } } }, "incomingMessage": { "post": { "operationId": "onIncomingMessage", "summary": "Incoming message", "description": "Sent when someone messages one of your numbers.", "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "The text received." }, "date": { "type": "string", "description": "When it arrived, `dd/mm/yy hh:mm:ss`." }, "phone": { "type": "string", "description": "The sender. Called `source` in the polled report." }, "dest": { "type": "string", "description": "Your number. Called `destination` in the polled report." } } } } } }, "responses": { "200": { "description": "Return 200 promptly. Anything else is treated as a failure, and after several the feed is disabled silently." } } } }, "blocklistAddition": { "post": { "operationId": "onBlocklistAddition", "summary": "Blocklist addition", "description": "Sent when a subscriber is blocked, usually an opt-out.", "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Note about the block, in Hebrew." }, "date": { "type": "string", "description": "When it happened, `dd/mm/yy hh:mm:ss`." }, "dest": { "type": "string", "description": "The number that was blocked." } } } } } }, "responses": { "200": { "description": "Return 200 promptly. Anything else is treated as a failure, and after several the feed is disabled silently." } } } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "description": "An API token created in the console, or through `getApiToken` with an existing token. Up to five are valid at once. See https://textme-docs.matat.io/guide/authentication." } }, "schemas": { "StatusEnvelope": { "type": "object", "description": "Every response opens with these two fields. `status` `0` means the call was accepted; any other value is a failure, except the blocklist operations, where `946` and `944` are success. See https://textme-docs.matat.io/reference/status-codes.", "properties": { "status": { "type": [ "integer", "string" ], "description": "`0` on success. Anything else is an error code.", "examples": [ 0 ] }, "message": { "type": "string", "description": "Human-readable note, or the error explanation." }, "errors": { "type": "array", "items": { "type": "string" }, "description": "Present on batch operations that succeeded overall while dropping individual rows. Always read it when present." } }, "required": [ "status" ] }, "TokenCreateRequest": { "type": "object", "properties": { "getApiToken": { "type": "object", "properties": { "user": { "type": "object", "properties": { "username": { "type": "string", "examples": [ "admin_username" ], "description": "The account making the request, for a reseller, the administrator account." } }, "required": [ "username" ], "description": "Contains the acting account." }, "username": { "type": "string", "examples": [ "username_for_token" ], "description": "The account making the request, for a reseller, the administrator account." }, "action": { "type": "string", "examples": [ "new" ], "description": "`new` to mint a token." } }, "required": [ "user", "username", "action" ], "description": "Root element." } }, "required": [ "getApiToken" ], "title": "Generate an API token", "description": "Generate an API token. Root element `getApiToken`.\n\nEquivalent XML body (send with `Content-Type: application/xml`):\n\n```xml\n\n\n \n admin_username\n \n username_for_token\n new\n\n```", "examples": [ { "getApiToken": { "user": { "username": "admin_username" }, "username": "username_for_token", "action": "new" } } ] }, "TokenCreateResponse": { "allOf": [ { "$ref": "#/components/schemas/StatusEnvelope" }, { "type": "object", "properties": { "status": { "type": "integer", "examples": [ 0 ] }, "message": { "type": "string", "examples": [ "0zrjDjZ26Dll5dqdTBmuwwtQg8" ] }, "expiration_date": { "type": "string", "examples": [ "07/06/2025 09:17:34" ] } } } ], "title": "Generate an API token response", "examples": [ { "status": 0, "message": "0zrjDjZ26Dll5dqdTBmuwwtQg8", "expiration_date": "07/06/2025 09:17:34" } ] }, "TokenCurrentRequest": { "type": "object", "properties": { "getApiToken": { "type": "object", "properties": { "user": { "type": "object", "properties": { "username": { "type": "string", "examples": [ "admin_username" ], "description": "The account making the request, for a reseller, the administrator account." } }, "required": [ "username" ], "description": "Contains the acting account." }, "username": { "type": "string", "examples": [ "username_for_token" ], "description": "The account making the request, for a reseller, the administrator account." }, "action": { "type": "string", "examples": [ "current" ], "description": "`new` to mint a token." } }, "required": [ "user", "username", "action" ], "description": "Root element." } }, "required": [ "getApiToken" ], "title": "Retrieve the most recent token", "description": "Retrieve the most recent token. Root element `getApiToken`.\n\nEquivalent XML body (send with `Content-Type: application/xml`):\n\n```xml\n\n\n \n admin_username\n \n username_for_token\n current\n\n```", "examples": [ { "getApiToken": { "user": { "username": "admin_username" }, "username": "username_for_token", "action": "current" } } ] }, "TokenCurrentResponse": { "allOf": [ { "$ref": "#/components/schemas/StatusEnvelope" }, { "type": "object", "properties": { "status": { "type": "integer", "examples": [ 0 ] }, "message": { "type": "string", "examples": [ "0zrjDjZ26Dll5dqdTBmuwwtQg8" ] }, "expiration_date": { "type": "string", "examples": [ "07/06/2025 09:17:34" ] } } } ], "title": "Retrieve the most recent token response", "examples": [ { "status": 0, "message": "0zrjDjZ26Dll5dqdTBmuwwtQg8", "expiration_date": "07/06/2025 09:17:34" } ] }, "SendMinimalRequest": { "type": "object", "properties": { "sms": { "type": "object", "properties": { "user": { "type": "object", "properties": { "username": { "type": "string", "examples": [ "Leeroy" ], "description": "The username of the account by which you are recognized in the system." } }, "required": [ "username" ], "description": "Contains the user element." }, "source": { "type": "string", "examples": [ "DemoAPI" ], "description": "The number or name the message appears to come from. Maximum 11 characters, digits and English letters only, no `+`. Must be a verified sender." }, "destinations": { "type": "object", "properties": { "phone": { "type": "string", "examples": [ "5xxxxxxxx" ], "description": "A destination number, formatted `5xxxxxxx` or `05xxxxxxx`." } }, "required": [ "phone" ], "description": "Contains every destination. May hold multiple `phone` and multiple `cl_id` elements." }, "message": { "type": "string", "examples": [ "This is a sample message" ], "description": "The message body. Maximum 1005 characters." } }, "required": [ "user", "source", "destinations", "message" ], "description": "Root element." } }, "required": [ "sms" ], "title": "Send one message", "description": "Send one message. Root element `sms`.\n\nEquivalent XML body (send with `Content-Type: application/xml`):\n\n```xml\n\n\n \n Leeroy\n \n DemoAPI\n \n 5xxxxxxxx\n \n This is a sample message\n\n```", "examples": [ { "sms": { "user": { "username": "Leeroy" }, "source": "DemoAPI", "destinations": { "phone": "5xxxxxxxx" }, "message": "This is a sample message" } } ] }, "SendMinimalResponse": { "allOf": [ { "$ref": "#/components/schemas/StatusEnvelope" }, { "type": "object", "properties": { "status": { "type": "integer", "examples": [ 0 ] }, "message": { "type": "string", "examples": [ "SMS will be sent" ] }, "shipment_id": { "type": "string", "examples": [ "XXXXXXX" ] } } } ], "title": "Send one message response", "examples": [ { "status": 0, "message": "SMS will be sent", "shipment_id": "XXXXXXX" } ] }, "SendSmsRequest": { "type": "object", "properties": { "sms": { "type": "object", "properties": { "user": { "type": "object", "properties": { "username": { "type": "string", "examples": [ "Leeroy" ], "description": "The username of the account by which you are recognized in the system." } }, "required": [ "username" ], "description": "Contains the user element." }, "source": { "type": "string", "examples": [ "DemoAPI" ], "description": "The number or name the message appears to come from. Maximum 11 characters, digits and English letters only, no `+`. Must be a verified sender." }, "destinations": { "type": "object", "properties": { "cl_id": { "anyOf": [ { "type": "string", "examples": [ "21518", "21500" ] }, { "type": "array", "items": { "type": "string", "examples": [ "21518", "21500" ] } } ], "description": "Send to a whole contact list by its id. Repeatable." }, "phone": { "anyOf": [ { "type": "object", "properties": { "$": { "type": "object", "properties": { "id": { "type": "string", "examples": [ "external id1" ], "description": "Attribute of `phone`. Your own external id for this destination, so you can look up its delivery report later. Omit it, or leave it blank, if you do not need reports." } } }, "_": { "type": "string", "examples": [ "5xxxxxxxx" ] } } }, { "type": "array", "items": { "type": "object", "properties": { "$": { "type": "object", "properties": { "id": { "type": "string", "examples": [ "external id1" ], "description": "Attribute of `phone`. Your own external id for this destination, so you can look up its delivery report later. Omit it, or leave it blank, if you do not need reports." } } }, "_": { "type": "string", "examples": [ "5xxxxxxxx" ] } } } } ], "description": "A destination number, formatted `5xxxxxxx` or `05xxxxxxx`." } }, "required": [ "phone" ], "description": "Contains every destination. May hold multiple `phone` and multiple `cl_id` elements." }, "tag": { "type": "string", "examples": [ "#" ], "description": "Prefix glued to the front of the message. Intended for Google's automatic SMS verification. `#` with `Hello world` is delivered as `<#>Hello world`." }, "message": { "type": "string", "examples": [ "This is a sample message. [link-a1]" ], "description": "The message body. Maximum 1005 characters." }, "add_dynamic": { "type": "string", "examples": [ "0" ], "description": "Set to `1` to substitute the contact list's dynamic fields into the message. Any other value means no. Requires exactly one `cl_id` and no individual `phone` elements." }, "timing": { "type": "string", "examples": [ "30/03/14 10:10" ], "description": "Schedule the send, formatted `dd/mm/yy hh:mm`. Sent immediately when absent." }, "add_unsubscribe": { "type": "string", "examples": [ "0" ], "description": "Append an opt-out mechanism: `3` for a removal link, `2` for reply-to-remove. Any other value means no." }, "temp_bl": { "type": "string", "examples": [ "2" ], "description": "Skip destinations that already received a message in the last *n* days, where *n* is 1 to 14." }, "includes_international": { "type": "string", "examples": [ "1" ], "description": "`1` to allow non-Israeli destinations, `0` otherwise." }, "campaign_name": { "type": "string", "examples": [ "Sample Campaign" ], "description": "Name shown on the system reports, and the handle for cancelling by name. Maximum 50 characters." }, "links": { "type": "object", "properties": { "link": { "anyOf": [ { "type": "object", "properties": { "$": { "type": "object", "properties": { "id": { "type": "string", "examples": [ "a1" ], "description": "Attribute of `phone`. Your own external id for this destination, so you can look up its delivery report later. Omit it, or leave it blank, if you do not need reports." } } }, "_": { "type": "string", "examples": [ "https://www.example.com/path/to/resource" ] } } }, { "type": "array", "items": { "type": "object", "properties": { "$": { "type": "object", "properties": { "id": { "type": "string", "examples": [ "a1" ], "description": "Attribute of `phone`. Your own external id for this destination, so you can look up its delivery report later. Omit it, or leave it blank, if you do not need reports." } } }, "_": { "type": "string", "examples": [ "https://www.example.com/path/to/resource" ] } } } } ], "description": "A URL to shorten. Must carry an `id` attribute; write `[link-id]` in the message body where the short link should appear." } }, "description": "Contains the links to shorten. May hold multiple `link` elements." } }, "required": [ "user", "source", "destinations", "message" ], "description": "Root element." } }, "required": [ "sms" ], "title": "Send an SMS with every option", "description": "Send an SMS with every option. Root element `sms`.\n\nEquivalent XML body (send with `Content-Type: application/xml`):\n\n```xml\n\n\n \n Leeroy\n \n DemoAPI\n \n 21518\n 21500\n 5xxxxxxxx\n 5xxxxxxxx\n 5xxxxxxxx\n 5xxxxxxxx\n \n #\n This is a sample message. [link-a1]\n 0\n 30/03/14 10:10\n 0\n 2\n 1\n Sample Campaign\n \n https://www.example.com/path/to/resource\n \n\n```", "examples": [ { "sms": { "user": { "username": "Leeroy" }, "source": "DemoAPI", "destinations": { "cl_id": [ "21518", "21500" ], "phone": [ { "$": { "id": "external id1" }, "_": "5xxxxxxxx" }, { "$": { "id": "external id2" }, "_": "5xxxxxxxx" }, { "_": "5xxxxxxxx" }, { "$": { "id": "" }, "_": "5xxxxxxxx" } ] }, "tag": "#", "message": "This is a sample message. [link-a1]", "add_dynamic": "0", "timing": "30/03/14 10:10", "add_unsubscribe": "0", "temp_bl": "2", "includes_international": "1", "campaign_name": "Sample Campaign", "links": { "link": [ { "$": { "id": "a1" }, "_": "https://www.example.com/path/to/resource" } ] } } } ] }, "SendSmsResponse": { "allOf": [ { "$ref": "#/components/schemas/StatusEnvelope" }, { "type": "object", "properties": { "status": { "type": "integer", "examples": [ 0 ] }, "message": { "type": "string", "examples": [ "SMS will be sent" ] }, "shipment_id": { "type": "string", "examples": [ "XXXXXXX" ] } } } ], "title": "Send an SMS with every option response", "examples": [ { "status": 0, "message": "SMS will be sent", "shipment_id": "XXXXXXX" } ] }, "SendBulkRequest": { "type": "object", "properties": { "bulk": { "type": "object", "properties": { "user": { "type": "object", "properties": { "username": { "type": "string", "examples": [ "Leeroy" ], "description": "The username of the account by which you are recognized in the system." } }, "required": [ "username" ], "description": "Contains the user element." }, "messages": { "type": "object", "properties": { "sms": { "anyOf": [ { "type": "object", "properties": { "source": { "type": "string", "examples": [ "DemoAPI" ], "description": "Sender for this message. Maximum 11 characters, digits and English letters only, no `+`. Must be a verified sender." }, "destinations": { "type": "object", "properties": { "phone": { "anyOf": [ { "type": "object", "properties": { "$": { "type": "object", "properties": { "id": { "type": "string", "examples": [ "external id1" ], "description": "Attribute of `phone`. Your own external id for this destination, for later delivery reports." } } }, "_": { "type": "string", "examples": [ "5xxxxxxxx" ] } } }, { "type": "array", "items": { "type": "object", "properties": { "$": { "type": "object", "properties": { "id": { "type": "string", "examples": [ "external id1" ], "description": "Attribute of `phone`. Your own external id for this destination, for later delivery reports." } } }, "_": { "type": "string", "examples": [ "5xxxxxxxx" ] } } } }, { "type": "object", "properties": { "$": { "type": "object", "properties": { "id": { "type": "string", "examples": [ "" ], "description": "Attribute of `phone`. Your own external id for this destination, for later delivery reports." } } }, "_": { "type": "string", "examples": [ "5xxxxxxxx" ] } }, "description": "A destination number, formatted `5xxxxxxx` or `05xxxxxxx`." } ] } }, "required": [ "phone" ] }, "message": { "type": "string", "examples": [ "This is a sample message", "This is a different message sent. [link-a1]" ], "description": "The body for this message. Maximum 1005 characters." }, "links": { "type": "object", "properties": { "link": { "anyOf": [ { "type": "object", "properties": { "$": { "type": "object", "properties": { "id": { "type": "string", "examples": [ "a1" ], "description": "Attribute of `phone`. Your own external id for this destination, for later delivery reports." } } }, "_": { "type": "string", "examples": [ "https://www.example.com/path/to/resource" ] } } }, { "type": "array", "items": { "type": "object", "properties": { "$": { "type": "object", "properties": { "id": { "type": "string", "examples": [ "a1" ], "description": "Attribute of `phone`. Your own external id for this destination, for later delivery reports." } } }, "_": { "type": "string", "examples": [ "https://www.example.com/path/to/resource" ] } } } } ] } }, "description": "Links to shorten inside this message. `[link-id]` in the body marks where each appears." } }, "required": [ "source", "destinations", "message" ] }, { "type": "array", "items": { "type": "object", "properties": { "source": { "type": "string", "examples": [ "DemoAPI" ], "description": "Sender for this message. Maximum 11 characters, digits and English letters only, no `+`. Must be a verified sender." }, "destinations": { "type": "object", "properties": { "phone": { "anyOf": [ { "type": "object", "properties": { "$": { "type": "object", "properties": { "id": { "type": "string", "examples": [ "external id1" ], "description": "Attribute of `phone`. Your own external id for this destination, for later delivery reports." } } }, "_": { "type": "string", "examples": [ "5xxxxxxxx" ] } } }, { "type": "array", "items": { "type": "object", "properties": { "$": { "type": "object", "properties": { "id": { "type": "string", "examples": [ "external id1" ], "description": "Attribute of `phone`. Your own external id for this destination, for later delivery reports." } } }, "_": { "type": "string", "examples": [ "5xxxxxxxx" ] } } } }, { "type": "object", "properties": { "$": { "type": "object", "properties": { "id": { "type": "string", "examples": [ "" ], "description": "Attribute of `phone`. Your own external id for this destination, for later delivery reports." } } }, "_": { "type": "string", "examples": [ "5xxxxxxxx" ] } }, "description": "A destination number, formatted `5xxxxxxx` or `05xxxxxxx`." } ] } }, "required": [ "phone" ] }, "message": { "type": "string", "examples": [ "This is a sample message", "This is a different message sent. [link-a1]" ], "description": "The body for this message. Maximum 1005 characters." }, "links": { "type": "object", "properties": { "link": { "anyOf": [ { "type": "object", "properties": { "$": { "type": "object", "properties": { "id": { "type": "string", "examples": [ "a1" ], "description": "Attribute of `phone`. Your own external id for this destination, for later delivery reports." } } }, "_": { "type": "string", "examples": [ "https://www.example.com/path/to/resource" ] } } }, { "type": "array", "items": { "type": "object", "properties": { "$": { "type": "object", "properties": { "id": { "type": "string", "examples": [ "a1" ], "description": "Attribute of `phone`. Your own external id for this destination, for later delivery reports." } } }, "_": { "type": "string", "examples": [ "https://www.example.com/path/to/resource" ] } } } } ] } }, "description": "Links to shorten inside this message. `[link-id]` in the body marks where each appears." } }, "required": [ "source", "destinations", "message" ] } } ] } }, "description": "Contains all the sms objects. The number of objects must not exceed 2500." }, "timing": { "type": "string", "examples": [ "10/10/17 10:10" ], "description": "Schedule the whole batch, formatted `dd/mm/yy hh:mm`. Sent immediately when absent." }, "temp_bl": { "type": "string", "examples": [ "2" ], "description": "Skip destinations messaged in the last *n* days, 1 to 14." }, "includes_international": { "type": "string", "examples": [ "1" ], "description": "`1` to allow non-Israeli destinations, `0` otherwise." }, "campaign_name": { "type": "string", "examples": [ "Sample Bulk Campaign" ], "description": "Name for the batch on system reports, and the handle for cancelling by name. Maximum 50 characters." } }, "required": [ "user", "messages" ], "description": "Root element." } }, "required": [ "bulk" ], "title": "Send many different messages in one call", "description": "Send many different messages in one call. Root element `bulk`.\n\nEquivalent XML body (send with `Content-Type: application/xml`):\n\n```xml\n\n\n \n Leeroy\n \n \n \n DemoAPI\n \n 5xxxxxxxx\n 5xxxxxxxx\n 5xxxxxxxx\n 5xxxxxxxx\n \n This is a sample message\n \n \n DemoAPI\n \n 5xxxxxxxx\n \n This is a different message sent. [link-a1]\n \n https://www.example.com/path/to/resource\n \n \n \n 10/10/17 10:10\n 2\n 1\n Sample Bulk Campaign\n\n```", "examples": [ { "bulk": { "user": { "username": "Leeroy" }, "messages": { "sms": [ { "source": "DemoAPI", "destinations": { "phone": [ { "$": { "id": "external id1" }, "_": "5xxxxxxxx" }, { "$": { "id": "external id2" }, "_": "5xxxxxxxx" }, { "_": "5xxxxxxxx" }, { "$": { "id": "" }, "_": "5xxxxxxxx" } ] }, "message": "This is a sample message" }, { "source": "DemoAPI", "destinations": { "phone": { "$": { "id": "" }, "_": "5xxxxxxxx" } }, "message": "This is a different message sent. [link-a1]", "links": { "link": [ { "$": { "id": "a1" }, "_": "https://www.example.com/path/to/resource" } ] } } ] }, "timing": "10/10/17 10:10", "temp_bl": "2", "includes_international": "1", "campaign_name": "Sample Bulk Campaign" } } ] }, "SendBulkResponse": { "allOf": [ { "$ref": "#/components/schemas/StatusEnvelope" }, { "type": "object", "properties": { "status": { "type": "integer", "examples": [ 0 ] }, "message": { "type": "string", "examples": [ "SMS bulk will be sent" ] }, "shipment_id": { "type": "string", "examples": [ "XXXXXXX" ] } } } ], "title": "Send many different messages in one call response", "examples": [ { "status": 0, "message": "SMS bulk will be sent", "shipment_id": "XXXXXXX" } ] }, "SendTtsRequest": { "type": "object", "properties": { "sms": { "type": "object", "properties": { "user": { "type": "object", "properties": { "username": { "type": "string", "examples": [ "Leeroy" ], "description": "The username of the account by which you are recognized in the system." } }, "required": [ "username" ], "description": "Contains the user element." }, "source": { "type": "string", "examples": [ "DemoAPI" ], "description": "The number or name the message appears to come from. Maximum 11 characters, digits and English letters only, no `+`. Must be a verified sender." }, "destinations": { "type": "object", "properties": { "cl_id": { "anyOf": [ { "type": "string", "examples": [ "21518", "21500" ] }, { "type": "array", "items": { "type": "string", "examples": [ "21518", "21500" ] } } ], "description": "Send to a whole contact list by its id. Repeatable." }, "phone": { "anyOf": [ { "type": "object", "properties": { "$": { "type": "object", "properties": { "id": { "type": "string", "examples": [ "external id1" ], "description": "Attribute of `phone`. Your own external id for this destination, so you can look up its delivery report later. Omit it, or leave it blank, if you do not need reports." } } }, "_": { "type": "string", "examples": [ "5xxxxxxxx" ] } } }, { "type": "array", "items": { "type": "object", "properties": { "$": { "type": "object", "properties": { "id": { "type": "string", "examples": [ "external id1" ], "description": "Attribute of `phone`. Your own external id for this destination, so you can look up its delivery report later. Omit it, or leave it blank, if you do not need reports." } } }, "_": { "type": "string", "examples": [ "5xxxxxxxx" ] } } } } ], "description": "A destination number, formatted `5xxxxxxx` or `05xxxxxxx`." } }, "required": [ "phone" ], "description": "Contains every destination. May hold multiple `phone` and multiple `cl_id` elements." }, "message": { "type": "string", "examples": [ "This is a sample tts message" ], "description": "The message body. Maximum 1005 characters." }, "tts": { "type": "object", "properties": { "type": { "type": "integer", "examples": [ 4 ], "description": "Which channel each destination gets. See the table below." }, "rate": { "type": "integer", "examples": [ -1 ], "description": "Speech speed, from `-10` to `10`. `0` is normal." }, "repeat": { "type": "integer", "examples": [ 1 ], "description": "How many times the message plays during the call. Default is twice." }, "voice": { "type": "string", "examples": [ "ymMale" ], "description": "`ymMale` or `ymFemale`. Default is `ymMale`." } }, "required": [ "type" ], "description": "Contains all settings for sending calls. Its presence is what turns the send into a voice send." } }, "required": [ "user", "source", "destinations", "message", "tts" ], "description": "Root element." } }, "required": [ "sms" ], "title": "Send a voice message", "description": "Send a voice message. Root element `sms`.\n\nEquivalent XML body (send with `Content-Type: application/xml`):\n\n```xml\n\n\n \n Leeroy\n \n DemoAPI\n \n 21518\n 21500\n 5xxxxxxxx\n 5xxxxxxxx\n 5xxxxxxxx\n 5xxxxxxxx\n \n This is a sample tts message\n \n 4\n -1\n 1\n ymMale\n \n\n```", "examples": [ { "sms": { "user": { "username": "Leeroy" }, "source": "DemoAPI", "destinations": { "cl_id": [ "21518", "21500" ], "phone": [ { "$": { "id": "external id1" }, "_": "5xxxxxxxx" }, { "$": { "id": "external id2" }, "_": "5xxxxxxxx" }, { "_": "5xxxxxxxx" }, { "$": { "id": "" }, "_": "5xxxxxxxx" } ] }, "message": "This is a sample tts message", "tts": { "type": 4, "rate": -1, "repeat": 1, "voice": "ymMale" } } } ] }, "SendTtsResponse": { "allOf": [ { "$ref": "#/components/schemas/StatusEnvelope" }, { "type": "object", "properties": { "status": { "type": "integer", "examples": [ 0 ] }, "message": { "type": "string", "examples": [ "SMS will be sent" ] }, "shipment_id": { "type": "string", "examples": [ "XXXXXXX" ] } } } ], "title": "Send a voice message response", "examples": [ { "status": 0, "message": "SMS will be sent", "shipment_id": "XXXXXXX" } ] }, "OtpSendRequest": { "type": "object", "properties": { "send_otp": { "type": "object", "properties": { "user": { "type": "object", "properties": { "username": { "type": "string", "examples": [ "Leeroy" ], "description": "The username of the account by which you are recognized in the system." } }, "required": [ "username" ], "description": "Contains the user element." }, "phone": { "type": "string", "examples": [ "5xxxxxxxx" ], "description": "The destination, formatted `5xxxxxxx` or `05xxxxxxx`." }, "source": { "type": "string", "examples": [ "DemoAPI" ], "description": "The sender the code appears to come from. Must be a verified sender." }, "app_id": { "type": "string", "examples": [ "1" ], "description": "Separates authentication between applications when one account serves several. Defaults to `1`." }, "max_tries": { "type": "string", "examples": [ "3" ], "description": "How many validation attempts the code allows, from `3` to `5`. Defaults to `3`." }, "valid_time": { "type": "string", "examples": [ "5" ], "description": "How many minutes the code stays valid, from `1` to `15`. Defaults to `5`." }, "text": { "type": "string", "examples": [ "Your DemoAPI code is [code]" ], "description": "Your own message text. Must contain `[code]`, which is replaced with the generated code. Defaults to `the code is [code]`." } }, "required": [ "user", "phone", "source" ], "description": "Root element." } }, "required": [ "send_otp" ], "title": "Send a one-time code", "description": "Send a one-time code. Root element `send_otp`.\n\nEquivalent XML body (send with `Content-Type: application/xml`):\n\n```xml\n\n\n \n Leeroy\n \n 5xxxxxxxx\n DemoAPI\n 1\n 3\n 5\n Your DemoAPI code is [code]\n\n```", "examples": [ { "send_otp": { "user": { "username": "Leeroy" }, "phone": "5xxxxxxxx", "source": "DemoAPI", "app_id": "1", "max_tries": "3", "valid_time": "5", "text": "Your DemoAPI code is [code]" } } ] }, "OtpSendResponse": { "allOf": [ { "$ref": "#/components/schemas/StatusEnvelope" }, { "type": "object", "properties": { "status": { "type": "integer", "examples": [ 0 ] }, "code": { "type": "string", "examples": [ "448431" ] }, "message": { "type": "string", "examples": [ "The code is : 448431 and is valid for 5 minutes" ] } } } ], "title": "Send a one-time code response", "examples": [ { "status": 0, "code": "448431", "message": "The code is : 448431 and is valid for 5 minutes" } ] }, "OtpValidateRequest": { "type": "object", "properties": { "validate_otp": { "type": "object", "properties": { "user": { "type": "object", "properties": { "username": { "type": "string", "examples": [ "Leeroy" ], "description": "The username of the account by which you are recognized in the system." } }, "required": [ "username" ], "description": "Contains the user element." }, "phone": { "type": "string", "examples": [ "5xxxxxxxx" ], "description": "The number the code was sent to, formatted `5xxxxxxx` or `05xxxxxxx`." }, "app_id": { "type": "string", "examples": [ "1" ], "description": "Must match the `app_id` used when sending. Defaults to `1`." }, "code": { "type": "string", "examples": [ "407526" ], "description": "The six-digit code to check." }, "service_type": { "type": "string", "examples": [ "sms" ], "description": "Which channel issued the code, `sms` or `whatsapp`. Defaults to `sms`." } }, "required": [ "user", "phone", "code" ], "description": "Root element." } }, "required": [ "validate_otp" ], "title": "Check a one-time code", "description": "Check a one-time code. Root element `validate_otp`.\n\nEquivalent XML body (send with `Content-Type: application/xml`):\n\n```xml\n\n\n \n Leeroy\n \n 5xxxxxxxx\n 1\n 407526\n sms\n\n```", "examples": [ { "validate_otp": { "user": { "username": "Leeroy" }, "phone": "5xxxxxxxx", "app_id": "1", "code": "407526", "service_type": "sms" } } ] }, "OtpValidateResponse": { "allOf": [ { "$ref": "#/components/schemas/StatusEnvelope" }, { "type": "object", "properties": { "status": { "type": "integer", "examples": [ 0 ] }, "message": { "type": "string", "examples": [ "The code successfully validated" ] } } } ], "title": "Check a one-time code response", "examples": [ { "status": 0, "message": "The code successfully validated" } ] }, "BalanceRequest": { "type": "object", "properties": { "balance": { "type": "object", "properties": { "user": { "type": "object", "properties": { "username": { "type": "string", "examples": [ "Leeroy" ], "description": "The username of the account by which you are recognized in the system." } }, "required": [ "username" ], "description": "Contains the user element." }, "type": { "type": "string", "examples": [ "mail" ], "description": "Send `mail` to read the mail balance instead. Omit it for the SMS balance." } }, "required": [ "user" ], "description": "Contains all other elements." } }, "required": [ "balance" ], "title": "Check the remaining balance", "description": "Check the remaining balance. Root element `balance`.\n\nEquivalent XML body (send with `Content-Type: application/xml`):\n\n```xml\n\n\n \n Leeroy\n \n mail\n\n```", "examples": [ { "balance": { "user": { "username": "Leeroy" }, "type": "mail" } } ] }, "BalanceResponse": { "allOf": [ { "$ref": "#/components/schemas/StatusEnvelope" }, { "type": "object", "properties": { "status": { "type": "integer", "examples": [ 0 ] }, "message": { "type": "string", "examples": [ "Your balance is : 42 and international balance: 40.5 nis" ] }, "balance": { "type": "string", "examples": [ "42" ] }, "international_balance": { "type": "string", "examples": [ "40.5" ] } } } ], "title": "Check the remaining balance response", "examples": [ { "status": 0, "message": "Your balance is : 42 and international balance: 40.5 nis", "balance": "42", "international_balance": "40.5" } ] }, "DlrRequest": { "type": "object", "properties": { "dlr": { "type": "object", "properties": { "user": { "type": "object", "properties": { "username": { "type": "string", "examples": [ "Leeroy" ], "description": "The username of the account by which you are recognized in the system." } }, "required": [ "username" ], "description": "Contains the user element." }, "transactions": { "type": "object", "properties": { "external_id": { "anyOf": [ { "type": "string", "examples": [ "some id 1", "some id 2" ] }, { "type": "array", "items": { "type": "string", "examples": [ "some id 1", "some id 2" ] } } ], "description": "The id you sent as an attribute when submitting the SMS." } }, "required": [ "external_id" ], "description": "Contains the ids you want reports for. May hold multiple `external_id` elements." }, "from": { "type": "string", "examples": [ "01/01/14 00:00" ], "description": "Start of the window, formatted `dd/mm/yy hh:mm`." }, "to": { "type": "string", "examples": [ "01/01/14 23:59" ], "description": "End of the window, formatted `dd/mm/yy hh:mm`." } }, "required": [ "user", "transactions", "from", "to" ], "description": "Contains all other elements." } }, "required": [ "dlr" ], "title": "Pull delivery reports by external id", "description": "Pull delivery reports by external id. Root element `dlr`.\n\nEquivalent XML body (send with `Content-Type: application/xml`):\n\n```xml\n\n\n \n Leeroy\n \n \n some id 1\n some id 2\n \n 01/01/14 00:00\n 01/01/14 23:59\n\n```", "examples": [ { "dlr": { "user": { "username": "Leeroy" }, "transactions": { "external_id": [ "some id 1", "some id 2" ] }, "from": "01/01/14 00:00", "to": "01/01/14 23:59" } } ] }, "DlrResponse": { "allOf": [ { "$ref": "#/components/schemas/StatusEnvelope" }, { "type": "object", "properties": { "status": { "type": "integer", "examples": [ 0 ] }, "message": { "type": "string", "examples": [ "all is well!" ] }, "transactions": { "anyOf": [ { "type": "object", "properties": { "external_id": { "type": "string", "examples": [ "1391438285" ] }, "source": { "type": "string", "examples": [ "Test" ] }, "phone": { "type": "string", "examples": [ "5XXXXXXXX" ] }, "status": { "type": "string", "examples": [ "102" ] }, "message_he": { "type": "string", "examples": [ "הגיע ליעד" ] }, "en_message": { "type": "string", "examples": [ "Delivered" ] }, "shipment_id": { "type": "string", "examples": [ "XXXXXXX" ] }, "date": { "type": "string", "examples": [ "02/05/23 10:22" ] }, "operator": { "type": "string", "examples": [ "Telzar" ] } } }, { "type": "array", "items": { "type": "object", "properties": { "external_id": { "type": "string", "examples": [ "1391438285" ] }, "source": { "type": "string", "examples": [ "Test" ] }, "phone": { "type": "string", "examples": [ "5XXXXXXXX" ] }, "status": { "type": "string", "examples": [ "102" ] }, "message_he": { "type": "string", "examples": [ "הגיע ליעד" ] }, "en_message": { "type": "string", "examples": [ "Delivered" ] }, "shipment_id": { "type": "string", "examples": [ "XXXXXXX" ] }, "date": { "type": "string", "examples": [ "02/05/23 10:22" ] }, "operator": { "type": "string", "examples": [ "Telzar" ] } } } } ] } } } ], "title": "Pull delivery reports by external id response", "examples": [ { "status": 0, "message": "all is well!", "transactions": [ { "external_id": "1391438285", "source": "Test", "phone": "5XXXXXXXX", "status": "102", "message_he": "הגיע ליעד", "en_message": "Delivered", "shipment_id": "XXXXXXX", "date": "02/05/23 10:22", "operator": "Telzar" } ] } ] }, "DlrByDateRequest": { "type": "object", "properties": { "dlrByDate": { "type": "object", "properties": { "user": { "type": "object", "properties": { "username": { "type": "string", "examples": [ "Leeroy" ], "description": "The username of the account by which you are recognized in the system." } }, "required": [ "username" ], "description": "Contains the user element." }, "transactions": { "type": "object", "properties": { "external_id": { "type": "string", "examples": [ "null" ], "description": "Send the literal string `null`." } }, "required": [ "external_id" ], "description": "Present but not used for filtering." }, "from": { "type": "string", "examples": [ "04/09/22 00:00" ], "description": "Start of the window, `dd/mm/yy hh:mm`." }, "to": { "type": "string", "examples": [ "04/09/22 23:59" ], "description": "End of the window, `dd/mm/yy hh:mm`." } }, "required": [ "user", "transactions", "from", "to" ], "description": "Contains all other elements." } }, "required": [ "dlrByDate" ], "title": "Pull delivery reports for a time window", "description": "Pull delivery reports for a time window. Root element `dlrByDate`.\n\nEquivalent XML body (send with `Content-Type: application/xml`):\n\n```xml\n\n\n \n Leeroy\n \n \n null\n \n 04/09/22 00:00\n 04/09/22 23:59\n\n```", "examples": [ { "dlrByDate": { "user": { "username": "Leeroy" }, "transactions": { "external_id": "null" }, "from": "04/09/22 00:00", "to": "04/09/22 23:59" } } ] }, "DlrByDateResponse": { "allOf": [ { "$ref": "#/components/schemas/StatusEnvelope" }, { "type": "object", "properties": { "status": { "type": "integer", "examples": [ 0 ] }, "message": { "type": "string", "examples": [ "all is well!" ] }, "transactions": { "anyOf": [ { "type": "object", "properties": { "external_id": { "type": "string", "examples": [ "1391438285" ] }, "source": { "type": "string", "examples": [ "Test" ] }, "phone": { "type": "string", "examples": [ "5XXXXXXXX" ] }, "status": { "type": "string", "examples": [ "102" ] }, "message_he": { "type": "string", "examples": [ "הגיע ליעד" ] }, "en_message": { "type": "string", "examples": [ "Delivered" ] }, "shipment_id": { "type": "string", "examples": [ "XXXXXXX" ] }, "date": { "type": "string", "examples": [ "02/05/23 10:22" ] }, "operator": { "type": "string", "examples": [ "Telzar" ] } } }, { "type": "array", "items": { "type": "object", "properties": { "external_id": { "type": "string", "examples": [ "1391438285" ] }, "source": { "type": "string", "examples": [ "Test" ] }, "phone": { "type": "string", "examples": [ "5XXXXXXXX" ] }, "status": { "type": "string", "examples": [ "102" ] }, "message_he": { "type": "string", "examples": [ "הגיע ליעד" ] }, "en_message": { "type": "string", "examples": [ "Delivered" ] }, "shipment_id": { "type": "string", "examples": [ "XXXXXXX" ] }, "date": { "type": "string", "examples": [ "02/05/23 10:22" ] }, "operator": { "type": "string", "examples": [ "Telzar" ] } } } } ] } } } ], "title": "Pull delivery reports for a time window response", "examples": [ { "status": 0, "message": "all is well!", "transactions": [ { "external_id": "1391438285", "source": "Test", "phone": "5XXXXXXXX", "status": "102", "message_he": "הגיע ליעד", "en_message": "Delivered", "shipment_id": "XXXXXXX", "date": "02/05/23 10:22", "operator": "Telzar" } ] } ] }, "IncomingRequest": { "type": "object", "properties": { "incoming": { "type": "object", "properties": { "user": { "type": "object", "properties": { "username": { "type": "string", "examples": [ "Leeroy" ], "description": "The username of the account by which you are recognized in the system." } }, "required": [ "username" ], "description": "Contains the user element." }, "from": { "type": "string", "examples": [ "01/11/22 00:00" ], "description": "Start of the window, `dd/mm/yy hh:mm`." }, "to": { "type": "string", "examples": [ "01/11/22 23:59" ], "description": "End of the window, `dd/mm/yy hh:mm`." } }, "required": [ "user", "from", "to" ], "description": "Contains all other elements." } }, "required": [ "incoming" ], "title": "Pull incoming messages", "description": "Pull incoming messages. Root element `incoming`.\n\nEquivalent XML body (send with `Content-Type: application/xml`):\n\n```xml\n\n\n \n Leeroy\n \n 01/11/22 00:00\n 01/11/22 23:59\n\n```", "examples": [ { "incoming": { "user": { "username": "Leeroy" }, "from": "01/11/22 00:00", "to": "01/11/22 23:59" } } ] }, "IncomingResponse": { "allOf": [ { "$ref": "#/components/schemas/StatusEnvelope" }, { "type": "object", "properties": { "status": { "type": "integer", "examples": [ 0 ] }, "message": { "type": "string", "examples": [ "" ] }, "transactions": { "anyOf": [ { "type": "object", "properties": { "source": { "type": "string", "examples": [ "test" ] }, "destination": { "type": "string", "examples": [ "9725XXXXXXX" ] }, "message": { "type": "string", "examples": [ "test" ] }, "date": { "type": "string", "examples": [ "01/05/23 00:00" ] } } }, { "type": "array", "items": { "type": "object", "properties": { "source": { "type": "string", "examples": [ "test" ] }, "destination": { "type": "string", "examples": [ "9725XXXXXXX" ] }, "message": { "type": "string", "examples": [ "test" ] }, "date": { "type": "string", "examples": [ "01/05/23 00:00" ] } } } } ] } } } ], "title": "Pull incoming messages response", "examples": [ { "status": 0, "message": "", "transactions": [ { "source": "test", "destination": "9725XXXXXXX", "message": "test", "date": "01/05/23 00:00" } ] } ] }, "BlacklistGetRequest": { "type": "object", "properties": { "blacklist": { "type": "object", "properties": { "user": { "type": "object", "properties": { "username": { "type": "string", "examples": [ "XXXXXX" ], "description": "The username of the account by which you are recognized in the system." } }, "required": [ "username" ], "description": "Contains the user element." }, "from": { "type": "string", "examples": [ "02/06/22 00:00" ], "description": "Start of the range, formatted `dd/mm/yy hh:mm`." }, "to": { "type": "string", "examples": [ "15/12/22 23:59" ], "description": "End of the range, formatted `dd/mm/yy hh:mm`." } }, "required": [ "user", "from", "to" ], "description": "Contains all other elements." } }, "required": [ "blacklist" ], "title": "List blocked numbers", "description": "List blocked numbers. Root element `blacklist`.\n\nEquivalent XML body (send with `Content-Type: application/xml`):\n\n```xml\n\n\n \n XXXXXX\n \n 02/06/22 00:00\n 15/12/22 23:59\n\n```", "examples": [ { "blacklist": { "user": { "username": "XXXXXX" }, "from": "02/06/22 00:00", "to": "15/12/22 23:59" } } ] }, "BlacklistGetResponse": { "allOf": [ { "$ref": "#/components/schemas/StatusEnvelope" }, { "type": "object", "properties": { "status": { "type": "integer", "examples": [ 0 ] }, "message": { "type": "string", "examples": [ "" ] }, "transactions": { "anyOf": [ { "type": "object", "properties": { "phone": { "type": "string", "examples": [ "5********" ] }, "date": { "type": "string", "examples": [ "22/08/22 11:00" ] } } }, { "type": "array", "items": { "type": "object", "properties": { "phone": { "type": "string", "examples": [ "5********" ] }, "date": { "type": "string", "examples": [ "22/08/22 11:00" ] } } } } ] } } } ], "title": "List blocked numbers response", "examples": [ { "status": 0, "message": "", "transactions": [ { "phone": "5********", "date": "22/08/22 11:00" }, { "phone": "5********", "date": "23/11/22 12:37" } ] } ] }, "BlacklistAddRequest": { "type": "object", "properties": { "addNumBL": { "type": "object", "properties": { "user": { "type": "object", "properties": { "username": { "type": "string", "examples": [ "xxxxxx" ], "description": "The username of the account by which you are recognized in the system." } }, "required": [ "username" ], "description": "Contains the user element." }, "phones": { "type": "object", "properties": { "phone": { "anyOf": [ { "type": "string", "examples": [ "5********", "05********" ] }, { "type": "array", "items": { "type": "string", "examples": [ "5********", "05********" ] } } ], "description": "A number to block. Repeatable." } }, "required": [ "phone" ], "description": "Contains all phone elements." } }, "required": [ "user", "phones" ], "description": "Contains all other elements." } }, "required": [ "addNumBL" ], "title": "Block numbers", "description": "Block numbers. Root element `addNumBL`.\n\nEquivalent XML body (send with `Content-Type: application/xml`):\n\n```xml\n\n\n \n xxxxxx\n \n \n 5********\n 05********\n \n\n```", "examples": [ { "addNumBL": { "user": { "username": "xxxxxx" }, "phones": { "phone": [ "5********", "05********" ] } } } ] }, "BlacklistAddResponse": { "allOf": [ { "$ref": "#/components/schemas/StatusEnvelope" }, { "type": "object", "properties": { "status": { "type": "integer", "examples": [ 946 ] }, "message": { "type": "string", "examples": [ "number has successfully added to blacklist" ] } } } ], "title": "Block numbers response", "examples": [ { "status": 946, "message": "number has successfully added to blacklist" } ] }, "BlacklistRemoveRequest": { "type": "object", "properties": { "rmNumBL": { "type": "object", "properties": { "user": { "type": "object", "properties": { "username": { "type": "string", "examples": [ "xxxxxx" ], "description": "The username of the account by which you are recognized in the system." } }, "required": [ "username" ], "description": "Contains the user element." }, "phones": { "type": "object", "properties": { "phone": { "anyOf": [ { "type": "string", "examples": [ "5********", "05********" ] }, { "type": "array", "items": { "type": "string", "examples": [ "5********", "05********" ] } } ], "description": "A number to unblock. Repeatable." } }, "required": [ "phone" ], "description": "Contains all phone elements." }, "reason": { "type": "string", "examples": [ "Customer opted back in by phone" ], "description": "Why the number is being unblocked." } }, "required": [ "user", "phones", "reason" ], "description": "Contains all other elements." } }, "required": [ "rmNumBL" ], "title": "Unblock numbers", "description": "Unblock numbers. Root element `rmNumBL`.\n\nEquivalent XML body (send with `Content-Type: application/xml`):\n\n```xml\n\n\n \n xxxxxx\n \n \n 5********\n 05********\n \n Customer opted back in by phone\n\n```", "examples": [ { "rmNumBL": { "user": { "username": "xxxxxx" }, "phones": { "phone": [ "5********", "05********" ] }, "reason": "Customer opted back in by phone" } } ] }, "BlacklistRemoveResponse": { "allOf": [ { "$ref": "#/components/schemas/StatusEnvelope" }, { "type": "object", "properties": { "status": { "type": "integer", "examples": [ 944 ] }, "message": { "type": "string", "examples": [ "X phone numbers Successfully deleted , Y Phone numbers not exist in blacklist" ] } } } ], "title": "Unblock numbers response", "examples": [ { "status": 944, "message": "X phone numbers Successfully deleted , Y Phone numbers not exist in blacklist" } ] }, "ClCreateRequest": { "type": "object", "properties": { "newCL": { "type": "object", "properties": { "user": { "type": "object", "properties": { "username": { "type": "string", "examples": [ "xxxxxx" ], "description": "The username of the account by which you are recognized in the system." } }, "required": [ "username" ], "description": "Contains the user element." }, "cl": { "anyOf": [ { "type": "object", "properties": { "name": { "type": "string", "examples": [ "name1", "name2" ], "description": "The list's name." }, "destinations": { "type": "object", "properties": { "destination": { "anyOf": [ { "type": "object", "properties": { "phone": { "type": "string", "examples": [ "055XXXXXXX", "55XXXXXXX" ], "description": "The contact's number, formatted `5xxxxxxx` or `05xxxxxxx`." }, "df1": { "type": "string", "examples": [ "Israel" ] }, "df2": { "type": "string", "examples": [ "Israeli" ] }, "df3": { "type": "string", "examples": [ "Haifa" ] } }, "required": [ "phone" ] }, { "type": "array", "items": { "type": "object", "properties": { "phone": { "type": "string", "examples": [ "055XXXXXXX", "55XXXXXXX" ], "description": "The contact's number, formatted `5xxxxxxx` or `05xxxxxxx`." }, "df1": { "type": "string", "examples": [ "Israel" ] }, "df2": { "type": "string", "examples": [ "Israeli" ] }, "df3": { "type": "string", "examples": [ "Haifa" ] } }, "required": [ "phone" ] } }, { "type": "object", "properties": { "phone": { "type": "string", "examples": [ "055XXXXXXX" ], "description": "The contact's number, formatted `5xxxxxxx` or `05xxxxxxx`." } }, "required": [ "phone" ] }, { "type": "array", "items": { "type": "object", "properties": { "phone": { "type": "string", "examples": [ "055XXXXXXX" ], "description": "The contact's number, formatted `5xxxxxxx` or `05xxxxxxx`." } }, "required": [ "phone" ] } } ] } }, "required": [ "destination" ] } }, "required": [ "name", "destinations" ] }, { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "examples": [ "name1", "name2" ], "description": "The list's name." }, "destinations": { "type": "object", "properties": { "destination": { "anyOf": [ { "type": "object", "properties": { "phone": { "type": "string", "examples": [ "055XXXXXXX", "55XXXXXXX" ], "description": "The contact's number, formatted `5xxxxxxx` or `05xxxxxxx`." }, "df1": { "type": "string", "examples": [ "Israel" ] }, "df2": { "type": "string", "examples": [ "Israeli" ] }, "df3": { "type": "string", "examples": [ "Haifa" ] } }, "required": [ "phone" ] }, { "type": "array", "items": { "type": "object", "properties": { "phone": { "type": "string", "examples": [ "055XXXXXXX", "55XXXXXXX" ], "description": "The contact's number, formatted `5xxxxxxx` or `05xxxxxxx`." }, "df1": { "type": "string", "examples": [ "Israel" ] }, "df2": { "type": "string", "examples": [ "Israeli" ] }, "df3": { "type": "string", "examples": [ "Haifa" ] } }, "required": [ "phone" ] } }, { "type": "object", "properties": { "phone": { "type": "string", "examples": [ "055XXXXXXX" ], "description": "The contact's number, formatted `5xxxxxxx` or `05xxxxxxx`." } }, "required": [ "phone" ] }, { "type": "array", "items": { "type": "object", "properties": { "phone": { "type": "string", "examples": [ "055XXXXXXX" ], "description": "The contact's number, formatted `5xxxxxxx` or `05xxxxxxx`." } }, "required": [ "phone" ] } } ] } }, "required": [ "destination" ] } }, "required": [ "name", "destinations" ] } } ], "description": "The details of a contact list to create. Repeatable. Several lists per call." } }, "required": [ "user", "cl" ], "description": "Contains all other elements." } }, "required": [ "newCL" ], "title": "Create contact lists", "description": "Create contact lists. Root element `newCL`.\n\nEquivalent XML body (send with `Content-Type: application/xml`):\n\n```xml\n\n\n \n xxxxxx\n \n \n name1\n \n \n 055XXXXXXX\n Israel\n Israeli\n Haifa\n \n \n 55XXXXXXX\n \n \n \n \n name2\n \n \n 055XXXXXXX\n \n \n \n\n```", "examples": [ { "newCL": { "user": { "username": "xxxxxx" }, "cl": [ { "name": "name1", "destinations": { "destination": [ { "phone": "055XXXXXXX", "df1": "Israel", "df2": "Israeli", "df3": "Haifa" }, { "phone": "55XXXXXXX" } ] } }, { "name": "name2", "destinations": { "destination": [ { "phone": "055XXXXXXX" } ] } } ] } } ] }, "ClCreateResponse": { "allOf": [ { "$ref": "#/components/schemas/StatusEnvelope" }, { "type": "object", "properties": { "status": { "type": "integer", "examples": [ 0 ] }, "message": { "type": "string", "examples": [ "conact list successfully created" ] }, "errors": { "anyOf": [ { "type": "string", "examples": [ "The phone is too long or too short or contain characters and therefore not added" ] }, { "type": "array", "items": { "type": "string", "examples": [ "The phone is too long or too short or contain characters and therefore not added" ] } } ] }, "identifiers": { "type": "string", "examples": [ "17419" ] } } } ], "title": "Create contact lists response", "examples": [ { "status": 0, "message": "conact list successfully created", "errors": [ "The phone is too long or too short or contain characters and therefore not added" ], "identifiers": "17419" } ] }, "ClRemoveRequest": { "type": "object", "properties": { "removeCL": { "type": "object", "properties": { "user": { "type": "object", "properties": { "username": { "type": "string", "examples": [ "xxxxxx" ], "description": "The username of the account by which you are recognized in the system." } }, "required": [ "username" ], "description": "Contains the user element." }, "cl": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "examples": [ "21518", "21500" ] }, { "type": "array", "items": { "type": "string", "examples": [ "21518", "21500" ] } } ], "description": "The id of a contact list to remove. Repeatable." } }, "required": [ "id" ], "description": "Contains the identifiers you want to remove." } }, "required": [ "user", "cl" ], "description": "Contains all other elements." } }, "required": [ "removeCL" ], "title": "Delete contact lists", "description": "Delete contact lists. Root element `removeCL`.\n\nEquivalent XML body (send with `Content-Type: application/xml`):\n\n```xml\n\n\n \n xxxxxx\n \n \n 21518\n 21500\n \n\n```", "examples": [ { "removeCL": { "user": { "username": "xxxxxx" }, "cl": { "id": [ "21518", "21500" ] } } } ] }, "ClRemoveResponse": { "allOf": [ { "$ref": "#/components/schemas/StatusEnvelope" }, { "type": "object", "properties": { "status": { "type": "integer", "examples": [ 0 ] }, "message": { "type": "string", "examples": [ "conact lists successfully removed" ] }, "errors": { "anyOf": [ { "type": "string", "examples": [ "contact list id: 21500 does not exist and therefore not removed" ] }, { "type": "array", "items": { "type": "string", "examples": [ "contact list id: 21500 does not exist and therefore not removed" ] } } ] } } } ], "title": "Delete contact lists response", "examples": [ { "status": 0, "message": "conact lists successfully removed", "errors": [ "contact list id: 21500 does not exist and therefore not removed" ] } ] }, "ClAddNumbersRequest": { "type": "object", "properties": { "addNumCL": { "type": "object", "properties": { "user": { "type": "object", "properties": { "username": { "type": "string", "examples": [ "xxxxxx" ], "description": "The username of the account by which you are recognized in the system." } }, "required": [ "username" ], "description": "Contains the user element." }, "cl": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "examples": [ "21518", "21500" ], "description": "The id of the contact list to update." }, "destinations": { "type": "object", "properties": { "destination": { "anyOf": [ { "type": "object", "properties": { "phone": { "type": "string", "examples": [ "055XXXXXXX", "55XXXXXXX" ], "description": "The contact's number, formatted `5xxxxxxx` or `05xxxxxxx`." }, "df1": { "type": "string", "examples": [ "Israel" ] }, "df2": { "type": "string", "examples": [ "Israeli" ] }, "df3": { "type": "string", "examples": [ "Haifa" ] } }, "required": [ "phone" ] }, { "type": "array", "items": { "type": "object", "properties": { "phone": { "type": "string", "examples": [ "055XXXXXXX", "55XXXXXXX" ], "description": "The contact's number, formatted `5xxxxxxx` or `05xxxxxxx`." }, "df1": { "type": "string", "examples": [ "Israel" ] }, "df2": { "type": "string", "examples": [ "Israeli" ] }, "df3": { "type": "string", "examples": [ "Haifa" ] } }, "required": [ "phone" ] } }, { "type": "object", "properties": { "phone": { "type": "string", "examples": [ "055XXXXXXX" ], "description": "The contact's number, formatted `5xxxxxxx` or `05xxxxxxx`." } }, "required": [ "phone" ] }, { "type": "array", "items": { "type": "object", "properties": { "phone": { "type": "string", "examples": [ "055XXXXXXX" ], "description": "The contact's number, formatted `5xxxxxxx` or `05xxxxxxx`." } }, "required": [ "phone" ] } } ] } }, "required": [ "destination" ] } }, "required": [ "id", "destinations" ] }, { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "examples": [ "21518", "21500" ], "description": "The id of the contact list to update." }, "destinations": { "type": "object", "properties": { "destination": { "anyOf": [ { "type": "object", "properties": { "phone": { "type": "string", "examples": [ "055XXXXXXX", "55XXXXXXX" ], "description": "The contact's number, formatted `5xxxxxxx` or `05xxxxxxx`." }, "df1": { "type": "string", "examples": [ "Israel" ] }, "df2": { "type": "string", "examples": [ "Israeli" ] }, "df3": { "type": "string", "examples": [ "Haifa" ] } }, "required": [ "phone" ] }, { "type": "array", "items": { "type": "object", "properties": { "phone": { "type": "string", "examples": [ "055XXXXXXX", "55XXXXXXX" ], "description": "The contact's number, formatted `5xxxxxxx` or `05xxxxxxx`." }, "df1": { "type": "string", "examples": [ "Israel" ] }, "df2": { "type": "string", "examples": [ "Israeli" ] }, "df3": { "type": "string", "examples": [ "Haifa" ] } }, "required": [ "phone" ] } }, { "type": "object", "properties": { "phone": { "type": "string", "examples": [ "055XXXXXXX" ], "description": "The contact's number, formatted `5xxxxxxx` or `05xxxxxxx`." } }, "required": [ "phone" ] }, { "type": "array", "items": { "type": "object", "properties": { "phone": { "type": "string", "examples": [ "055XXXXXXX" ], "description": "The contact's number, formatted `5xxxxxxx` or `05xxxxxxx`." } }, "required": [ "phone" ] } } ] } }, "required": [ "destination" ] } }, "required": [ "id", "destinations" ] } } ], "description": "The list to update. Repeatable. Several lists per call." } }, "required": [ "user", "cl" ], "description": "Contains all other elements." } }, "required": [ "addNumCL" ], "title": "Add numbers to a contact list", "description": "Add numbers to a contact list. Root element `addNumCL`.\n\nEquivalent XML body (send with `Content-Type: application/xml`):\n\n```xml\n\n\n \n xxxxxx\n \n \n 21518\n \n \n 055XXXXXXX\n Israel\n Israeli\n Haifa\n \n \n 55XXXXXXX\n \n \n \n \n 21500\n \n \n 055XXXXXXX\n \n \n \n\n```", "examples": [ { "addNumCL": { "user": { "username": "xxxxxx" }, "cl": [ { "id": "21518", "destinations": { "destination": [ { "phone": "055XXXXXXX", "df1": "Israel", "df2": "Israeli", "df3": "Haifa" }, { "phone": "55XXXXXXX" } ] } }, { "id": "21500", "destinations": { "destination": [ { "phone": "055XXXXXXX" } ] } } ] } } ] }, "ClAddNumbersResponse": { "allOf": [ { "$ref": "#/components/schemas/StatusEnvelope" }, { "type": "object", "properties": { "status": { "type": "integer", "examples": [ 0 ] }, "message": { "type": "string", "examples": [ "The phone numbers have been added successfully" ] }, "errors": { "anyOf": [ { "type": "string", "examples": [ "The phone 05XXXXXXXX is already on the contact list and therefore not added" ] }, { "type": "array", "items": { "type": "string", "examples": [ "The phone 05XXXXXXXX is already on the contact list and therefore not added" ] } } ] } } } ], "title": "Add numbers to a contact list response", "examples": [ { "status": 0, "message": "The phone numbers have been added successfully", "errors": [ "The phone 05XXXXXXXX is already on the contact list and therefore not added" ] } ] }, "ClRemoveNumbersRequest": { "type": "object", "properties": { "rmNumCL": { "type": "object", "properties": { "user": { "type": "object", "properties": { "username": { "type": "string", "examples": [ "xxxxxx" ], "description": "The username of the account by which you are recognized in the system." } }, "required": [ "username" ], "description": "Contains the user element." }, "cl": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "examples": [ "21518", "21500" ], "description": "The id of the contact list to update." }, "destinations": { "type": "object", "properties": { "phone": { "anyOf": [ { "type": "string", "examples": [ "055XXXXXXX" ], "description": "A number to remove, formatted `5xxxxxxx` or `05xxxxxxx`. Repeatable." }, { "type": "string", "examples": [ "055XXXXXXX", "55XXXXXXX" ] }, { "type": "array", "items": { "type": "string", "examples": [ "055XXXXXXX", "55XXXXXXX" ] } } ] } }, "required": [ "phone" ] } }, "required": [ "id", "destinations" ] }, { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "examples": [ "21518", "21500" ], "description": "The id of the contact list to update." }, "destinations": { "type": "object", "properties": { "phone": { "anyOf": [ { "type": "string", "examples": [ "055XXXXXXX" ], "description": "A number to remove, formatted `5xxxxxxx` or `05xxxxxxx`. Repeatable." }, { "type": "string", "examples": [ "055XXXXXXX", "55XXXXXXX" ] }, { "type": "array", "items": { "type": "string", "examples": [ "055XXXXXXX", "55XXXXXXX" ] } } ] } }, "required": [ "phone" ] } }, "required": [ "id", "destinations" ] } } ], "description": "The list to update. Repeatable." } }, "required": [ "user", "cl" ], "description": "Contains all other elements." } }, "required": [ "rmNumCL" ], "title": "Remove numbers from a contact list", "description": "Remove numbers from a contact list. Root element `rmNumCL`.\n\nEquivalent XML body (send with `Content-Type: application/xml`):\n\n```xml\n\n\n \n xxxxxx\n \n \n 21518\n \n 055XXXXXXX\n \n \n \n 21500\n \n 055XXXXXXX\n 55XXXXXXX\n \n \n\n```", "examples": [ { "rmNumCL": { "user": { "username": "xxxxxx" }, "cl": [ { "id": "21518", "destinations": { "phone": "055XXXXXXX" } }, { "id": "21500", "destinations": { "phone": [ "055XXXXXXX", "55XXXXXXX" ] } } ] } } ] }, "ClRemoveNumbersResponse": { "allOf": [ { "$ref": "#/components/schemas/StatusEnvelope" }, { "type": "object", "properties": { "status": { "type": "integer", "examples": [ 0 ] }, "message": { "type": "string", "examples": [ "Successfully deleted phone numbers" ] }, "errors": { "anyOf": [ { "type": "string", "examples": [ "contact list id: 21500 does not exist and therefore not removed" ] }, { "type": "array", "items": { "type": "string", "examples": [ "contact list id: 21500 does not exist and therefore not removed" ] } } ] } } } ], "title": "Remove numbers from a contact list response", "examples": [ { "status": 0, "message": "Successfully deleted phone numbers", "errors": [ "contact list id: 21500 does not exist and therefore not removed" ] } ] }, "ClGetAllRequest": { "type": "object", "properties": { "getCL": { "type": "object", "properties": { "user": { "type": "object", "properties": { "username": { "type": "string", "examples": [ "xxxxxx" ], "description": "The username of the account by which you are recognized in the system." } }, "required": [ "username" ], "description": "Contains the user element." } }, "required": [ "user" ], "description": "Contains all other elements." } }, "required": [ "getCL" ], "title": "List every contact list", "description": "List every contact list. Root element `getCL`.\n\nEquivalent XML body (send with `Content-Type: application/xml`):\n\n```xml\n\n\n \n xxxxxx\n \n\n```", "examples": [ { "getCL": { "user": { "username": "xxxxxx" } } } ] }, "ClGetAllResponse": { "allOf": [ { "$ref": "#/components/schemas/StatusEnvelope" }, { "type": "object", "properties": { "status": { "type": "integer", "examples": [ 0 ] }, "message": { "type": "string", "examples": [ "" ] }, "contact_lists": { "anyOf": [ { "type": "object", "properties": { "cl_id": { "type": "string", "examples": [ "21518" ] }, "phone": { "type": "string", "examples": [ "55XXXXXXX" ] }, "name": { "type": "string", "examples": [ "name1" ] } } }, { "type": "array", "items": { "type": "object", "properties": { "cl_id": { "type": "string", "examples": [ "21518" ] }, "phone": { "type": "string", "examples": [ "55XXXXXXX" ] }, "name": { "type": "string", "examples": [ "name1" ] } } } } ] } } } ], "title": "List every contact list response", "examples": [ { "status": 0, "message": "", "contact_lists": [ { "cl_id": "21518", "phone": "55XXXXXXX", "name": "name1" }, { "cl_id": "21500", "phone": "555XXXXXX", "name": "name2" } ] } ] }, "ClGetByIdRequest": { "type": "object", "properties": { "getCLbyID": { "type": "object", "properties": { "user": { "type": "object", "properties": { "username": { "type": "string", "examples": [ "xxxxxx" ], "description": "The username of the account by which you are recognized in the system." } }, "required": [ "username" ], "description": "Contains the user element." }, "cl": { "type": "object", "properties": { "id": { "type": "string", "examples": [ "21518" ], "description": "The id of the contact list you want." } }, "required": [ "id" ], "description": "Contains contact list elements." } }, "required": [ "user", "cl" ], "description": "Contains all other elements." } }, "required": [ "getCLbyID" ], "title": "Read one contact list", "description": "Read one contact list. Root element `getCLbyID`.\n\nEquivalent XML body (send with `Content-Type: application/xml`):\n\n```xml\n\n\n \n xxxxxx\n \n \n 21518\n \n\n```", "examples": [ { "getCLbyID": { "user": { "username": "xxxxxx" }, "cl": { "id": "21518" } } } ] }, "ClGetByIdResponse": { "allOf": [ { "$ref": "#/components/schemas/StatusEnvelope" }, { "type": "object", "properties": { "status": { "type": "integer", "examples": [ 0 ] }, "message": { "type": "string", "examples": [ "" ] }, "contact_lists": { "anyOf": [ { "type": "object", "properties": { "cl_id": { "type": "string", "examples": [ "21518" ] }, "phone": { "type": "string", "examples": [ "55XXXXXXX" ] }, "name": { "type": "string", "examples": [ "name1" ] } } }, { "type": "array", "items": { "type": "object", "properties": { "cl_id": { "type": "string", "examples": [ "21518" ] }, "phone": { "type": "string", "examples": [ "55XXXXXXX" ] }, "name": { "type": "string", "examples": [ "name1" ] } } } } ] } } } ], "title": "Read one contact list response", "examples": [ { "status": 0, "message": "", "contact_lists": [ { "cl_id": "21518", "phone": "55XXXXXXX", "name": "name1" }, { "cl_id": "21518", "phone": "555XXXXXX", "name": "name1" } ] } ] }, "CampaignCancelByIdRequest": { "type": "object", "properties": { "cancel": { "type": "object", "properties": { "user": { "type": "object", "properties": { "username": { "type": "string", "examples": [ "Leeroy" ], "description": "The username of the account by which you are recognized in the system." } }, "required": [ "username" ], "description": "Contains the user element." }, "campaign_id": { "type": "string", "examples": [ "1234" ], "description": "The number of your campaign." } }, "required": [ "user", "campaign_id" ], "description": "Contains all other elements." } }, "required": [ "cancel" ], "title": "Cancel a campaign by id", "description": "Cancel a campaign by id. Root element `cancel`.\n\nEquivalent XML body (send with `Content-Type: application/xml`):\n\n```xml\n\n\n \n Leeroy\n \n 1234\n\n```", "examples": [ { "cancel": { "user": { "username": "Leeroy" }, "campaign_id": "1234" } } ] }, "CampaignCancelByIdResponse": { "allOf": [ { "$ref": "#/components/schemas/StatusEnvelope" }, { "type": "object", "properties": { "status": { "type": "integer", "examples": [ 0 ] }, "message": { "type": "string", "examples": [ "Campaign successfuly cancel" ] } } } ], "title": "Cancel a campaign by id response", "examples": [ { "status": 0, "message": "Campaign successfuly cancel" } ] }, "CampaignCancelByNameRequest": { "type": "object", "properties": { "cancel": { "type": "object", "properties": { "user": { "type": "object", "properties": { "username": { "type": "string", "examples": [ "Leeroy" ], "description": "The username of the account by which you are recognized in the system." } }, "required": [ "username" ], "description": "Contains the user element." }, "campaign_name": { "type": "string", "examples": [ "My Campaign" ], "description": "The name of your campaign." } }, "required": [ "user", "campaign_name" ], "description": "Contains all other elements." } }, "required": [ "cancel" ], "title": "Cancel campaigns by name", "description": "Cancel campaigns by name. Root element `cancel`.\n\nEquivalent XML body (send with `Content-Type: application/xml`):\n\n```xml\n\n\n \n Leeroy\n \n My Campaign\n\n```", "examples": [ { "cancel": { "user": { "username": "Leeroy" }, "campaign_name": "My Campaign" } } ] }, "CampaignCancelByNameResponse": { "allOf": [ { "$ref": "#/components/schemas/StatusEnvelope" }, { "type": "object", "properties": { "status": { "type": "integer", "examples": [ 0 ] }, "message": { "type": "string", "examples": [ "Campaigns successfully cancel" ] }, "count": { "type": "integer", "examples": [ 1 ] } } } ], "title": "Cancel campaigns by name response", "examples": [ { "status": 0, "message": "Campaigns successfully cancel", "count": 1 } ] }, "BirthdayListRequest": { "type": "object", "properties": { "get_birthday_campaigns": { "type": "object", "properties": { "user": { "type": "object", "properties": { "username": { "type": "string", "examples": [ "XXXXXX" ], "description": "The username of the account by which you are recognized in the system." } }, "required": [ "username" ], "description": "Contains the user element." } }, "required": [ "user" ], "description": "Contains all other elements." } }, "required": [ "get_birthday_campaigns" ], "title": "List birthday campaigns", "description": "List birthday campaigns. Root element `get_birthday_campaigns`.\n\nEquivalent XML body (send with `Content-Type: application/xml`):\n\n```xml\n\n\n \n XXXXXX\n \n\n```", "examples": [ { "get_birthday_campaigns": { "user": { "username": "XXXXXX" } } } ] }, "BirthdayListResponse": { "allOf": [ { "$ref": "#/components/schemas/StatusEnvelope" }, { "type": "object", "properties": { "status": { "type": "integer", "examples": [ 0 ] }, "message": { "type": "string", "examples": [ "" ] }, "birthday_campaigns": { "type": "object", "properties": { "birthday_campaign": { "anyOf": [ { "type": "object", "properties": { "CAMPAIGN_ID": { "type": "string", "examples": [ "xxxxx" ] }, "CAMPAIGN_NAME": { "type": "string", "examples": [ "xxxxx" ] }, "CREATED_ON": { "type": "string", "examples": [ "18/10/23 14:40:39" ] }, "ACTIVE_DESTINATIONS": { "type": "string", "examples": [ "" ] } } }, { "type": "array", "items": { "type": "object", "properties": { "CAMPAIGN_ID": { "type": "string", "examples": [ "xxxxx" ] }, "CAMPAIGN_NAME": { "type": "string", "examples": [ "xxxxx" ] }, "CREATED_ON": { "type": "string", "examples": [ "18/10/23 14:40:39" ] }, "ACTIVE_DESTINATIONS": { "type": "string", "examples": [ "" ] } } } } ] } } } } } ], "title": "List birthday campaigns response", "examples": [ { "status": 0, "message": "", "birthday_campaigns": { "birthday_campaign": [ { "CAMPAIGN_ID": "xxxxx", "CAMPAIGN_NAME": "xxxxx", "CREATED_ON": "18/10/23 14:40:39", "ACTIVE_DESTINATIONS": "" } ] } } ] }, "BirthdayEditRequest": { "type": "object", "properties": { "edit_birthday_campaign": { "type": "object", "properties": { "user": { "type": "object", "properties": { "username": { "type": "string", "examples": [ "XXXX" ], "description": "The username of the account by which you are recognized in the system." } }, "required": [ "username" ], "description": "Contains the user element." }, "campaign_id": { "type": "string", "examples": [ "XXXX" ], "description": "The `campaign_id` you want to edit." }, "message": { "type": "string", "examples": [ "XXXX" ], "description": "The content of the new message." } }, "required": [ "user", "campaign_id", "message" ], "description": "Contains all other elements." } }, "required": [ "edit_birthday_campaign" ], "title": "Change a birthday campaign message", "description": "Change a birthday campaign message. Root element `edit_birthday_campaign`.\n\nEquivalent XML body (send with `Content-Type: application/xml`):\n\n```xml\n\n\n \n XXXX\n \n XXXX\n XXXX\n\n```", "examples": [ { "edit_birthday_campaign": { "user": { "username": "XXXX" }, "campaign_id": "XXXX", "message": "XXXX" } } ] }, "BirthdayEditResponse": { "allOf": [ { "$ref": "#/components/schemas/StatusEnvelope" }, { "type": "object", "properties": { "status": { "type": "integer", "examples": [ 0 ] }, "message": { "type": "string", "examples": [ "birthday campaign successfully updated" ] } } } ], "title": "Change a birthday campaign message response", "examples": [ { "status": 0, "message": "birthday campaign successfully updated" } ] }, "VerifyPhoneRequest": { "type": "object", "properties": { "verify_phone": { "type": "object", "properties": { "user": { "type": "object", "properties": { "username": { "type": "string", "examples": [ "Leeroy" ], "description": "The username of the account by which you are recognized in the system." } }, "required": [ "username" ], "description": "Contains the user element." }, "phone": { "anyOf": [ { "type": "string", "examples": [ "5xxxxxxxx", "3xxxxxxx" ] }, { "type": "array", "items": { "type": "string", "examples": [ "5xxxxxxxx", "3xxxxxxx" ] } } ], "description": "A number to use as an SMS source. Must be a legal mobile or landline number. Repeatable." } }, "required": [ "user", "phone" ], "description": "Contains all other elements." } }, "required": [ "verify_phone" ], "title": "Submit a number for sender verification", "description": "Submit a number for sender verification. Root element `verify_phone`.\n\nEquivalent XML body (send with `Content-Type: application/xml`):\n\n```xml\n\n\n \n Leeroy\n \n 5xxxxxxxx\n 3xxxxxxx\n\n```", "examples": [ { "verify_phone": { "user": { "username": "Leeroy" }, "phone": [ "5xxxxxxxx", "3xxxxxxx" ] } } ] }, "VerifyPhoneResponse": { "allOf": [ { "$ref": "#/components/schemas/StatusEnvelope" }, { "type": "object", "properties": { "status": { "type": "integer", "examples": [ 0 ] }, "verify_message": { "type": "string", "examples": [ "verification link will be send to 5******** in order to complete the verification of 3******* call to 0552458888" ] } } } ], "title": "Submit a number for sender verification response", "examples": [ { "status": 0, "verify_message": "verification link will be send to 5******** in order to complete the verification of 3******* call to 0552458888" } ] }, "VerifiedPhonesRequest": { "type": "object", "properties": { "getVerifiedPhones": { "type": "object", "properties": { "user": { "type": "object", "properties": { "username": { "type": "string", "examples": [ "username" ], "description": "The username of the account by which you are recognized in the system." } }, "required": [ "username" ], "description": "Contains the user element." }, "is_subs": { "type": "string", "examples": [ "1" ], "description": "Set to `1` to include the verified numbers of your sub-accounts. Omit the field entirely to exclude them." } }, "required": [ "user" ], "description": "Contains all other elements." } }, "required": [ "getVerifiedPhones" ], "title": "List verified sender numbers", "description": "List verified sender numbers. Root element `getVerifiedPhones`.\n\nEquivalent XML body (send with `Content-Type: application/xml`):\n\n```xml\n\n\n \n username\n \n 1\n\n```", "examples": [ { "getVerifiedPhones": { "user": { "username": "username" }, "is_subs": "1" } } ] }, "VerifiedPhonesResponse": { "allOf": [ { "$ref": "#/components/schemas/StatusEnvelope" }, { "type": "object", "properties": { "status": { "type": "integer", "examples": [ 0 ] }, "message": { "type": "string", "examples": [ "" ] }, "verified_phones": { "anyOf": [ { "type": "object", "properties": { "PHONE": { "type": "string", "examples": [ "xxxxxxxxxx" ] }, "USER_ID": { "type": "string", "examples": [ "XXXX" ] }, "ASSIGNMENT_DATE": { "type": "string", "examples": [ "03/12/14 12:33" ] }, "LAST_UPDATE": { "type": "string", "examples": [ "03/12/14 12:33" ] } } }, { "type": "array", "items": { "type": "object", "properties": { "PHONE": { "type": "string", "examples": [ "xxxxxxxxxx" ] }, "USER_ID": { "type": "string", "examples": [ "XXXX" ] }, "ASSIGNMENT_DATE": { "type": "string", "examples": [ "03/12/14 12:33" ] }, "LAST_UPDATE": { "type": "string", "examples": [ "03/12/14 12:33" ] } } } } ] } } } ], "title": "List verified sender numbers response", "examples": [ { "status": 0, "message": "", "verified_phones": [ { "PHONE": "xxxxxxxxxx", "USER_ID": "XXXX", "ASSIGNMENT_DATE": "03/12/14 12:33", "LAST_UPDATE": "03/12/14 12:33" } ] } ] }, "SubscriberAddRequest": { "type": "object", "properties": { "addSub": { "type": "object", "properties": { "user": { "type": "object", "properties": { "username": { "type": "string", "examples": [ "xxxxxx" ], "description": "Your username. The reseller account." } }, "required": [ "username" ], "description": "Contains the user element." }, "userDetails": { "type": "object", "properties": { "name": { "type": "string", "examples": [ "israel israeli" ], "description": "Display name for the new user." }, "username": { "type": "string", "examples": [ "israelisraeli" ], "description": "Your username. The reseller account." }, "password": { "type": "string", "examples": [ "israelisraeli" ], "description": "Password for the new user." }, "source": { "type": "string", "examples": [ "055xxxxxxx" ], "description": "Default sender for the new user." }, "amount": { "type": "string", "examples": [ "70000" ], "description": "Credits to grant on creation, taken from your balance." }, "otpPhone": { "type": "string", "examples": [ "5xxxxxxxx" ], "description": "Phone number for OTP authentication." } }, "required": [ "name", "username", "password", "source", "amount" ], "description": "The details of the user you want to add." } }, "required": [ "user", "userDetails" ], "description": "Contains all other elements." } }, "required": [ "addSub" ], "title": "Create a sub-account", "description": "Create a sub-account. Root element `addSub`.\n\nEquivalent XML body (send with `Content-Type: application/xml`):\n\n```xml\n\n\n \n xxxxxx\n \n \n israel israeli\n israelisraeli\n israelisraeli\n 055xxxxxxx\n 70000\n 5xxxxxxxx\n \n\n```", "examples": [ { "addSub": { "user": { "username": "xxxxxx" }, "userDetails": { "name": "israel israeli", "username": "israelisraeli", "password": "israelisraeli", "source": "055xxxxxxx", "amount": "70000", "otpPhone": "5xxxxxxxx" } } } ] }, "SubscriberAddResponse": { "allOf": [ { "$ref": "#/components/schemas/StatusEnvelope" }, { "type": "object", "properties": { "status": { "type": "integer", "examples": [ 0 ] }, "message": { "type": "string", "examples": [ "The user was created successfully" ] } } } ], "title": "Create a sub-account response", "examples": [ { "status": 0, "message": "The user was created successfully" } ] }, "SubscriberWalletRequest": { "type": "object", "properties": { "updateAmountSub": { "type": "object", "properties": { "user": { "type": "object", "properties": { "username": { "type": "string", "examples": [ "xxxxxx" ], "description": "Your username. The reseller account." } }, "required": [ "username" ], "description": "Contains the user element." }, "userDetails": { "type": "object", "properties": { "username": { "type": "string", "examples": [ "username1" ], "description": "Your username. The reseller account." }, "amount": { "type": "string", "examples": [ "70000" ], "description": "Credits to grant." }, "amount_int": { "type": "integer", "description": "Use this instead of `amount` to update the sub-account's money balance rather than its message credits. Send it without an `amount` element." } }, "required": [ "username", "amount" ], "description": "The details of the user you want to update." } }, "required": [ "user", "userDetails" ], "description": "Contains all other elements." } }, "required": [ "updateAmountSub" ], "title": "Top up a sub-account's wallet", "description": "Top up a sub-account's wallet. Root element `updateAmountSub`.\n\nEquivalent XML body (send with `Content-Type: application/xml`):\n\n```xml\n\n\n \n xxxxxx\n \n \n username1\n 70000\n \n\n```", "examples": [ { "updateAmountSub": { "user": { "username": "xxxxxx" }, "userDetails": { "username": "username1", "amount": "70000" } } } ] }, "SubscriberWalletResponse": { "allOf": [ { "$ref": "#/components/schemas/StatusEnvelope" }, { "type": "object", "properties": { "status": { "type": "integer", "examples": [ 0 ] }, "message": { "type": "string", "examples": [ "Wallet successfully updated" ] } } } ], "title": "Top up a sub-account's wallet response", "examples": [ { "status": 0, "message": "Wallet successfully updated" } ] }, "SubscriberBalancesRequest": { "type": "object", "properties": { "getBlanceSubs": { "type": "object", "properties": { "user": { "type": "object", "properties": { "username": { "type": "string", "examples": [ "xxxxxx" ], "description": "Your username. The reseller account." } }, "required": [ "username" ], "description": "Contains the user element." } }, "required": [ "user" ], "description": "Contains all other elements." } }, "required": [ "getBlanceSubs" ], "title": "Read every sub-account balance", "description": "Read every sub-account balance. Root element `getBlanceSubs`.\n\nEquivalent XML body (send with `Content-Type: application/xml`):\n\n```xml\n\n\n \n xxxxxx\n \n\n```", "examples": [ { "getBlanceSubs": { "user": { "username": "xxxxxx" } } } ] }, "SubscriberBalancesResponse": { "allOf": [ { "$ref": "#/components/schemas/StatusEnvelope" }, { "type": "object", "properties": { "status": { "type": "integer", "examples": [ 0 ] }, "message": { "type": "string", "examples": [ "" ] }, "balances": { "anyOf": [ { "type": "object", "properties": { "amount": { "type": "string", "examples": [ "80" ] }, "sms_user_id": { "type": "string", "examples": [ "XXXX" ] }, "name": { "type": "string", "examples": [ "name1" ] } } }, { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "string", "examples": [ "80" ] }, "sms_user_id": { "type": "string", "examples": [ "XXXX" ] }, "name": { "type": "string", "examples": [ "name1" ] } } } } ] } } } ], "title": "Read every sub-account balance response", "examples": [ { "status": 0, "message": "", "balances": [ { "amount": "80", "sms_user_id": "XXXX", "name": "name1" }, { "amount": "50", "sms_user_id": "XXXX", "name": "name2" } ] } ] } } }, "externalDocs": { "url": "https://textme-docs.matat.io", "description": "TextMe API documentation" } }