{ "openapi": "3.1.0", "info": { "title": "LOX24 API Specification (PT)", "description": "# Introdu\u00e7\u00e3o\n\nNestas p\u00e1ginas voc\u00ea encontrar\u00e1 nossa documenta\u00e7\u00e3o para transmiss\u00e3o de mensagens usando o Gateway SMS LOX24. A documenta\u00e7\u00e3o ajuda voc\u00ea a integrar nossa API SMS em suas pr\u00f3prias aplica\u00e7\u00f5es e, portanto, a enviar e receber mensagens SMS.\nVoc\u00ea pode encontrar nossa API SMS em api.lox24.eu. Voc\u00ea acessa as fun\u00e7\u00f5es individuais de acordo com uma /fun\u00e7\u00e3o. Por exemplo, api.lox24.eu/me para consultar sua conta de cliente e api.lox24.eu/sms para enviar um SMS. Todos os endpoints requerem autentica\u00e7\u00e3o por cabe\u00e7alho HTTP.\n\n### Destaques\n- Use HTTPS, para mensagens totalmente criptografadas com SSL\n- Envie SMS concatenados, aparecendo como um \u00fanico SMS no aparelho\n- Envie mensagens com texto no conjunto de caracteres GSM 03.38 ou Unicode\n- Transmita qualquer ID de remetente com at\u00e9 15 d\u00edgitos ou 11 caracteres\n- Envie um SMS em massa para toda a sua lista de contatos com apenas uma solicita\u00e7\u00e3o\n- Receba respostas \u00e0s suas mensagens enviadas via HTTP, HTTPS ou SMTP\n- Receba ou verifique o status de entrega das mensagens de sa\u00edda\n- Receba mensagens de entrada do seu n\u00famero de entrada (opcional)\n\n\n### Tipo de Conte\u00fado da Requisi\u00e7\u00e3o\nO Content-Type para requisi\u00e7\u00f5es POST e PUT pode ser definido como `application/json`\nou `multipart/form-data` (em endpoints com uploads de arquivos).\n\n### Cabe\u00e7alhos de resposta\n\nCada resposta da API inclui um identificador de solicita\u00e7\u00e3o exclusivo no cabe\u00e7alho `X-LOX24-REQUEST-ID`.\nEste identificador alfanum\u00e9rico de 32 caracteres \u00e9 gerado para cada solicita\u00e7\u00e3o e pode ser usado\npara fins de suporte ao relatar problemas ou rastrear chamadas espec\u00edficas da API.\n\n### Propriedades de data e hora\nA maioria dos objetos de requisi\u00e7\u00f5es/respostas de data e hora s\u00e3o timestamps unix (inteiro).\n\n### Bloqueio de IP\n\nSe mais de tr\u00eas requisi\u00e7\u00f5es forem recebidas de um endere\u00e7o IP com dados de autentica\u00e7\u00e3o incorretos dentro de um minuto,\ntodas as requisi\u00e7\u00f5es subsequentes deste IP receber\u00e3o uma resposta com o status 429 (Muitas Requisi\u00e7\u00f5es) dentro dos pr\u00f3ximos dez minutos.\n\n\n## Autentica\u00e7\u00e3o\nTodos os endpoints exigem que voc\u00ea esteja autenticado. Para se autenticar, voc\u00ea\nprecisar\u00e1 criar um token de API a partir da sua conta web ([http://account.lox24.eu](http://account.lox24.eu)\n\"Configura\u00e7\u00f5es\" e \"Configura\u00e7\u00f5es de API\"). Uma vez que voc\u00ea tenha sua Chave de API, voc\u00ea pode pass\u00e1-la\ncomo um **cabe\u00e7alho HTTP** assim:\n\n```\ncurl -X GET https://api.lox24.eu/me \\\n -H 'Host: api.lox24.eu' \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n```\n\n```\ncurl -X POST https://api.lox24.eu/groups/7116/phones \\\n -H 'Content-Type: application/json' \\\n -H 'Host: api.lox24.eu' \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx' \\\n -d '{\n \"phone\": \"+4917663804817\",\n \"a\": \"o2\"\n}'\n```\n\n### M\u00e9todo de autentica\u00e7\u00e3o legado\n\nTamb\u00e9m continuamos a suportar a vers\u00e3o antiga de autentica\u00e7\u00e3o com dois cabe\u00e7alhos 'X-LOX24-CLIENT-ID' e 'X-LOX24-AUTH-TOKEN'\n\n```\ncurl -X GET https://api.lox24.eu/me \\\n -H 'Host: api.lox24.eu' \\\n -H 'X-LOX24-AUTH-TOKEN: e3f3a759b6677959b6ebfcxxxxxxxxxx' \\\n -H 'X-LOX24-CLIENT-ID: 1234567'\n```\n\n### Importante!\n\nNunca compartilhe suas chaves secretas. Mantenha-as protegidas e seguras. Se uma chave for\npublicada involuntariamente, voc\u00ea pode desativ\u00e1-la ou exclu\u00ed-la a qualquer momento\nem sua conta web (https://account.lox24.eu) nas \"Configura\u00e7\u00f5es\" e \"Configura\u00e7\u00f5es de API\".\n", "version": "2.27", "contact": { "name": "LOX24", "email": "berlin@lox24.eu", "url": "https://doc.lox24.eu" }, "license": { "name": "Termos de Servi\u00e7o da LOX24", "url": "https://www.lox24.eu/pt/terms/" }, "x-logo": { "url": "/images/logo.png", "href": "https://doc.lox24.eu/", "altText": "LOX24 API Specification" } }, "servers": [ { "url": "https://api.lox24.eu", "description": "" } ], "security": [ { "token": [] } ], "tags": [ { "name": "sms", "x-displayName": "SMS", "description": "The sms endpoint is used to send **individual SMS**. This includes regular SMS but also the dryrun for test purposes. In addition, there are a number of functions to query sent SMS, delete SMS or stop the dispatch.\n\n* Send single SMS\n* Query sent SMS\n* Stop time shifted SMS\n* Delete SMS data\n* Query SMS data\n\nIf you don't want to send single SMS, but want to send bulk SMS via the API, then the endpoint \"bulks\" is relevant.\n" }, { "name": "bulks", "x-displayName": "SMS em massa", "description": "The bulks interface is used to **send bulk SMS**. This includes the correct bulk SMS transmission to multiple phone numbers and/or groups but also the dryrun. In addition, there are a number of functions to query the status of a bulk or to stop the mailing.\n\n* Send bulk SMS\n* Query status of bulk SMS\n* Stop bulk SMS\n\nIf you don't want to send mass SMS but want to send individual SMS via the API, then the endpoint \"sms\" is relevant.\n" }, { "name": "blocked numbers", "x-displayName": "N\u00famero de telefone bloqueado", "description": "O endpoint de n\u00fameros bloqueados \u00e9 usado para gerenciar **n\u00fameros de telefone bloqueados** para campanhas de SMS. Isso permite que voc\u00ea mantenha uma lista de n\u00fameros de telefone que n\u00e3o devem receber mensagens SMS, seja bloqueados por solicita\u00e7\u00e3o do cliente ou cancelados pelos usu\u00e1rios. Os n\u00fameros de telefone s\u00e3o automaticamente adicionados a esta lista quando os usu\u00e1rios cancelam a inscri\u00e7\u00e3o atrav\u00e9s de formul\u00e1rios de cancelamento de campanhas de links curtos com tipo 2 (cancelado).\n\n* Adicionar n\u00fameros de telefone \u00e0 lista de bloqueados\n* Consultar n\u00fameros de telefone bloqueados\n* Remover n\u00fameros de telefone da lista de bloqueados\n* Filtrar n\u00fameros bloqueados por tipo ou n\u00famero\n\nEste endpoint ajuda a garantir a conformidade com as regulamenta\u00e7\u00f5es de SMS e as prefer\u00eancias do usu\u00e1rio, impedindo que mensagens sejam enviadas para destinat\u00e1rios indesejados." }, { "name": "incomings", "x-displayName": "Recebidas", "description": "This interface is used to query inbound SMS (pull). The list of all incoming SMS, as well as the content of a particular SMS. Please note, however, that you can also receive the SMS as push, as soon as they arrive. The [push variant](/pt/info/inbound-and-reply-sms/) is preferably, since you do not have to check for incoming SMS, but these are sent directly to your script.\n" }, { "name": "groups", "x-displayName": "Grupos", "description": "The function \"Groups\" allows you to create bulk SMS mailing lists. Each mailing list represents a\ngroup. By using the functions in \"Groups\" you can create, view, delete and export the mailing lists.\n" }, { "name": "phones", "x-displayName": "Telefones", "description": "Esta interface serve de complemento aos grupos. Atrav\u00e9s dos telefones pode adicionar, apagar ou modificar n\u00fameros de telefone na sua lista de distribui\u00e7\u00e3o de SMS. Tamb\u00e9m \u00e9 poss\u00edvel exportar o conte\u00fado de um grupo atrav\u00e9s desta interface." }, { "name": "campaigns", "x-displayName": "Campanhas", "description": "You can create a short link campaign via the campaigns API. A short link campaign is used to create a short link, which you can then use for individual and bulk SMS messages.\nYou can also query the existing short links via the interface and change or delete them.\n" }, { "name": "links", "x-displayName": "Links", "description": "The Links API is used to query the specific short links of one or all short link campaigns.\n" }, { "name": "requests", "x-displayName": "Solicita\u00e7\u00f5es", "description": "Via requests you can retrieve the results of your short link campaign. Depending on whether you have sent an SMS with simple or advanced tracking, you can determine which phone numbers have clicked how often on the links in your SMS. Through this interface it is possible to find out which recipients or which SMS have scored how well.\n" }, { "name": "click-rate", "x-displayName": "Taxa de cliques", "description": "By using this interface, you will be able to measure the number of clicks of your SMS mailings.\n" }, { "name": "pricelist", "x-displayName": "Lista de pre\u00e7os", "description": "Baixe uma lista de pre\u00e7os para servi\u00e7os SMS no formato XLSX ou CSV. A lista de pre\u00e7os mostra as tarifas Direct e Text2Speech para os n\u00edveis de mensagens S, M, L e XL. Pode especificar um c\u00f3digo de pa\u00eds (por exemplo, DE, CH) ou usar \"all\" para obter todos os pa\u00edses dispon\u00edveis. O endpoint \u00e9 p\u00fablico e n\u00e3o requer autentica\u00e7\u00e3o.\n" }, { "name": "user", "x-displayName": "Usu\u00e1rio", "description": "User is an assistance interface, e.g. to query the account balance or the credit line. This can be helpful to determine if there is still enough credit to send further SMS.\n" }, { "name": "send-link", "x-displayName": "Enviar um link", "description": "### How to send SMS with Short Links\n\nLOX24 allows you to shorten long URLs by replacing them with short URLs using our l24.pw domain.\n\nThis makes it also possible to implement powerful marketing campaigns. Thus, a unique short link can be sent with each SMS. This allows you to **track which of your customers clicked on the link**. With this data, you can interact with customers in a more targeted way or improve your campaigns.\n\nBut that's not all! LOX24 also offers special short links that allow the user to **subscribe or unsubscribe to your SMS newsletters**. This allows you to automate the double opt-in and opt-out in a legally compliant way.\n\n#### How to create a short link campaign\n\nPlease check the chapter [Create a Short Link Campaign](/pt/api/operations/api_short_link_campaigns_post_collection/)\n\n***There are two types of campaigns:***\n\n1. Simple (type = 1). One short link will be used for all SMS. The link is free. The total number of clicks, the click-through rate and other data are collected.\n2. Advanced (type = 2). A unique short link for each SMS will be used. This allows you to determine which recipients have clicked on your link and which have not. The cost of each link is \u20ac0.005.\n\n\n#### How to create a subscribe-link\n\nPlease check the chapter [Create a subscription form campaign](/pt/api/operations/post_subscribe/)\n\nA special type of short link campaign that redirects the user to a subscription form. You also need to add a group id to which the phone numbers of those users who submitted the subscription form will be added.\n\n#### How to create a unsubscribe-links\n\nPlease check the chapter [Create a unsubscription form campaign](/pt/api/operations/post_unsubscribe/)\n\nA special type of short link campaign that redirects the user to an unsubscribe form. You can also add a group id from which to remove the phone numbers of those users who have submitted the unsubscribe form. Even if the group is not listed when unsubscribing, the user's number will be added to the blocked list (see page ).\n\n#### How to send a SMS with a short link\n\nPlease check the chapter [Send the SMS](/pt/api/operations/api_sms_post_collection/) or [Create the Bulk](/pt/api/operations/api_bulks_post_collection/) for the general funtionality.\n\nTo send a SMS with a short link you need to put the following placeholder```[slink campaing_id]``` in the message text, whereby ```campaing_id``` is the value of the campaign-id. You will receive this value as a return value when you create a campaign. Of course, you can also query the value for existing campaigns. For example, this is what your SMS text would look like for a campaign with the ID *eGxoGRMq*:\n\n```\nPlease check a link [slink eGxoGRMq]\n```\n\nOur system replaces the value of the placeholder with the correct link for each SMS recipient. You can also use [SMS dry-run mode](/pt/api/operations/api_sms_post_dryrun_collection/) to check roughly how the text with the link will look like and what the final price of the SMS will be.\n\n#### How to check click count\n\n***(This information is only available for campaigns with Advanced type)***\n\nNumber of clicks on an individual SMS can be found by [SMS id](/pt/api/operations/api_sms_clicks_per_message_get_collection/) or [list](/pt/info/click-rate/) by all SMS.\n\n#### How to get a list of the all short links (by campaign)\n\nYou are able to get a [full list of the short links](/pt/api/operations/api_short_links_get_collection/) which were generated by all your campaigns or [by some campaign](/pt/api/operations/api_short_link_campaigns_short_links_get_item/).\n\n#### How to get a list of user requests by short links\n\nThere are endpoints which provide detalized information about user requests:\n\n- [full requests list](/pt/api/operations/api_short_link_requests_get_collection/)\n- [by SMS](/pt/api/operations/get_sms_requests/)\n- [by Bulk SMS](/pt/api/operations/get_bulk_requests/)\n- [by Short Links Campaign](/pt/api/operations/get_campaign_requests/)\n- [by Short Link](/pt/api/operations/get_short_links_requests/)\n" }, { "name": "fraud-detection", "x-displayName": "API de detec\u00e7\u00e3o de fraude", "description": "O *Fraud Detection API* ajuda a identificar pedidos suspeitos ao seu servi\u00e7o. A API recebe dados de voc\u00ea, tais como o n\u00famero de telefone, e-mail e endere\u00e7o IP de seu cliente em potencial, em conformidade com os regulamentos*** de prote\u00e7\u00e3o de dados v\u00e1lidos na Europa. Nosso sistema os verifica usando bancos de dados, algoritmos e intelig\u00eancia artificial. O API finalmente fornece uma avalia\u00e7\u00e3o da probabilidade ou **risco de fraude***. O risco \u00e9 medido como a probabilidade de fraude **de 0 a 100**, onde `0` representa uma baixa probabilidade de fraude (bom valor de risco) e `100` representa uma probabilidade extremamente alta de fraude (mau valor de risco).\n\nO servi\u00e7o tamb\u00e9m permite que voc\u00ea mesmo verifique cada parte do pedido separadamente, por exemplo, passando apenas os dados telef\u00f4nicos.\n\nAl\u00e9m da pontua\u00e7\u00e3o de risco, a resposta AP de Detec\u00e7\u00e3o de Fraude tamb\u00e9m cont\u00e9m **informa\u00e7\u00f5es adicionais** para ajud\u00e1-lo com sua **avalia\u00e7\u00e3o de risco pr\u00f3pria***:\n- pelo telefone:\n\t- Regi\u00e3o\n\t- tipo de n\u00famero (telefone celular, VoIP, etc.)\n\t- formato v\u00e1lido\n\t- se o n\u00famero \u00e9 de todo poss\u00edvel\n- via e-mail:\n\t- \u00e9 um e-mail poss\u00edvel\n\t- \u00e9 o dom\u00ednio do e-mail especificado suspeito\n- atrav\u00e9s do endere\u00e7o IP\n\t- regi\u00e3o\n\t- estado\n\t- cidade\n\t- c\u00f3digo postal\n\t- Coordenadas geogr\u00e1ficas\n\t- ISP\n\t- Avalia\u00e7\u00e3o de risco do ISP\n\t- Tipo de servidor proxy (se usado)\n\t- Tipo de conex\u00e3o\n- about the address\n - country code (ISO 3166-1 alpha-2)\n - city\n - postal code\n - street name\n - street number\n\nDependendo da tarifa selecionada ('economia', 'pr\u00f3', 'direto'), a resposta e a velocidade de processamento do pedido s\u00e3o diferentes. Os pedidos de economia s\u00e3o adequados para um simples login, por exemplo. Consultas profissionais para o registro de um novo cliente e consultas diretas para a venda de um produto:\n- Economia***\". - a resposta cont\u00e9m apenas o fator de risco, o pedido \u00e9 processado na fila geral.\n- **pro***''. - a resposta cont\u00e9m todos os dados detalhados e o pedido \u00e9 processado na fila geral\n- **direct***' a resposta cont\u00e9m - a resposta cont\u00e9m todos os dados detalhados e o pedido \u00e9 processado em uma fila separada com **prioridade maior***.\n\n\nComo a pontua\u00e7\u00e3o leva algum tempo, a solicita\u00e7\u00e3o \u00e9 processada em modo ass\u00edncrono e, ap\u00f3s o processamento, o servi\u00e7o envia os dados da solicita\u00e7\u00e3o de volta no formato JSON para a URL HTTP ou e-mail que voc\u00ea especificou. Voc\u00ea pode definir este valor na conta web em Configura\u00e7\u00f5es e Notifica\u00e7\u00f5es (**Notifica\u00e7\u00f5es de Evento**).\nVoc\u00ea tamb\u00e9m pode verificar o status da solicita\u00e7\u00e3o atrav\u00e9s de sua identifica\u00e7\u00e3o enviando uma solicita\u00e7\u00e3o para o API. Entretanto, recomendamos fortemente que voc\u00ea utilize o sistema de notifica\u00e7\u00e3o (webhook), pois o servi\u00e7o pode bloquear suas solicita\u00e7\u00f5es se houver um grande n\u00famero de solicita\u00e7\u00f5es de voc\u00ea.\n" }, { "name": "collection-filters", "x-displayName": "Filtros de cole\u00e7\u00e3o", "description": "LOX24 API provides a generic system to apply filters and sort criteria on \ncollections. You can see which filters you can use in the property description.\n \n### Search filter\n\nThe API uses two types of the text filters:\n\n- ***partial*** strategy uses provided text to search for fields that \ncontain part of that text\n- ***exact*** strategy uses uses provided text to search for fields \nthat contain exactly that text\n\n**Note**: Search filters with the exact strategy can have multiple values \nfor the same property (in this case the condition will be similar to a SQL IN clause).\n\n#### Usage examples\n\nFind sms which `phone` property contains *\"4979\"* and `text` property \ncontains *\"hello\":\n\n```\ncurl -X GET https://api.lox24.eu/sms?phone=4979&text=hello \\\n -H 'Host: api.lox24.eu' \\\n -H 'X-LOX24-AUTH-TOKEN: e3f3a759b6677959b6ebfcxxxxxxxxxx' \\\n -H 'X-LOX24-CLIENT-ID: 1234567' \n```\n\nFind sms with country `iso2` property equal 'DE' OR 'CH' and `status_code` = 0\n\n```\ncurl -X GET https://api.lox24.eu/sms?iso2[]=DE&iso2[]=CH&status_code=0 \\\n -H 'Host: api.lox24.eu' \\\n -H 'X-LOX24-AUTH-TOKEN: e3f3a759b6677959b6ebfcxxxxxxxxxx' \\\n -H 'X-LOX24-CLIENT-ID: 1234567' \n```\n\n### Boolean filter\n\nThe boolean filter allows to search on boolean fields and values.\n\n**Syntax**: ?property=\n\nGet sms which wasn't sent to the mobile operator yet: \n```\ncurl -X GET https://api.lox24.eu/sms?sent=0 \\\n -H 'Host: api.lox24.eu' \\\n -H 'X-LOX24-AUTH-TOKEN: e3f3a759b6677959b6ebfcxxxxxxxxxx' \\\n -H 'X-LOX24-CLIENT-ID: 1234567' \n```\n\n### Exists filter\n\nThe exists filter allows to select items based on a nullable field value\n\n**Syntax**: ?exists[property]=\n\nGet bulks which has property `is_unicode=null` (sms encoding auto-detection):\n```\ncurl -X GET https://api.lox24.eu/bulks?exists[is_unicode]=0 \\\n -H 'Host: api.lox24.eu' \\\n -H 'X-LOX24-AUTH-TOKEN: e3f3a759b6677959b6ebfcxxxxxxxxxx' \\\n -H 'X-LOX24-CLIENT-ID: 1234567'\n```\n\n\n### Range Filter\n\nThe range filter allows to filter by a value lower than, greater than, \nlower than or equal, greater than or equal and between two values.\n\n**Syntax**: ?property[]=value\n\n#### Usage examples\n\nFilter sms collection by the field `created_at` between 1575158400 (2019-12-01)\nand 1575676800 (2019-12-07): \n```\ncurl -X GET https://api.lox24.eu/sms?created_at[between]=1575158400..1575676800 \\\n -H 'Host: api.lox24.eu' \\\n -H 'X-LOX24-AUTH-TOKEN: e3f3a759b6677959b6ebfcxxxxxxxxxx' \\\n -H 'X-LOX24-CLIENT-ID: 1234567' \n```\n\n\n\n### Order Filter (Sorting)\n\nThe order filter allows you to sort a collection against the given properties.\nOrder parameter `_order`.\n\n#### Usage examples\n\nSort sms collection by the field 'created_at' in descending order: \n```\ncurl -X GET https://api.lox24.eu/sms?_order[created_at]=desc \\\n -H 'Host: api.lox24.eu' \\\n -H 'X-LOX24-AUTH-TOKEN: e3f3a759b6677959b6ebfcxxxxxxxxxx' \\\n -H 'X-LOX24-CLIENT-ID: 1234567' \n```\n" }, { "name": "sms-status-codes", "x-displayName": "C\u00f3digos de status SMS", "description": "Description of the sms status codes (property `status_code`):\n\n|Status code|Description|\n|---|---|\n|0|New just created message|\n|100|Message was successfuly transmitted to the mobile operator|\n|208|The destination network/country is blocked|\n|400|The message could not be delivered during maintenance|\n|410|The message was stopped before transmission via web account|\n|2000|No connection to landline possible at the moment|\n|3000|Not enough money on the user balance to send the message|\n|5000|No mobile operator found for this message|\n|6000|The message was stopped before transmission via API|\n" }, { "name": "sms-delivery-report-codes-dlr", "x-displayName": "C\u00f3digos de relat\u00f3rio de entrega SMS (DLR)", "description": "Each SMS has delivery report code (DLR). There are three ways to get DLR code and additional info info:\n1. pull data from API endpoint [`GET /sms/{id}`](/pt/api/operations/api_sms_get_item/) (id - SMS id) and check property `dlr_code`\n2. set-up service send HTTP GET requests (webhook) to yours endpoint (please check account page Settings -> API settings). Data sends as URL parameters. On an endpoint's response with HTTP status code < `200` or >= `300` service will do additional attempts (only per DLR code `DELIVERY_OK`) but maximum four. \n3. set-up service to send emails about SMS DLR status to yours email address (please check account page Settings -> API settings). Data sends as JSON object in email body.\n\n**NOTE**: The answer of your script is not taken into account therefore you have to monitor your script. In the case of malfunctions there is no notification by us.\n\n\n### DLR report properties\n\n|Property|Type|Description|\n|---|---|---|\n|uuid|UUID|SMS id|\n|dlr_code|integer|DLR status code|\n|key_id|integer|API key id used to sent request to API|\n|phone|string|Recipinet phone number from SMS (in DLR by email only)|\n|callback_data|string|String which posted to `POST /sms` in property `callback_data` or if sms was send by `POST /bulks` as Phone's property `callback_data` |\n\n### Description of the delivery report status codes (property `dlr_code`):\n\n|Status code|Description|\n|---|---|\n|0|NONE: There is no delivery report available|\n|1|DELIVERY_OK: The message was successfully delivered|\n|2|DELIVERY_QUEUE: The message is scheduled for later sending|\n|4|DELIVERY_SUBMIT_ACK: The message is enroute|\n|8|DELIVERY_EXPIRED: The SMSC was unable to deliver the message in a specified amount of time. For instance when the phone was turned off|\n|16|DELIVERY_REJECTED: The message was rejected. The provider could have blocked phone numbers in this range|\n" }, { "name": "encoding-and-number-of-characters", "x-displayName": "Encoding and count of characters", "description": "Generally, the SMS text has to be transfered with UTF-8 encoding \n(and possibly urlencoded) to the gateway. You have the option to use \nthe parameter \"encoding\" to decide if you want to send a normal 7 bit \nor UCS-2 SMS.\n\n#### GSM 7 bit Standard-Alphabet (GSM 03.38)\nThe basic character set contains all characters that can be transmitted with a normal 7 bit SMS. Each of this characters counts as 1 character. The extended character set can also be transferred, but requires 2 characters for transmission. SMS which contain more than 160 characters are delivered to the handset as multiple SMS, each with 153 characters, and concatenated by the phone to one message.\n\n**Basic Character Set**\n\n||0x00|0x10|0x20|0x30|0x40|0x50|0x60|0x70|\n|---|---|---|---|---|---|---|---|---|\n|0x00|@|\u0394|SP|0|\u00a1|P|\u00bf|p|\n|0x01|\u00a3|_|!|1|A|Q|a|q|\n|0x02|$|\u03a6|\"|2|B|R|b|r|\n|0x03|\u00a5|\u0393|#|3|C|S|c|s|\n|0x04|\u00e8|\u039b|\u00a4|4|D|T|d|t|\n|0x05|\u00e9|\u03a9|%|5|E|U|e|u|\n|0x06|\u00f9|\u03a0|&|6|F|V|f|v|\n|0x07|\u00ec|\u03a8|'|7|G|W|g|w|\n|0x08|\u00f2|\u03a3|(|8|H|X|h|x|\n|0x09|\u00c7|\u0398|)|9|I|Y|i|y|\n|0x0A|LF|\u039e|*|:|J|Z|j|z|\n|0x0B|\u00d8|ESC|+|;|K|\u00c4|k|\u00e4|\n|0x0C|\u00f8|\u00c6|,|<|L|\u00d6|l|\u00f6|\n|0x0D|CR|\u00e6|-|=|M|\u00d1|m|\u00f1|\n|0x0E|\u00c5|\u00df|.|>|N|\u00dc|n|\u00fc|\n|0x0F|\u00e5|\u00c9|/|?|O|\u00a7|o|\u00e0|\n\n- LF is a Line Feed control.\n- CR is a Carriage Return control, or filler.\n- ESC is an Escape control.\n- SP is a Space character.\n\n\n**Basic Character Set Extension**\n\n||0x00|0x10|0x20|0x30|0x40|0x50|0x60|0x70|\n|---|---|---|---|---|---|---|---|---|\n|0x00| | | | ||| | | \n|0x01| | | | | | | | |\n|0x02| | | | | | | | |\n|0x03| | | | | | | | |\n|0x04| |^| | | | | | |\n|0x05| | | | | | |\u20ac| |\n|0x06| | | | | | | | |\n|0x07| | | | | | | | |\n|0x08| | |{| | | | | |\n|0x09| | |}| | | | | |\n|0x0A|FF| | | | | | | |\n|0x0B| |SS2| | | | | | |\n|0x0C| | | |[| | | | |\n|0x0D|CR2| | |~| | | | |\n|0x0E| | | |]| | | | |\n|0x0F| | |\\| | | | | ||\n\n- FF is a Page Break control. If not recognized, it shall be treated like LF.\n- CR2 is a control character. No language specific character shall be \nencoded at this position.\n- SS2 is a second Single Shift Escape control reserved for future extensions.\n\n#### UCS-2 (Unicode SMS)\nWith UCS-2 it is possible to transmit 1,112,064 characters. These characters \nrepresent nearly every spoken language. Each character counts as 1 character, \nbut Unicode SMS can only consist of 70 characters, or consist of multiple \nconcatenated SMS, each with 67 characters.\n\n#### Concatenated SMS\nFor technical reasons, with one sms only 160 characters of text (70 \ncharacters Unicode text) can be transferred. If you send an SMS with \nmore characters, then you send a so-called concatenated SMS. Overlong \ntext messages / Multi-SMS (concatenated SMS, Long SMS) are part messages \nand transmitted separately. Each part is a separate text message. The \nreceiver converts the parts again into a coherent text. To determine \nthat the message is a concatenated message and which part belongs to \nwhich part 7 characters (or 3 in Unicode) of the available characters \nare needed. This is the reason why one part of an overlong SMS can only \nconsist 153 characters (or 67 for Unicode) of your text. The maximum is \n1530 characters with one concatenated message (or 670 characters for \nUnicode).\n\n" }, { "name": "kannel", "x-displayName": "Kannel API (emulation)", "description": "# Intro\n\nThis is a guide to set up and connect our SMS API to your Kannel client.\n\nIf you use Kannel to route messages to different SMS gateways you can\neasily add an additional SMSC module without changing your application\narchitecture.\n\nSupport: [berlin@lox24.eu](mailto:berlin@lox24.eu)\n\n# API Key\n\nTo send messages with Kannel you need to create an authentication key on\nthe [*account page*](https://account.lox24.eu) with the type \\'Kannel\nAPI\\'. Please go to \"*Settings*\" -> \"*API-Settings*\" and click on \"*Create new\nkey*\". You have to choose as type \"*Kannel API*\".\n\n![Account page an API key](/images/kannel/kannel-api-auth-key.png)\n\n# Config\n\nThere are two types of SMSC configurations possible to send SMS with\nLOX24 via Kannel:\n\n- sending DLR requests to your endpoint\n- sending DLR requests to your Kannel SMSC module, which in turn sends\n a DLR request to your endpoint (DLR URL chaining)\n\n**Note**: What's about a DLR request you can read here:\n\n- [Official Kannel's documentation](https://www.kannel.com/download/1.4.5/userguide-1.4.5/userguide.html#delivery-reports)\n- [LOX24 DLR documentation](/pt/info/kannel/sms-delivery-report-codes-dlr/)\n\n\n## Sending DLR requests to your endpoint\n\nLOX24 API will send delivery reports directly back to your endpoint\nwithout bypassing Kannel.\n\n![](/images/kannel/kannel_api_dlr.png)\n\nTo use the Kannel API just create a new SMSC config:\n\n ```\n group = smsc\n smsc = http\n system-type = kannel\n smsc-id = \"lox24\"\n allowed-smsc-id = \"lox24\"\n port = 10443\n send-url = \"https://lox24.eu/api/kannel/{SERVICE_CODE}.php\"\n smsc-username = \"{USER_ID}\"\n smsc-password = \"{API_KEY}\"\n max-sms-octets = 1530\n ```\n\n**Where**:\n\n- *SERVICE_CODE* - any available for your account service code in lower\n case, e.g. '*text2speech*', '*direct*' and etc.\n- *USER_ID* - your account ID, same as the client ID used to login at\n account.lox24.eu\n- *API_KEY* - an active API token with type '*API Kannel*'. How to create it\n see [*here*](/pt/info/kannel/kannel/#api-key).\n\n## DLR URL chaining\n\nWe will send delivery reports back to Kannel which will then send DLRs\nback to your endpoint.\n\n![](/images/kannel/kannel_api_dlr_chaining.png)\n\nTo use the Kannel API just create a new SMSC config:\n\n```\n group = smsc\n smsc = http\n system-type = kannel\n smsc-id = \"lox24\"\n allowed-smsc-id = \"lox24\"\n port = 10443\n send-url = \"https://lox24.eu/api/kannel/{SERVICE_CODE}.php\"\n smsc-username = \"{USER_ID}\"\n smsc-password = \"{API_KEY}\"\n dlr-url = \"http://youhosthere.com:10443/?username={USER_ID}&password={API_KEY}\"\n connect-allow-ip = \"127.0.0.1;213.133.127.70;116.203.64.153;85.10.245.*\"\n max-sms-octets = 1530\n```\n\n\n**Where**:\n\n- *SERVICE_CODE* - any available for your account service code in lower\n case, e.g. '*text2speech*', '*direct*' and etc.\n- *USER_ID* - your account ID, same as the client ID used to login at\n account.lox24.eu\n- *API_KEY* - an active API token with type '*API Kannel*'. How to create it\n see [*here*](/pt/info/kannel/kannel/#api-key).\n\n## Additional notes\n\n### No DLR, but LOX24 notifications\n\nIf you set-up API v2 Status URL/E-mail in the lox24 web-account you are\nable to skip parameter `dlr-url` and get messages notifications in same\nway as if you sent SMS by our normal API v2 directly to a script on your\nserver or by mail [*docs*](/pt/info/kannel/sms-delivery-report-codes-dlr/)\n\n![](/images/kannel/kannel_api_status_endpoint.png)\n\n### SMSC port\n\nIn the SMSC config samples are using port 10443, but it can be any port\nwhich you like. We are highly recommend blocking it by the firewall and\nallow TCP connections from LOX24 servers\n(116.203.64.153,213.133.127.70,85.10.245.\\*) and well-known hosts.\n\n## Supported DLR variables\n\nLOX24 Kannel API is a minimal Kannel implementation and does support\nonly the following variables:\n\n- ***%d*** - Kannel report type (integer):\n - 1: Delivered to phone\n - 2: Non-Delivered to Phone\n - 4: Queued on SMSC\n - 8: Delivered to SMSC\n - 16: Non-Delivered to SMSC\n\n- ***%q*** - The international phone number (E.164), who will receive\n the message.\n\n- ***%T*** - The time of the delivery report expressed as seconds\n since UNIX epoch.\n\n**Note:** You can use any other variables, but we can\\'t guarantee the\ncorrectness of the data.\n\n# Parameters\n\n## from\n\n*(required)*\n\nSender-ID of the message. Can be a number (up to 15 digits) or a text\n(up to 11 character). In case of a number please use preferentially\nE.164 phone number format. A sender of text may contain spaces but no\nother special characters. Please note that some countries do not support\nown sender IDs or do require pre-registration. Our system automatically\ntries to detect whether a sender ID is a text or a phone number. Avoid\nspecial characters in a number and enter it the same way as it would be\ndialed on a phone.\n\n## to\n\n*(required)*\n\nRecipient (international) number\n\n## text\n\n*(required)*\n\nThe message text can have a length of up to 1530 characters. With a\nUnicode SMS, the maximum character length is reduced to 670 characters.\nInternal encoding is UTF-8.\n\n## coding\n\n*(optional)*\n\nYou can send a SMS with parameter '*coding*':\n\n0 - GSM 03.38 (default),\n1 - 8-bit or\n2 - UCS-2 encoding.\n\n*In our case 8-bit and UCS-2 are the same (is\\_unicode = true) and will\nbe handled as unicode SMS.*\n\n## dlr-url\n\n*(optional)*\n\nSpecify an URL and have us call it with delivery status reports. If\nparameter 'dlr-url' is missed then will be using *API v2 DLR\nendpoint from user's settings* (if\nthem set).\n\n## deferred\n\n*(optional)*\n\nIf given, the SMS center will postpone the message to be delivered at\nnow plus this amount of minutes. If skipped then SMS will send ASAP.\n\n## Example of request\n\nThat example of get request which user sends to **his** Kannel smsbox\nwhich is listen on port 9001.\n\n[*http://127.0.0.1:9001/cgi-bin/sendsms?dlr-url=http://yourhost.com/dlr_test.php?status=%d%26time=%T%26q=%q%26customid=1234567&from=sender&password=test1&smsc=lox24&text=test%20message&to=+49751234567&username=test1&coding=0*](http://127.0.0.1:9001/cgi-bin/sendsms?dlr-url=http://yourhost.com/dlr_test.php?status=%d%26time=%T%26q=%q%26customid=1234567&from=sender&password=test1&smsc=lox24&text=test%20message&to=+49751234567&username=test1&coding=0)\n\n### Advice\nAdd to a DLR url custom parameter with internal message ID for proper DLR\nrequest processing. In our example that's a `customid` = 1234567.\n" }, { "name": "notifications", "x-displayName": "Notifica\u00e7\u00f5es", "description": "### Notifica\u00e7\u00f5es\n\nO sistema de mensagens de eventos foi criado como substituto do sistema obsoleto de notifica\u00e7\u00e3o de status de entrega de SMS de sa\u00edda e entrada (esses sistemas s\u00e3o considerados obsoletos, n\u00e3o ser\u00e3o melhorados e n\u00e3o s\u00e3o recomendados para uso).\n\nO sistema de mensagens de eventos permite que voc\u00ea envie informa\u00e7\u00f5es sobre eventos espec\u00edficos para URIs especificadas (http ou email). Voc\u00ea pode personalizar o sistema para enviar notifica\u00e7\u00f5es de um evento para diferentes URIs.\n\nPara configurar as notifica\u00e7\u00f5es, abra a p\u00e1gina de configura\u00e7\u00f5es (account.lox24.eu -> Configura\u00e7\u00f5es -> Notifica\u00e7\u00f5es), clique em \"Criar um novo webhook\" e insira no campo URI o endere\u00e7o http ou e-mail para o qual voc\u00ea deseja receber notifica\u00e7\u00f5es. Por padr\u00e3o, todos os eventos poss\u00edveis ser\u00e3o enviados para a URI especificada. Se voc\u00ea quiser ser notificado apenas sobre certos eventos, marque a caixa ao lado dos eventos sobre os quais deseja ser notificado.\n\nSe forem necess\u00e1rias notifica\u00e7\u00f5es adicionais, repita as instru\u00e7\u00f5es acima. Um m\u00e1ximo de cinco configura\u00e7\u00f5es individuais de notifica\u00e7\u00e3o podem ser criadas.\n\nAs informa\u00e7\u00f5es do evento ser\u00e3o notificadas no formato de objeto JSON, que tem o mesmo formato para todos os eventos e difere apenas nos dados do pr\u00f3prio evento.\n\n#### Estrutura do objeto de evento\n\n| Campo | Tipo | Descri\u00e7\u00e3o |\n|-----------------------|--------------------|-------------------------------------------|\n| id | string (36 chars) | ID do evento |\n| api_version | string | Vers\u00e3o da estrutura de dados |\n| name | string | Nome do evento, ex. 'sms.delivery' |\n| created_at | integer | Timestamp unix quando o evento foi criado |\n| attempt_total | integer | N\u00famero total de tentativas (re-tentativas)|\n| attempt_number | integer | N\u00famero atual da tentativa | |\n| data | object | Dados do evento (veja lista de eventos) |\n| notification_task_id | string (36 chars) | ID da tarefa de notifica\u00e7\u00e3o (identificador da solicita\u00e7\u00e3o) |\n\n\n##### Exemplo de evento\n\n```json\n{\n \"id\": \"a3cd6e19-8af2-498d-ad07-c7840f1b4ac8\",\n \"data\": {\n\t\"id\": \"d6c12ac4-cc7d-11ec-b6da-525400bbb7dc\",\n\t\"key_id\": 8207,\n\t\"dlr_code\": 1,\n\t\"status_code\": 100,\n\t\"callback_data\": \"some data from user's request here\"\n },\n \"name\": \"sms.delivery\",\n \"created_at\": 1653378603,\n \"api_version\": \"2022-05-25\",\n \"attempt_number\": 1,\n \"attempts_total\": 4,\n \"notification_task_id\": \"3378de83-de66-4de8-9d29-2b10d41bb641\"\n}\n```\n\n#### Tipos de transporte de eventos\n\nO sistema de notifica\u00e7\u00e3o pode enviar informa\u00e7\u00f5es de eventos de duas maneiras (transportes): HTTP e E-mail.\n\n##### HTTP\n\nO json \u00e9 enviado como o corpo da requisi\u00e7\u00e3o http com o cabe\u00e7alho ```Content-Type: application/json```.\nO servi\u00e7o continuar\u00e1 tentando enviar a requisi\u00e7\u00e3o (em intervalos de tempo crescentes) at\u00e9 que receba uma resposta com um c\u00f3digo de status >= 200 e < 300 ou o n\u00famero de tentativas atinja o valor especificado no campo `attempt_number`.\n\n**NOTA**: A resposta do seu script de endpoint n\u00e3o \u00e9 levada em considera\u00e7\u00e3o, portanto, voc\u00ea deve monitorar seu script. Em caso de mau funcionamento, n\u00e3o h\u00e1 notifica\u00e7\u00e3o por nossa parte.\n\n##### E-mail\n\nO json \u00e9 enviado como o corpo do e-mail com uma \u00fanica tentativa de um e-mail `no-reply@lox24.eu`.\n\n##### Hosts de servi\u00e7o e endere\u00e7os IP\n\nOs alertas s\u00e3o enviados dos seguintes endere\u00e7os IP. Se voc\u00ea usar um firewall, n\u00e3o se esque\u00e7a de colocar esses endere\u00e7os IP na lista de permiss\u00f5es.\n\nIPv4:\n- `162.55.80.140`\n- `162.55.80.141`\n- `5.9.114.27`\n- `144.76.190.20`\n\nIPv6:\n- `2a01:4f8:271:10a7::2`\n- `2a01:4f8:271:10a6::2`\n\n#### Lista de eventos\n\n- [sms.delivery](/pt/api/webhooks/webhookssms-delivery-webhook/)\n- [sms.delivery.dryrun](/pt/api/webhooks/webhookssms-delivery-dryrun-webhook/)\n- [sms.incoming](/pt/api/webhooks/smsincomingwebhook/)\n- [sms.email.parsing.success](/pt/api/webhooks/webhookssms-email-parsing-success/)\n- [sms.email.parsing.fail](/pt/api/webhooks/webhookssms-email-parsing-fail/)\n- [bulk.email.parsing.success](/pt/api/webhooks/bulkemailparsingsuccesswebhook/)\n- [bulk.email.parsing.fail](/pt/api/webhooks/bulkemailparsingfailwebhook/)\n- [fraud-check.done](/pt/api/webhooks/fraudcheckdonewebhook/)" }, { "name": "inbound-and-reply-sms", "x-displayName": "SMS de entrada e SMS de resposta", "description": "### Inbound SMS and Reply-SMS:\n\nYou can get incoming SMS (mobile originated - SMS-MO) sent by a webhook to your web server. To receive incoming SMS you need to send Economy SMS to Germany OR you can order an [inbound phone number](https://www.lox24.eu/en/sms-products/inbound-sms-mo-api/) by request to the support ([berlin@lox24.eu](mailto:berlin@lox24.eu). \n\nPush service means that our gateway sends HTTP requests with data to a script on your host. On response with HTTP status code < `200` or >= `300`, service will do additional attempts but maximum three. The response of your script is not taken into account, so you need to monitor your script. In case of malfunctions we will not notify you. You can enter the URL for all push services in your LOX24 web account page (Settings -> API settings). Alternatively, you can also receive info about incoming SMS by e-mail.\n\nInbound SMS are sent as HTTP GET with the parameters `sender_id` for the sender's phone number, `text` for the message text and `time` as time when message was sent in Unix timestamp format. For reply SMS to Economy SMS you also receive `uuid` as assignment to the initial SMS. For an inbound phone number, `phone` contains inbound (receiver) phone number and `id` contains the ID of the incoming SMS.\n\nInbound SMS by mail contains a JSON object with the same parameters.\n\n| Parameter |Type |Description|\n|-----------|---------|-----------|\n| id | integer |Inbound SMS identifier (not for Economy reply SMS) |\n| phone | string |Inbound phone number (not for Economy reply SMS) |\n| sender_id | string |Sender's phone number of the incoming SMS |\n| text | string |Message text |\n| time | integer |Time at which the SMS was received by LOX24 |\n| uuid | UUID |ID of the message that a reply has come (only for Economy reply SMS) |\n" }, { "name": "ssml-language-detection", "x-displayName": "SSML e dete\u00e7\u00e3o de linguagem", "description": "### ID do remetente para mensagens de voz\n\nPara mensagens de voz (`text2speech` e `text2speech_ssml`), o campo `sender_id` controla o identificador de chamada exibido aos destinat\u00e1rios. Se especificar um valor sender_id que n\u00e3o est\u00e1 em conformidade com o formato de n\u00famero de telefone E.164 (por exemplo, sem o prefixo `+`, contendo caracteres n\u00e3o num\u00e9ricos), a mensagem ser\u00e1 enviada a partir do n\u00famero padr\u00e3o do sistema `+493075435114`.\n\n> \u26a0\ufe0f Alguns provedores de telefonia downstream podem substituir ou n\u00e3o respeitar o n\u00famero de remetente definido pelo usu\u00e1rio, independentemente de passar na verifica\u00e7\u00e3o E.164. O identificador de chamada real apresentado ao destinat\u00e1rio depende das capacidades do provedor.\n\n### Voice language detection\n\nQuando `voice_lang` \u00e9 nulo, o sistema detecta automaticamente o idioma da voz a partir do conte\u00fado da mensagem utilizando a biblioteca `patrickschur/language-detection`.\n\nL\u00ednguas suportadas: ingl\u00eas (`EN`), alem\u00e3o (`DE`), franc\u00eas (`FR`), italiano (`IT`), espanhol (`ES`), polaco (`PL`), holand\u00eas (`NL`), romeno (`RO`), portugu\u00eas (`PT`), checo (`CS`), h\u00fangaro (`HU`), sueco (`SV`), dinamarqu\u00eas (`DA`), finland\u00eas (`FI`), eslovaco (`SK`), croata (`HR`), turco (`TR`), russo (`RU`), b\u00falgaro (`BG`), ucraniano (`Reino Unido`).\n\n### SSML Support\n\nThe API now supports a subset of [SSML (Speech Synthesis Markup Language)](https://en.wikipedia.org/wiki/Speech_Synthesis_Markup_Language) for advanced voice message formatting.\n\n#### Supported Features\n\n##### Available Tags\n- `` - Insert pauses in speech\n- `` - Control pronunciation of text\n\n#### Tag Specifications\n\n##### `` Tag\n- **Purpose**: Add pauses between words or sentences\n- **Attributes**: `time` (e.g., \"1s\", \"500ms\")\n- **Pre\u00e7os**: <0,5ms = 1 char, <1s = 2 chars, <1,5s = 3 chars, etc.\n\n##### `` Tag\n- **Purpose**: Control how text is interpreted and spoken\n- **Supported Attributes**:\n - `interpret-as=\"characters\"` - Spell out text character by character\n- **Note**: Currently only \"characters\" value is supported\n\n#### Usage\n\nWrap your message content with the `` root element:\n\n```xml\n\n Your verification code is A1B2C3.\n \n Please enter it now.\n\n" }, { "name": "email-to-sms", "x-displayName": "Email to SMS", "description": "### Sending SMS via Email\n\nYou can send SMS messages via email in two different ways: sending a single SMS to a specific phone number, or sending an SMS to a group of phone numbers.\n\n#### Sending a Single SMS\n\nTo send a single SMS, the email should be formatted as follows:\n\n```\n{{user_id}}.{{api_key}}.{{phone}}.{{service_code}}.{{sender_id}}.{{text_source}}.{{encoding}}.{{max_sms_parts}}@mail2sms.lox24.eu\n```\n\n#### Sending to Multiple Phone Numbers (Group SMS)\n\nTo send an SMS to phone numbers from a specific group, use the following format:\n\n```\n{{user_id}}.{{api_key}}.{{group_id}}.{{service_code}}.{{sender_id}}.{{text_source}}.{{encoding}}.{{max_sms_parts}}@email2bulk.lox24.eu\n```\n\n##### Parameters:\n\n| Order | Label | Description |\n|-------|---------------|-------------------------------------------------------------------------------------------------------------------------------------------------|\n| 1 | user_id | User Id (integer) |\n| 2 | api_key | \"Email2SMS\" API key from the API Key settings page (\"Settings\" -> \"API Settings\") |\n| 3 | phone/group_id| For single SMS, this is the phone number in E.164 format without leading \"+\". For group SMS, this is the Group Id you can find in your web-account or request by API |\n| 4 | service_code | Service code 'text2speech', 'direct' (default) |\n| 5 | sender_id | Sender Id: an integer from 1 to 6 (default 1). If sender id wasn't found, then the default value is 'email2sms'. |\n| 6 | text_source | Text source: 0 - subject + body (by default), 1 - subject, 2 - body |\n| 7 | encoding | An integer: 0 - normal GSM (default), 1 - unicode, 2 - auto-detecting (by the whole text from request) |\n| 8 | max_sms_parts | An integer between 1 and 10. Default value is 1. There's a limit to the length of text when parsing the email. Extra characters are used for concatenation in messages longer than the standard limits. |\n\n#### Email Addresses Examples\n\n##### Group SMS Examples\n\n**Send SMS to phones by a group id = 12345 (minimum parameters)**\n\n```\n1234567.e3f3a759b6677959b6ebfcxxxxxxxxxx.12345@email2bulk.lox24.eu\n```\n\n**Send SMS to phones by a group id = 12345 with service 'direct'**\n\n```\n1234567.e3f3a759b6677959b6ebfcxxxxxxxxxx.12345.direct@email2bulk.lox24.eu\n```\n\n**Send SMS to phones by a group id = 12345 with service 'direct' and with sender id = 2**\n\n```\n1234567.e3f3a759b6677959b6ebfcxxxxxxxxxx.12345.direct.2@email2bulk.lox24.eu\n```\n\n**Send SMS to phones by a group id = 12345 with service 'direct', with sender id = 2, and text from email's subject**\n\n```\n1234567.e3f3a759b6677959b6ebfcxxxxxxxxxx.12345.direct.2.1@email2bulk.lox24.eu\n```\n\n**Send SMS to phones by a group id = 12345 with service 'direct', with sender id = 2, with text from email's subject, and encoding auto-detection**\n\n```\n1234567.e3f3a759b6677959b6ebfcxxxxxxxxxx.12345.direct.2.1.2@email2bulk.lox24.eu\n```\n\n##### Single SMS Examples\n\n**Send SMS to a single phone number \"+1234567890\" (minimum parameters)**\n\n```\n1234567.e3f3a759b6677959b6ebfcxxxxxxxxxx.1234567890@mail2sms.lox24.eu\n```\n\n**Send SMS to a single phone number \"+1234567890\" with service 'direct'**\n\n```\n1234567.e3f3a759b6677959b6ebfcxxxxxxxxxx.1234567890.direct@mail2sms.lox24.eu\n```\n\n**Send SMS to a single phone number \"+1234567890\" with service 'direct' and sender id = 2**\n\n```\n1234567.e3f3a759b6677959b6ebfcxxxxxxxxxx.1234567890.direct.2@mail2sms.lox24.eu\n```\n\n**Send SMS to a single phone number \"+1234567890\" with service 'direct', with sender id = 2, and text from email's subject**\n\n```\n1234567.e3f3a759b6677959b6ebfcxxxxxxxxxx.1234567890.direct.2.1@mail2sms.lox24.eu\n```\n\n**Send SMS to a single phone number \"+1234567890\" with service 'direct', with sender id = 2, with text from email's subject, and encoding auto-detection**\n\n```\n1234567.e3f3a759b6677959b6ebfcxxxxxxxxxx.1234567890.direct.2.1.2@mail2sms.lox24.eu\n```\n\n#### Replies about errors\n\n\nMost errors are ignored to reduce unwanted flooding, including authentication-related errors. But for some errors, the system sends a JSON response with an error description.\n\n**Error JSON**\n\n| Property | Description |\n|-------------|---------------------------------------------|\n| field | Error field in request |\n| description | Error description |\n| request | EMail address to which the request was sent |\n\n##### Example\n{\"field\":\"group_id\",\"description\":\"Group with id = 12345 was not found!\",\"request\":\"1234567.e3f3a759b6677959b6ebfcxxxxxxxxxx.12345.direct@email2bulk.lox24.eu\"}\n\n#### Email Forwarding Warning\n\nPlease note that the mail gateway does not work with email forwarding. The email must be sent directly to the Mail2SMS gateway mailbox." }, { "name": "verify-codes", "x-displayName": "C\u00f3digos de verifica\u00e7\u00e3o", "description": "O endpoint de c\u00f3digos de verifica\u00e7\u00e3o permite enviar **c\u00f3digos de verifica\u00e7\u00e3o de uso \u00fanico (OTP)** para n\u00fameros de telefone atrav\u00e9s de m\u00faltiplos canais de entrega. Suporta uma **estrat\u00e9gia de roteamento em v\u00e1rias etapas** com fallback autom\u00e1tico \u2014 se um canal falhar ou expirar, o pr\u00f3ximo canal \u00e9 tentado automaticamente.\n\n- Criar um pedido de c\u00f3digo de verifica\u00e7\u00e3o com uma estrat\u00e9gia de roteamento flex\u00edvel\n- Suporte para canais de entrega **Telegram**, **Voz (texto para fala)** e **SMS**\n- Fallback autom\u00e1tico entre canais em caso de falha ou tempo limite\n- Consultar o estado do c\u00f3digo de verifica\u00e7\u00e3o, hist\u00f3rico de entrega e informa\u00e7\u00f5es de custo\n- Eliminar c\u00f3digos de verifica\u00e7\u00e3o do armazenamento ap\u00f3s a entrega por seguran\u00e7a\n\n### Como funciona\n\nAo criar um pedido de c\u00f3digo de verifica\u00e7\u00e3o, define uma **estrat\u00e9gia de roteamento** \u2014 uma lista ordenada de canais de entrega a tentar. O sistema processa cada canal por ordem:\n\n1. Envia o c\u00f3digo de verifica\u00e7\u00e3o atrav\u00e9s do primeiro canal (ex. Telegram).\n2. **Telegram**: aguarda uma confirma\u00e7\u00e3o de entrega da API do Telegram dentro de `timeout_sec`. **Voz**: faz uma tentativa de chamada; o sucesso ocorre se o destinat\u00e1rio atender. **SMS**: \u00e9 considerado bem-sucedido assim que a mensagem \u00e9 aceite pela rede m\u00f3vel.\n3. Se o canal falhar ou expirar, recua automaticamente para o pr\u00f3ximo canal.\n4. Repete at\u00e9 que um canal seja bem-sucedido ou todos os canais sejam esgotados.\n\n### Estrat\u00e9gia de roteamento\n\nCada etapa na estrat\u00e9gia de roteamento especifica um `channel` e par\u00e2metros opcionais. Todos os par\u00e2metros exceto `channel` s\u00e3o opcionais \u2014 valores padr\u00e3o sensatos s\u00e3o usados quando omitidos.\n\n| Canal | Par\u00e2metros | Crit\u00e9rio de sucesso | Notas |\n|---------|-----------|---------------------|-------|\n| `telegram` | `timeout_sec` | Confirma\u00e7\u00e3o de entrega recebida do Telegram dentro de `timeout_sec` | `timeout_sec`: m\u00edn 30, m\u00e1x 3600, padr\u00e3o 30. |\n| `voice` | `sender_id`, `template` | O destinat\u00e1rio atendeu \u00e0 chamada | Chamada de texto para fala. Apenas **uma tentativa de chamada** \u00e9 feita. O modelo \u00e9 automaticamente envolvido em tags SSML ``. |\n| `sms` | `sender_id`, `template` | O SMS foi aceite para entrega pela rede | Entrega padr\u00e3o por SMS. S\u00f3 pode ser a **\u00faltima** etapa na estrat\u00e9gia de roteamento. |\n\n**Regras:**\n- Pelo menos um canal \u00e9 obrigat\u00f3rio.\n- Canais duplicados n\u00e3o s\u00e3o permitidos.\n- O canal `sms` s\u00f3 pode ser a \u00faltima etapa (sem fallback ap\u00f3s SMS).\n- O par\u00e2metro `timeout_sec` \u00e9 apenas aplic\u00e1vel para o canal `telegram`.\n\n### Otimiza\u00e7\u00e3o de custos\n\nO custo total de um pedido de c\u00f3digo de verifica\u00e7\u00e3o \u00e9 a **soma de todas as mensagens enviadas** por todos os canais que foram tentados \u2014 mesmo que alguns canais tenham falhado. Cada tentativa de canal incorre num custo por mensagem.\n\n**Recomenda\u00e7\u00e3o:** Ordene a sua estrat\u00e9gia de roteamento do canal mais econ\u00f3mico para o mais caro. Por exemplo, coloque `telegram` primeiro (custo mais baixo), depois `voice` e `sms` por \u00faltimo. Desta forma, se o canal mais econ\u00f3mico for bem-sucedido, evita pagar pelos mais caros.\n\n### Bloqueio e filtragem\n\nAntes de tentar a entrega, o sistema verifica o n\u00famero de telefone do destinat\u00e1rio contra as restri\u00e7\u00f5es da sua conta:\n\n- **N\u00fameros de telefone bloqueados**: Se o n\u00famero do destinat\u00e1rio estiver na sua lista de [n\u00fameros bloqueados](/#tag/blocked-numbers), a mensagem n\u00e3o ser\u00e1 enviada.\n- **Filtros SMS**: Se o n\u00famero do destinat\u00e1rio corresponder a qualquer um dos seus [filtros SMS](/#tag/sms-filters), a mensagem n\u00e3o ser\u00e1 enviada.\n\nQuando uma mensagem \u00e9 bloqueada por um filtro ou n\u00famero bloqueado, a etapa do canal e a tarefa geral recebem o estado `20` (Falhado). N\u00e3o \u00e9 tentado o fallback para o pr\u00f3ximo canal neste caso.\n\n### C\u00f3digo de verifica\u00e7\u00e3o\n\nO c\u00f3digo de verifica\u00e7\u00e3o \u00e9 uma cadeia num\u00e9rica (4\u20138 d\u00edgitos) enviada ao destinat\u00e1rio:\n\n- **C\u00f3digo personalizado**: Forne\u00e7a o seu pr\u00f3prio c\u00f3digo atrav\u00e9s da propriedade `code` (4\u20138 caracteres).\n- **Gerado automaticamente**: Se `code` n\u00e3o for fornecido, um c\u00f3digo num\u00e9rico aleat\u00f3rio \u00e9 gerado. Controle o comprimento com `code_length` (padr\u00e3o: 4, intervalo: 4\u20138).\n\nUse a propriedade `template` por canal para personalizar o texto da mensagem. O espa\u00e7o reservado `{{code}}` \u00e9 substitu\u00eddo pelo c\u00f3digo de verifica\u00e7\u00e3o real. Se nenhum modelo for fornecido, \u00e9 usada uma mensagem traduzida padr\u00e3o com base no campo `lang`.\n\n### Seguran\u00e7a: Eliminar c\u00f3digo ap\u00f3s o envio\n\nDefina `is_code_deleted` como `true` para eliminar automaticamente o c\u00f3digo de verifica\u00e7\u00e3o do armazenamento LOX24 ap\u00f3s este ter sido enviado ao destinat\u00e1rio. Isto garante que o c\u00f3digo n\u00e3o \u00e9 retido na base de dados ap\u00f3s a entrega.\n\n**IMPORTANTE:** Quando `is_code_deleted` est\u00e1 ativo, o campo `code` estar\u00e1 ausente nas respostas GET subsequentes ap\u00f3s a conclus\u00e3o da tarefa.\n\n### C\u00f3digos de estado\n\nTanto a tarefa geral como cada canal individual usam os mesmos valores de estado, mas a sem\u00e2ntica difere:\n\n**Estado da tarefa** (`status` de n\u00edvel superior):\n\n| Estado | Significado |\n|--------|------------|\n| `0` | Novo \u2014 pedido criado, ainda n\u00e3o processado |\n| `5` | Em andamento \u2014 entrega em curso |\n| `10` | Sucesso \u2014 c\u00f3digo entregue com sucesso atrav\u00e9s de pelo menos um canal |\n| `20` | Falhado \u2014 a entrega falhou em **todos** os canais |\n| `100` | Erro \u2014 erro do sistema |\n\n**Estado do canal** (`history[].status`):\n\n| Estado | Significado |\n|--------|------------|\n| `0` | Novo \u2014 etapa do canal criada, ainda n\u00e3o processada |\n| `5` | Em andamento \u2014 envio atrav\u00e9s deste canal |\n| `10` | Sucesso \u2014 entrega confirmada neste canal |\n| `20` | Falhado \u2014 a entrega falhou **neste** canal |\n| `100` | Erro \u2014 erro do sistema neste canal |\n\n### Notifica\u00e7\u00f5es Webhook\n\nEventos de c\u00f3digos de verifica\u00e7\u00e3o podem ser enviados para o seu endpoint de webhook. Os seguintes eventos est\u00e3o dispon\u00edveis:\n\n- `verify_code.success` \u2014 o c\u00f3digo foi entregue com sucesso\n- `verify_code.failed` \u2014 a entrega falhou em todos os canais\n- `verify_code.channel.sent` \u2014 c\u00f3digo enviado atrav\u00e9s de um canal espec\u00edfico\n- `verify_code.channel.success` \u2014 o canal confirmou a entrega com sucesso\n- `verify_code.channel.failed` \u2014 o canal falhou na entrega\n- `verify_code.channel.updated` \u2014 estado do canal atualizado\n\nConsulte a sec\u00e7\u00e3o [Notifica\u00e7\u00f5es Webhook](/#tag/notifications) para mais detalhes sobre a configura\u00e7\u00e3o de endpoints de webhook.\n" }, { "name": "invoices", "x-displayName": "Faturas", "description": "Obtenha uma lista de suas faturas e notas de cr\u00e9dito. Suporta filtragem por intervalo de datas, status, tipo de pagamento, tipo de documento e valor.\n" }, { "name": "payments", "x-displayName": "Pagamentos", "description": "Crie novos pagamentos e verifique seu status. Os m\u00e9todos de pagamento oferecidos dependem da classifica\u00e7\u00e3o da sua conta.\n" }, { "name": "credit_notes", "x-displayName": "Notas de cr\u00e9dito", "description": "Notas de cr\u00e9dito para o usu\u00e1rio autenticado, incluindo status, valores e detalhes de pagamento.\nAs notas de cr\u00e9dito podem ser filtradas por status, data de cria\u00e7\u00e3o, valor e data de pagamento.\nCada nota de cr\u00e9dito inclui um link de download em PDF e uma refer\u00eancia \u00e0 fatura relacionada.\n" }, { "name": "release-notes", "x-displayName": "Release notes", "description": "Release Notes tell you what\u2019s new in API. As always, we welcome your [feedback](mailto:berlin@lox24.eu).\n\n### 2.27 (2026-06-29)\n\n#### Adicionado\n\n- Novo endpoint: `/invoices` \u2014 Listar y ver facturas con filtros por estado, tipo de pago, rango de fechas y rango de importe. Cada fatura inclui PDF descargable y links para notas de cr\u00e9dito relacionadas.\n- Novo endpoint: `/credit_notes` \u2014 Listar y ver notas de cr\u00e9dito com os mesmos filtros das faturas.\n- Novo endpoint: `/payments` \u2014 Criar novos pagamentos com cart\u00f5es salvos o mandatos SEPA. Hist\u00f3rico de pagamentos com acompanhamento detalhado de status, valores, taxas e IVA.\n- Novo endpoint: `/payment_methods` \u2014 Obter m\u00e9todos de pagamento dispon\u00edveis del usuario: cart\u00f5es salvos e mandatos SEPA ativos.\n- Nova fun\u00e7\u00e3o de chave API `Payments` \u2014 Os endpoints `/invoices`, `/credit_notes`, `/payments` y `/payment_methods` exigem uma chave API de pagamentos dedicada.\n\n\n### 2.26 (2026-06-11)\n\n#### Adicionado\n\n- Novo Endpoint: `/pricelist/{country}`: Endpoint p\u00fablico para download de listas de pre\u00e7os SMS. Retorna pre\u00e7os para todas as rotas de servi\u00e7o dispon\u00edveis (direct, text2speech, economy, pro) em JSON, Excel ou CSV. Suporta filtragem por moeda (EUR, CHF) e nomes de pa\u00edses em v\u00e1rios idiomas (pt, en, de, es, pl). Inclui requisitos de envio espec\u00edficos do pa\u00eds. N\u00e3o requer autentica\u00e7\u00e3o.\n- Novo Endpoint: `/me/pricelist/{country}`: Endpoint autenticado para download de uma lista de pre\u00e7os personalizada com tarifas SMS espec\u00edficas do usu\u00e1rio. Retorna um pre\u00e7o \u00fanico por servi\u00e7o com base no n\u00edvel de pre\u00e7o do usu\u00e1rio. A moeda \u00e9 obtida das configura\u00e7\u00f5es da conta, o idioma padr\u00e3o \u00e9 o do perfil do usu\u00e1rio. Dispon\u00edvel em JSON, Excel ou CSV.\n\n### 2.25 (2026-06-07)\n\n#### Adicionado\n\n- Novo Endpoint: `/verify_codes`: adicionada uma API REST dedicada para cria\u00e7\u00e3o e gest\u00e3o de c\u00f3digos de verifica\u00e7\u00e3o de uso \u00fanico (OTP). Suporta estrat\u00e9gia de roteamento multi-etapas (Telegram, chamada de Voz, SMS) com fallback autom\u00e1tico e controlo de timeout.\n\n### 2.24 (2025-12-10)\n\n#### Adicionado\n\n- Nova propriedade `attempts_count_max` para o endpoint de SMS: Controlo do n\u00famero m\u00e1ximo de tentativas de entrega para servi\u00e7os de voz (text2speech, text2speech_ssml). Aceita valores 1, 2 ou 3 para servi\u00e7os de voz, permitindo um controlo preciso do comportamento de repeti\u00e7\u00e3o de chamadas. Deve ser null para servi\u00e7os de SMS padr\u00e3o.\n\n### 2.23 (2025-11-20)\n\n#### Changed\n\n- Suporte alargado para idiomas nas mensagens de voz, de 5 para 20 idiomas. Os utilizadores podem agora definir `voice_lang` para qualquer um dos seguintes idiomas europeus: EN, DE, FR, IT, ES, PL, NL, RO, PT, CS, HU, SV, DA, FI, SK, HR, TR, RU, BG, UK.\n- Detec\u00e7\u00e3o autom\u00e1tica de idioma melhorada. A an\u00e1lise de conte\u00fado, baseada no prefixo telef\u00f3nico, foi alterada para uma an\u00e1lise com intelig\u00eancia artificial utilizando o texto da mensagem quando `voice_lang` \u00e9 nulo.\n\n### 2.22 (2025-09-15)\n\n#### Adicionado\n\n- Novos eventos webhook para gest\u00e3o de subscri\u00e7\u00f5es de telefone: `phone.subscribe` e `phone.unsubscribe`\n- Adicionado suporte a endere\u00e7os IP v6 para o ponto final `POST /fraud-checks`\n\n### 2.21 (2025-09-10)\n\n#### Adicionado\n\n- Novo ponto final: `/blocked_numbers`: adicionada uma API REST dedicada para gerir n\u00fameros de telefone bloqueados em campanhas de SMS. O ponto final fornece funcionalidade CRUD completa para manter uma lista centralizada de n\u00fameros de telefone que n\u00e3o devem receber mensagens SMS.\n\n### 2.20 (2025-08-20)\n\n#### Adicionado\n\n- Cabe\u00e7alhos de resposta - Todas as respostas da API agora incluem um cabe\u00e7alho exclusivo `X-LOX24-REQUEST-ID` para fins de suporte e rastreamento.\n\n### 2.19 (2025-08-15)\n\n#### Alterado\n\n- Reorganiza\u00e7\u00e3o da especifica\u00e7\u00e3o OpenAPI - Reestrutura\u00e7\u00e3o importante com corre\u00e7\u00e3o de v\u00e1rios erros sem\u00e2nticos\n- Renderiza\u00e7\u00e3o de documenta\u00e7\u00e3o - Substitu\u00edda a renderiza\u00e7\u00e3o din\u00e2mica do navegador OpenAPI JSON por p\u00e1ginas HTML compiladas est\u00e1ticas\n\n#### Adicionado\n\n- Documenta\u00e7\u00e3o de webhooks - Adicionada uma descri\u00e7\u00e3o abrangente de webhooks e detalhes de implementa\u00e7\u00e3o\n- Novos eventos webhook para an\u00e1lise de Email para SMS: `sms.email.parsing.success` e `sms.email.parsing.fail`\n\n### 2.18 (2022-10-03)\n\n#### New\n\n- Added the [Email to single SMS feature](/pt/info/kannel/email-to-sms/)\n\n\n### 2.17 (2023-06-28)\n\n#### New\n\n- SMS and SMS Bulk property `is_text_deleted` of endpoint [Simulate sending an SMS (for testing)](/pt/api/operations/api_sms_post_collection/) and [Create the Bulk](/pt/api/operations/api_bulks_get_collection/)\n- [Email2Bulk's property `max_sms_parts` of endpoint](/pt/info/kannel/email-to-sms/)\n- Notifications per events `bulk.email.parsing.success` and `bulk.email.parsing.fail`\n- Added timestamp property `balance_changed_at` to the endpoint `GET /me`.\n\n\n### 2.16 (2023-01-09)\n\n#### New\n\n- Added filter by the property `callback_data` of endpoint [Retrieves the collection of SMS](/pt/api/operations/api_sms_get_collection/)\n- [Email2Bulk's property `max_sms_parts` of endpoint](/pt/info/kannel/email-to-sms/)\n- Notifications per events `bulk.email.parsing.success` and `bulk.email.parsing.fail`\n\n\n### 2.15 (2022-10-25)\n\n#### New\n\n- Added an address property to [Fraud Detection API](/pt/info/kannel/fraud-detection/)\n\n\n\n### 2.14 (2022-08-17)\n\n#### New\n\n- Added Phone's read-only properties `subscribed_at`, `unsubscribed_at` and `unsubscribed_reason` (see [Phone API](/pt/api/operations/api_phones_get_item/)\n\n\n### 2.13 (2022-08-01)\n\n#### New\n\n- Added [Fraud Detection API](/pt/info/kannel/fraud-detection/)\n\n### 2.12 (2022-05-05)\n\n#### New\n\n- Added the [Email to SMS Bulk feature](/pt/info/kannel/email-to-sms/)\n\n### 2.11 (2022-03-31)\n\n#### New\n\n- Added the short links functionality\n\t- [Short link campaigns](/pt/info/kannel/campaigns/)\n\t- [Short links lists](/pt/info/kannel/links/)\n\t- [Requests by short links](/pt/info/kannel/requests/)\n\t- [Click rates statistics](/pt/info/kannel/click-rate/)\n\n### 2.10 (2021-09-23)\n\n#### New\n\n- Added the endpoint [Delete the Incoming SMS](/pt/api/operations/api_incomings_delete_item/)\n\n#### Fixes\n- The Incoming SMS list by default is ordered by decreasing values of the ```received_at``` field.\n\n\n### 2.9 (2021-05-06)\n\n#### New\n\n- Added the ability to authenticate using the new version of the API key\n with a single header ```X-LOX24-AUTH-TOKEN```, header ```X-LOX24-AUTH-CLIENT-ID``` is deprecated and not recommended for use.\n\n\n### 2.8.1 (2021-04-01)\n\n#### New\n\n- Voice messages. Added ```voice_lang``` property to SMS and Bulk request/response objects.\n\n### 2.8.0 (2021-02-21)\n\n#### New\n\n- Temporary block IP address after multiple invalid authentication attempts.\n\n\n### 2.7.1 (2021-02-16)\n\n#### Fixes\n- Fixed request description in the [Create the Bulk](/pt/api/operations/api_bulks_get_collection/) and [Simulate creating a Bulk (for testing)](/pt/api/operations/api_bulks_post_dryrun_collection/)\n\n### 2.7 (2020-07-17)\n\n#### New\n\n- Created [Kannel API emulation](/pt/info/kannel/kannel/).\n\n### 2.6 (2020-06-23)\n\n#### New\n\n- Added ability to send SMS with additional data which will be send back to DLR endpoint.\n\n### 2.5 (2020-06-10)\n\n#### Developer\n\n- Added sample code per Phones and Groups endpoints.\n\n### 2.4 (2020-05-30)\n\n#### Developer\n\n- Added sample code in GoLang, Java and Python.\n\n### 2.3 (2020-05-25)\n\n#### New\n\n- Added boolean filter of Bulks list `GET /bulks` by the property `is_dryrun`.\n- Added timestamp property `balance_changed_at` to the endpoint `GET /me`.\n\n### 2.2 (2020-05-19)\n\n#### New\n\n- Created endpoints `GET /incomings` and `GET /incomings/{id}` to retrieve info about incoming and related SMS.\n- Enabled DLR report webhook on `POST /sms/dryrun` request.\n- Added *exact* filter by `key_id` on `GET /bulks` and `GET /sms`.\n\n\n#### Developer\n- Added sample code in PHP, C# and Javascript per `/sms`, `/bulks` and `/incomings` endpoints.\n- Added section [Inbound SMS and Reply-SMS](/pt/info/kannel/inbound-and-reply-sms/) about incoming SMS.\n\n#### Fixed\n\n- Fixed a bug related to storing the ip address, date and time of the last API key use\n\n\n### 2.1 (2020-03-18)\n\n#### New\n\n- The feature that helps you make [bulk sms](/pt/info/kannel/bulks/) in just one HTTP request:\n - with text template and contact groups\n - preliminary calculation of the cost of bulk SMS\n - fast server response and asynchronous processing\n - bulk SMS cancellation option even during processing\n- New endpoint POST /groups/{id}/phones/batch\n - combine multiple POST /groups/{id}/phones to an one request\n- Implemented filters `GET /sms` by the property `bulk`\n- Implemented filters `GET /bulks` by the property `source`\n- Added API key ID info to `sms` and `bulks` responses\n\n#### Fixed\n\n- Added property `price` to SMS response object\n- Authorization parameters description in the API documentation\n\n### 2.0-beta (2019-12-15)\n\n#### New\n\n- API v2.0 has been developed in accordance with industry standards to make integration as easy as possible. In addition, you can now transmit large quantities of SMS with one query and retrieve detailed information about the messages at any time.\n\n- The extensive group functionality allows you to manage your mailing lists in our high-performance cloud and thus save your own resources. All this is still compliant with European data protection standards and the German Telecommunications Act.\n\n#### Developer\n\nYou can find the new API description at https://doc.lox24.eu/\n" } ], "paths": { "/bulks": { "get": { "operationId": "api_bulks_get_collection", "tags": [ "bulks" ], "responses": { "200": { "description": "bulks collection", "content": { "application/ld+json": { "schema": { "type": "object", "properties": { "@context": { "$ref": "#/components/schemas/property._jsonld_context" }, "@id": { "$ref": "#/components/schemas/property._jsonld_id" }, "@type": { "$ref": "#/components/schemas/property._jsonld_type" }, "totalItems": { "$ref": "#/components/schemas/hydra.totalItems" }, "member": { "type": "array", "items": { "$ref": "#/components/schemas/schema.bulks.jsonld-bulk_read_status" } }, "search": { "type": "object", "properties": { "@type": { "type": "string" }, "template": { "type": "string" }, "variableRepresentation": { "type": "string" }, "mapping": { "type": "array", "items": { "type": "object", "properties": { "@type": { "type": "string" }, "variable": { "type": "string" }, "property": { "type": [ "string", "null" ] }, "required": { "type": "boolean" } } } } } } }, "required": [ "member" ] }, "examples": { "example_bulks_response_get": { "$ref": "#/components/examples/example_bulks_response_get_jsonld" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/schema.bulks-bulk_read_status" } }, "examples": { "example_bulks_response_get": { "$ref": "#/components/examples/example_bulks_response_get" } } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Retrieves the collection of Bulks", "description": "Getting the list of bulks from the postbox, ordered by the field `created_at` in descending order. The postbox contains all sent, not sent and terminated SMS. You can also optionally sort according to the price or the time of transmit to the network operator. You also have the option of transferring different search criteria to limit the output of postbox's messages.", "parameters": [ { "$ref": "#/components/parameters/filter.common.page" }, { "$ref": "#/components/parameters/filter.messages.uuid.array" }, { "$ref": "#/components/parameters/filter.messages.uuid.exact" }, { "$ref": "#/components/parameters/order.common.created_at" }, { "$ref": "#/components/parameters/order.messages.delivery_at" }, { "$ref": "#/components/parameters/order.common.processed_at" }, { "$ref": "#/components/parameters/order.bulks.msg_total_count" }, { "$ref": "#/components/parameters/filter.messages.text.partial" }, { "$ref": "#/components/parameters/filter.messages.sender_id.partial" }, { "$ref": "#/components/parameters/filter.bulks.status_code.exact" }, { "$ref": "#/components/parameters/filter.bulks.status_code.array" }, { "$ref": "#/components/parameters/filter.common.created_at.exact" }, { "$ref": "#/components/parameters/filter.common.created_at.array" }, { "$ref": "#/components/parameters/filter.messages.delivery_at.exact" }, { "$ref": "#/components/parameters/filter.messages.delivery_at.array" }, { "$ref": "#/components/parameters/filter.common.processed_at.exact" }, { "$ref": "#/components/parameters/filter.common.processed_at.array" }, { "$ref": "#/components/parameters/filter.bulks.msg_total_count.exact" }, { "$ref": "#/components/parameters/filter.bulks.msg_total_count.array" }, { "$ref": "#/components/parameters/filter.messages.source.exact" }, { "$ref": "#/components/parameters/filter.messages.source.array" }, { "$ref": "#/components/parameters/filter.common.key_id.exact" }, { "$ref": "#/components/parameters/filter.common.key_id.array" }, { "$ref": "#/components/parameters/filter.messages.is_unicode.boolean" }, { "$ref": "#/components/parameters/filter.messages.is_dryrun.boolean" }, { "$ref": "#/components/parameters/filter.messages.is_unicode.exists" } ], "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X GET https://api.lox24.eu/bulks \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string url = \"https://api.lox24.eu/bulks?_order[created_at]=desc\";\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\"; // or \"application/ld+json\"\n httpWebRequest.Method = \"GET\";\n //httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n Console.WriteLine(\"Success:{0} {1}\", respCode, \"bulks collection response\");\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"GET\"\n\tconst URL = \"https://api.lox24.eu/bulks?sender_id=testsender\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println((string(body)))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.bulks;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GetBulksCollection {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\n var url = \"https://api.lox24.eu/bulks?_order[created_at]=desc\";\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .GET()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"bulks collection response\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n } else {\n System.out.println(\"Error: something went wrong, code(\" + httpResponse.statusCode() + \")\");\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar query = \"created_at[gte]=1589713050&_order[created_at]=desc\";\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/bulks?' + query,\n method: 'GET',\n headers: {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log('Success: code = 200 - bulks collection response');\n res.on('data', d => {process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n})\n\nreq.on('error', error => {\n console.error(error)\n})\n\nreq.end();\n\n\n", "label": "JavaScript" }, { "lang": "php", "source": " 'test',\n 'created_at' => [\n 'gte' => 1588777845\n ],\n 'page' => 1,\n '_order' => [\n 'created_at' => 'desc'\n ],\n];\n\n$uri .= $filters ? '?' . http_build_query($filters) : '';\n$curl = curl_init();\n\necho $uri;\n\ncurl_setopt_array($curl, [\n CURLOPT_URL => $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\nurl = \"https://api.lox24.eu/bulks?_order[created_at]=desc\"\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - bulks collection response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n", "label": "Python" } ] }, "post": { "operationId": "api_bulks_post_collection", "tags": [ "bulks" ], "responses": { "201": { "description": "bulks resource created", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.bulks.jsonld-bulk_read" }, "examples": { "example_bulks_response_post": { "$ref": "#/components/examples/example_bulks_response_post_jsonld" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.bulks-bulk_read" }, "examples": { "example_bulks_response_post": { "$ref": "#/components/examples/example_bulks_response_post" } } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "422": { "$ref": "#/components/responses/422-unprocessable-entity" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Create the Bulk", "description": "Create a bulk SMS campaign by sending a POST request with message details and recipient information.", "parameters": [], "requestBody": { "description": "The new bulks resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schema.bulks-bulk_write" }, "examples": { "example_bulks_request": { "$ref": "#/components/examples/example_bulks_request" } } } }, "required": true }, "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X POST https://api.lox24.eu/bulks \\\n -H 'Content-Type: application/json' \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx' \\\n -d '{\n\t\"sender_id\": \"testbulk\",\n \"text\": \"test bulk text\",\n \"service_code\": \"direct\",\n \"phones\": [\"+49751234567\"],\n \"msg_groups\": [7117],\n \"delivery_at\": 1573724611,\n \"is_unicode\": true,\n \"source\": 1234,\n \"voice_lang\": \"DE\"\n }'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json;\nusing Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string url = \"https://api.lox24.eu/bulks\";\n\n var data = new {\n sender_id = \"My Sender\",\n text = \"Test message!\",\n service_code = \"direct\",\n phones = new string[]{\"+49751234567\", \"+49751234568\"},\n msg_groups = new int[]{14514},\n delivery_at = 1573724611,\n is_unicode = true,\n voice_lang = \"DE\"\n };\n\n string postdata = JsonConvert.SerializeObject(data);\n\n Console.WriteLine(\"Post data: {0}\", postdata);\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.ContentType = \"application/json; charset=utf-8\";\n httpWebRequest.Accept = \"application/json\"; // or application/ld+json\n httpWebRequest.Method = \"POST\";\n httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n using (var streamWriter = new StreamWriter(httpWebRequest.GetRequestStream()))\n {\n streamWriter.Write(postdata);\n streamWriter.Flush();\n streamWriter.Close();\n }\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n\n if(resp.StatusCode == HttpStatusCode.Created) {\n Console.WriteLine(\"Success:{0} {1}\", (int)resp.StatusCode, \"bulks resource created\");\n } else {\n Console.WriteLine(\"Error: wrong response code {0} on create bulk\", (int)resp.StatusCode);\n }\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.BadRequest: // 400\n Console.WriteLine(\"Error:400 Invalid input\");\n break;\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.NotFound: // 404\n Console.WriteLine(\"Error:404 Resource not found\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"bytes\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"POST\"\n\tconst URL = \"https://api.lox24.eu/bulks\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tpayload := map[string]interface{}{\n\t\t\"sender_id\": \"testbulk\",\n\t\t\"text\": \"test bulk text\",\n\t\t\"service_code\": \"direct\",\n\t\t\"phones\": []string{\"+49751234567\"},\n\t\t\"msg_groups\": []int{7117},\n\t\t\"delivery_at\": 1593724611,\n\t\t\"is_unicode\": true,\n\t\t\"source\": 1234,\n\t\t\"voice_lang\": \"DE\",\n\t}\n\n\tjsonPayload, _ := json.Marshal(payload)\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, bytes.NewBuffer(jsonPayload))\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Content-Type\", \"application/json\")\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 201:\n\t\tfmt.Println((string(body)))\n\tcase 400:\n\t\tfmt.Println(\"Error: code = 400 - Invalid input\")\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.bulks;\n\nimport org.json.JSONObject;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class PostBulksCollection {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var url = \"https://api.lox24.eu/bulks\";\n\n var json = new JSONObject();\n json.put(\"sender_id\", \"My Sender\");\n json.put(\"text\", \"Test message!\");\n json.put(\"service_code\", \"direct\");\n json.put(\"phones\", new String[]{\"+49751234567\", \"+49751234568\", \"+49751234569\"});\n json.put(\"msg_groups\", new int[]{7116, 7117});\n json.put(\"delivery_at\", 1573724611);\n json.put(\"is_unicode\", true);\n json.put(\"voice_lang\", \"DE\");\n\n var postData = json.toString();\n\n System.out.println(\"Post data: \" + postData);\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Content-Type\", \"application/json; charset=utf-8\")\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .POST(HttpRequest.BodyPublishers.ofString(postData))\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_CREATED) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"bulks resource created\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error: wrong response code \" + httpResponse.statusCode() + \" on create bulk\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_BAD_REQUEST: // 400\n System.out.println(\"Error:400 Invalid input\");\n break;\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar postObj = {\n sender_id: 'My Sender',\n text: 'Test message',\n service_code: 'direct',\n phones: ['+49751234567', '+344354634'],\n msg_groups: [7117],\n delivery_at: 1573724611,\n is_unicode: true,\n voice_lang: 'DE',\n};\n\nvar postdata = JSON.stringify(postObj);\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/bulks',\n method: 'POST',\n headers: {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'Content-Length': postdata.length,\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 201) {\n console.log(\"Success: code = 201 - bulks resource created\");\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 400) {\n console.log(\"Error: code = 400 - Invalid input\");\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n});\n\nreq.on('error', error => {\n console.error(error)\n});\n\nreq.write(postdata);\nreq.end();\n\n\n", "label": "JavaScript" }, { "lang": "php", "source": " 'testbulk',\n 'text' => 'test bulk text',\n 'service_code' => 'direct',\n 'phones' => ['+49751234567'],\n 'msg_groups' => [7117],\n 'delivery_at' => 1573724611,\n 'is_unicode' => true,\n 'source' => 1234,\n 'voice_lang' => 'DE',\n];\n\nif(!$body = json_encode($body)) {\n die('JSON encoding error!');\n}\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_POST => true,\n CURLOPT_URL => $uri,\n CURLOPT_POSTFIELDS => $body,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n 'Content-Type: application/json',\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(201 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\nurl = \"https://api.lox24.eu/bulks\"\n\ndata = {\n 'sender_id': \"My Sender\",\n 'text' : \"Test message\",\n 'service_code' : \"direct\",\n 'phones': [\"+49751234567\", \"+49751234568\"],\n 'msg_groups': [14514],\n 'delivery_at': 1573724611,\n 'is_unicode': True,\n 'voice_lang' : \"DE\"\n}\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'Content-Type': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\nprint(\"Post data: \", json.dumps(data, indent=4))\n\ntry:\n # timeout is 100 seconds\n res = requests.post(url, headers=headers, json=data, timeout=100)\n if res.status_code != 201: # Created\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - bulks resource created')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 400:\n print(\"Error:400 Invalid input\")\n elif res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\n\n", "label": "Python" } ] } }, "/bulks/dryrun": { "post": { "operationId": "api_bulks_post_dryrun_collection", "tags": [ "bulks" ], "responses": { "201": { "description": "bulks resource created", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.bulks.jsonld-bulk_read" }, "examples": { "example": { "$ref": "#/components/examples/example_bulks_response_post_jsonld" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.bulks-bulk_read" }, "examples": { "example": { "$ref": "#/components/examples/example_bulks_response_post" } } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "422": { "$ref": "#/components/responses/422-unprocessable-entity" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Simulate creating a Bulk (for testing)", "description": "This endpoint is used for test purposes to emulate the creating of an Bulk without actually creating SMS and passing them to the network operator for a fee.", "parameters": [], "requestBody": { "description": "The new bulks resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schema.bulks-bulk_write" }, "examples": { "example": { "$ref": "#/components/examples/example_bulks_request" } } } }, "required": true }, "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X POST https://api.lox24.eu/bulks/dryrun \\\n -H 'Content-Type: application/json' \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx' \\\n -d '{\n\t\"sender_id\": \"testbulk\",\n \"text\": \"test bulk text\",\n \"service_code\": \"direct\",\n \"phones\": [\"+49751234567\"],\n \"msg_groups\": [7117],\n \"delivery_at\": 1573724611,\n \"is_unicode\": true,\n \"source\": 1234,\n \"voice_lang\": \"DE\"\n }'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json;\nusing Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string url = \"https://api.lox24.eu/bulks/dryrun\";\n\n var data = new {\n sender_id = \"My Sender\",\n text = \"Test message!\",\n service_code = \"direct\",\n phones = new string[]{\"+49751234567\", \"+49751234568\"},\n msg_groups = new int[]{14514},\n delivery_at = 1573724611,\n is_unicode = true,\n voice_lang = \"DE\"\n };\n\n string postdata = JsonConvert.SerializeObject(data);\n\n Console.WriteLine(\"Post data: {0}\", postdata);\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.ContentType = \"application/json; charset=utf-8\";\n httpWebRequest.Accept = \"application/json\"; // or application/ld+json\n httpWebRequest.Method = \"POST\";\n httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n using (var streamWriter = new StreamWriter(httpWebRequest.GetRequestStream()))\n {\n streamWriter.Write(postdata);\n streamWriter.Flush();\n streamWriter.Close();\n }\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n\n if(resp.StatusCode == HttpStatusCode.Created) {\n Console.WriteLine(\"Success:{0} {1}\", (int)resp.StatusCode, \"bulks resource created\");\n } else {\n Console.WriteLine(\"Error: wrong response code {0} on create bulk\", (int)resp.StatusCode);\n }\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.BadRequest: // 400\n Console.WriteLine(\"Error:400 Invalid input\");\n break;\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.NotFound: // 404\n Console.WriteLine(\"Error:404 Resource not found\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"bytes\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"POST\"\n\tconst URL = \"https://api.lox24.eu/bulks/dryrun\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tpayload := map[string]interface{}{\n\t\t\"sender_id\": \"testbulk\",\n\t\t\"text\": \"test bulk text\",\n\t\t\"service_code\": \"direct\",\n\t\t\"phones\": []string{\"+49751234567\"},\n\t\t\"msg_groups\": []int{7117},\n\t\t\"delivery_at\": 1593724611,\n\t\t\"is_unicode\": true,\n\t\t\"source\": 1234,\n\t\t\"voice_lang\": \"DE\",\n\t}\n\n\tjsonPayload, _ := json.Marshal(payload)\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, bytes.NewBuffer(jsonPayload))\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Content-Type\", \"application/json\")\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 201:\n\t\tfmt.Println((string(body)))\n\tcase 400:\n\t\tfmt.Println(\"Error: code = 400 - Invalid input\")\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.bulks;\n\nimport org.json.JSONObject;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class PostDryRunBulksCollection {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var url = \"https://api.lox24.eu/bulks/dryrun\";\n\n var json = new JSONObject();\n json.put(\"sender_id\", \"My Sender\");\n json.put(\"text\", \"Test message!\");\n json.put(\"service_code\", \"direct\");\n json.put(\"phones\", new String[]{\"+49751234567\", \"+49751234568\", \"+49751234569\"});\n json.put(\"msg_groups\", new int[]{7116, 7117});\n json.put(\"delivery_at\", 1573724611);\n json.put(\"is_unicode\", true);\n json.put(\"voice_lang\", \"DE\");\n\n var postData = json.toString();\n\n System.out.println(\"Post data: \" + postData);\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Content-Type\", \"application/json; charset=utf-8\")\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .POST(HttpRequest.BodyPublishers.ofString(postData))\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_CREATED) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"bulks resource created\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error: wrong response code \" + httpResponse.statusCode() + \" on create bulk\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_BAD_REQUEST: // 400\n System.out.println(\"Error:400 Invalid input\");\n break;\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar postObj = {\n sender_id: 'My Sender',\n text: 'Test message',\n service_code: 'direct',\n phones: ['+49751234567', '+344354634'],\n msg_groups: [7117],\n delivery_at: 1573724611,\n is_unicode: true,\n voice_lang: 'DE',\n};\n\nvar postdata = JSON.stringify(postObj);\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/bulks/dryrun',\n method: 'POST',\n headers: {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'Content-Length': postdata.length,\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 201) {\n console.log(\"Success: code = 201 - bulks resource created\");\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 400) {\n console.log(\"Error: code = 400 - Invalid input\");\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n});\n\nreq.on('error', error => {\n console.error(error)\n});\n\nreq.write(postdata);\nreq.end();\n\n\n", "label": "JavaScript" }, { "lang": "php", "source": " 'testbulk',\n 'text' => 'test bulk text',\n 'service_code' => 'direct',\n 'phones' => ['+49751234567'],\n 'msg_groups' => [7117],\n 'delivery_at' => 1573724611,\n 'is_unicode' => true,\n 'source' => 1234,\n 'voice_lang' => 'DE',\n];\n\nif(!$body = json_encode($body)) {\n die('JSON encoding error!');\n}\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_POST => true,\n CURLOPT_URL => $uri,\n CURLOPT_POSTFIELDS => $body,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n 'Content-Type: application/json',\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(201 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\nurl = \"https://api.lox24.eu/bulks/dryrun\"\n\ndata = {\n 'sender_id': \"My Sender\",\n 'text' : \"Test message\",\n 'service_code' : \"direct\",\n 'phones': [\"+49751234567\", \"+49751234568\"],\n 'msg_groups': [14514],\n 'delivery_at': 1573724611,\n 'is_unicode': True,\n 'voice_lang' : \"DE\"\n}\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'Content-Type': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\nprint(\"Post data: \", json.dumps(data, indent=4))\n\ntry:\n # timeout is 100 seconds\n res = requests.post(url, headers=headers, json=data, timeout=100)\n if res.status_code != 201: # Created\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - bulks resource created')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 400:\n print(\"Error:400 Invalid input\")\n elif res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\n\n", "label": "Python" } ] } }, "/bulks/{id}": { "get": { "operationId": "api_bulks_get_item", "tags": [ "bulks" ], "responses": { "200": { "description": "bulks resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.bulks.jsonld-bulk_read" } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.bulks-bulk_read" } } } }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Retrieves the entry of Bulk", "description": "Getting the single Bulk entity by the ID (`uuid`). If Bulk not found then HTTP code 404 will response.", "parameters": [ { "$ref": "#/components/parameters/path.bulks.id" } ], "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X GET https://api.lox24.eu/bulks/da0fa78c-4699-11ea-a637-96000028b339 \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var id = \"343c785b-8567-11ea-aa81-96000028b339\";\n\n string url = \"https://api.lox24.eu/bulks/\" + id;\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\"; //or application/ld+json\n httpWebRequest.Method = \"GET\";\n httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n Console.WriteLine(\"Success:{0} {1}\", respCode, \"bulks resource response\");\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.NotFound: // 404\n Console.WriteLine(\"Error:404 Resource not found\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"GET\"\n\tconst URL = \"https://api.lox24.eu/bulks/981f6497-a03e-11ea-b2e9-b8ca3a65338c\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println((string(body)))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tcase 404:\n\t\tfmt.Println(\"Error: code = 404 - Resource not found\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.bulks;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GetBulksItem {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var id = \"343c785b-8567-11ea-aa81-96000028b339\";\n\n var url = \"https://api.lox24.eu/bulks/\" + id;\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .GET()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"bulks resource created\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error: wrong response code \" + httpResponse.statusCode() + \" on create bulk\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_NOT_FOUND: // 404\n System.out.println(\"Error:404 Resource not found\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar id = '34153580-982d-11ea-aa81-96000028b339';\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/bulks/' + id,\n method: 'GET',\n headers: {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log('Success: code = 200 - bulks resource response');\n res.on('data', d => { process.stdout.write(d)})\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else if (res.statusCode == 404) {\n console.log(\"Error: code = 404 - Resource not found\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n})\n\nreq.on('error', error => {\n console.error(error)\n})\n\nreq.end();\n\n\n", "label": "JavaScript" }, { "lang": "php", "source": " $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data ' . var_export($data, true);\n} elseif(404 === $code) {\n echo \"Bulk with id = {$id} not found!\";\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\nbulk_id = \"343c785b-8567-11ea-aa81-96000028b339\"\n\nurl = f'https://api.lox24.eu/bulks/{bulk_id}'\n\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - bulks resource response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 404:\n print(\"Error:404 Resource not found\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n", "label": "Python" } ] }, "delete": { "operationId": "api_bulks_delete_item", "tags": [ "bulks" ], "responses": { "204": { "$ref": "#/components/responses/204-deleted" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Delete a Bulk", "description": "Remove the Bulk entity by the ID . Endpoint response doesn't contains the body and has HTTP code 204 if SMS was removed or 404 if it doesn't exists. Attention. The Bulk is also deleted from the itemised bill. Later complaints are therefore excluded due to lack of traceability.", "parameters": [ { "name": "id", "in": "path", "description": "Bulk ID", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ], "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X DELETE https://api.lox24.eu/bulks/da0fa78c-4699-11ea-a637-96000028b339 \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\n var id = \"851b600d-901e-11ea-aa81-96000028b339\";\n string url = \"https://api.lox24.eu/bulks/\" + id;\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\";\n httpWebRequest.Method = \"DELETE\";\n //httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n if(resp.StatusCode == HttpStatusCode.NoContent) { //204\n Console.WriteLine(\"Success: bulk was deleted\");\n } else {\n Console.WriteLine(\"Error: something went wrong, code({0})\", respCode);\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n\n JObject parsed = JObject.Parse(responseText);\n\n foreach (var pair in parsed)\n {\n Console.WriteLine(\"{0}: {1}\", pair.Key, pair.Value);\n }\n }\n }\n\n }\n\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.NotFound: // 404\n Console.WriteLine(\"Error:404 Resource not found\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"DELETE\"\n\tconst URL = \"https://api.lox24.eu/bulks/981f6497-a03e-11ea-b2e9-b8ca3a65338c\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tswitch res.StatusCode {\n\tcase 204:\n\t\tfmt.Println(\"Bulk and related sms was deleted!\")\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tcase 404:\n\t\tfmt.Println(\"Error: code = 404 - Resource not found\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.bulks;\n\nimport org.json.JSONObject;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class DeleteBulksItem {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\n var id = \"851b600d-901e-11ea-aa81-96000028b339\";\n var url = \"https://api.lox24.eu/bulks/\" + id;\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .DELETE()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_NO_CONTENT) {\n System.out.println(\"Success: bulk was deleted\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error: something went wrong \" + httpResponse.statusCode());\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n JSONObject parsed = new JSONObject(httpResponse.body());\n\n parsed.keys().forEachRemaining(jsonKey -> System.out.println(jsonKey + \":\" + parsed.get(jsonKey)));\n\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_NOT_FOUND: // 404\n System.out.println(\"Error:404 Resource not found\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar id = '20f39273-0566-11ea-a637-96000028b339';\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/bulks/' + id,\n method: 'DELETE',\n headers: {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 204) {\n console.log(\"Success: code = 204 - bulks resource deleted\");\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else if (res.statusCode == 404) {\n console.log(\"Error: code = 404 - Resource not found\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n})\n\nreq.on('error', error => {\n console.error(error)\n})\n\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " $uri,\n CURLOPT_CUSTOMREQUEST => 'DELETE',\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\nif(204 === $code) {\n echo \"Bulk with id = {$id} was deleted!\";\n} elseif(404 === $code) {\n echo \"Bulk with id = {$id} not found!\";\n} else {\n $data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\nbulk_id = \"851b600d-901e-11ea-aa81-96000028b339\"\n\nurl = f'https://api.lox24.eu/bulks/{bulk_id}'\n\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.delete(url, headers=headers, timeout=100)\n if res.status_code != 204: # No Content\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - bulk was deleted')\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 404:\n print(\"Error: code = 404 - Resource not found\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n\n", "label": "Python" } ] } }, "/bulks/{id}/cancel": { "put": { "operationId": "api_bulks_put_cancel_item", "tags": [ "bulks" ], "responses": { "200": { "description": "bulks resource updated", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.bulks.jsonld-bulk_read_status" } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.bulks-bulk_read_status" } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "422": { "$ref": "#/components/responses/422-unprocessable-entity" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Cancel the Bulk processing", "description": "Cancel Bulk's processing if it has `status_code = 0` (New) or `status_code = 5` and related to the Bulk messages with `is_sent = False`", "parameters": [ { "$ref": "#/components/parameters/path.bulks.id" } ], "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X PUT https://api.lox24.eu/bulks/da0fa78c-4699-11ea-a637-96000028b339/cancel \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string id = \"984af866-902e-11ea-aa81-96000028b339\";\n string url = \"https://api.lox24.eu/bulks/\" + id + \"/cancel\";\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000; //this can cause issues which is why we are manually setting this\n httpWebRequest.Accept = \"application/json\";\n httpWebRequest.Method = \"PUT\";\n //httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n if(resp.StatusCode == HttpStatusCode.OK) {\n Console.WriteLine(\"Success: bulk {0} was canceled!\", id);\n } else {\n Console.WriteLine(\"Error: bulk {0} wasn't canceled, code = {0}\", (int)resp.StatusCode);\n }\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.NotFound: // 404\n Console.WriteLine(\"Error:404 Resource not found\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"PUT\"\n\tconst URL = \"https://api.lox24.eu/bulks/52a84594-9a7b-11ea-b2e9-b8ca3a65338c/cancel\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println((string(body)))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tcase 404:\n\t\tfmt.Println(\"Error: code = 404 - Resource not found\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.bulks;\n\nimport org.json.JSONObject;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class PutCancelBulksItem {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var id = \"343c785b-8567-11ea-aa81-96000028b339\";\n var url = \"https://api.lox24.eu/bulks/\" + id + \"/cancel\";\n\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .PUT(HttpRequest.BodyPublishers.noBody())\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"bulks resource updated\");\n\n JSONObject parsed = new JSONObject(httpResponse.body());\n\n parsed.keys().forEachRemaining(jsonKey -> System.out.println(jsonKey + \":\" + parsed.get(jsonKey)));\n } else {\n\n System.out.println(\"Error: wrong response code \" + httpResponse.statusCode() + \" on update bulks\");\n\n switch (httpResponse.statusCode()) {\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_NOT_FOUND: // 404\n System.out.println(\"Error:404 Resource not found\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar id = '4897749e-982d-11ea-aa81-96000028b339';\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/bulks/' + id + '/cancel',\n method: 'PUT',\n headers: {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log(\"Success: code = 204 - bulks resource processing canceled\");\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else if (res.statusCode == 404) {\n console.log(\"Error: code = 404 - Resource not found\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n})\n\nreq.on('error', error => {\n console.error(error)\n})\n\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " $uri,\n CURLOPT_CUSTOMREQUEST => 'PUT',\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo \"Bulk with id = {$id} was canceled: \" . var_export($data, true);\n} elseif(404 === $code) {\n echo \"Bulk with id = {$id} not found!\";\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\nbulk_id = \"343c785b-8567-11ea-aa81-96000028b339\"\n\nurl = f'https://api.lox24.eu/bulks/{bulk_id}/cancel'\n\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.put(url, headers=headers, timeout=100)\n if res.status_code != 200: # Ok\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - bullks resource updated')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 400:\n print(\"Error:400 Invalid input\")\n elif res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 404:\n print(\"Error:404 Resource not found\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(res.text)\n print(json.dumps(res.json(), indent=4))\n\n\n", "label": "Python" } ] } }, "/bulks/{id}/status": { "get": { "operationId": "get_status", "tags": [ "bulks" ], "responses": { "200": { "description": "bulks resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.bulks.jsonld-bulk_read_status" } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.bulks-bulk_read_status" } } } }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Retrieves current status of the entry of Bulk", "description": "Getting short info about Bulk status", "parameters": [ { "$ref": "#/components/parameters/path.bulks.id" } ], "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X GET https://api.lox24.eu/bulks/da0fa78c-4699-11ea-a637-96000028b339/status \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var id = \"343c785b-8567-11ea-aa81-96000028b339\";\n\n string url = \"https://api.lox24.eu/bulks/\" + id + \"/status\";\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\"; //or application/ld+json\n httpWebRequest.Method = \"GET\";\n httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n Console.WriteLine(\"Success:{0} {1}\", respCode, \"bulk status resource response\");\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.NotFound: // 404\n Console.WriteLine(\"Error:404 Resource not found\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"GET\"\n\tconst URL = \"https://api.lox24.eu/bulks/981f6497-a03e-11ea-b2e9-b8ca3a65338c/status\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println((string(body)))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tcase 404:\n\t\tfmt.Println(\"Error: code = 404 - Resource not found\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.bulks;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GetBulksItem {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var id = \"343c785b-8567-11ea-aa81-96000028b339\";\n\n var url = \"https://api.lox24.eu/bulks/\" + id + \"/status\";\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .GET()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"bulks resource created\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error: wrong response code \" + httpResponse.statusCode() + \" on create bulk\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_NOT_FOUND: // 404\n System.out.println(\"Error:404 Resource not found\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar id = '4897749e-982d-11ea-aa81-96000028b339';\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/bulks/' + id + '/status',\n method: 'GET',\n headers: {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log('Success: code = 200 - bulks resource response');\n res.on('data', d => { process.stdout.write(d)})\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else if (res.statusCode == 404) {\n console.log(\"Error: code = 404 - Resource not found\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n});\n\nreq.on('error', error => {\n console.error(error)\n});\n\nreq.end();\n\n\n", "label": "JavaScript" }, { "lang": "php", "source": " $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} elseif(404 === $code) {\n echo \"Bulk with id = {$id} not found!\";\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\nbulk_id = \"343c785b-8567-11ea-aa81-96000028b339\"\n\nurl = f'https://api.lox24.eu/bulks/{bulk_id}/status'\n\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - bulks resource response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 404:\n print(\"Error:404 Resource not found\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n", "label": "Python" } ] } }, "/me": { "get": { "operationId": "getAccountInfo", "tags": [ "user" ], "responses": { "200": { "description": "client resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.client.jsonld-get" } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.client-get" } } } }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "User's profile information", "description": "With this interface, you can check your account balance. If you use a pre-paid\nAccount, you get your available balance (excluded VAT). If you have a post-paid account, you get your remaining sms credit\nlimit. The query response also contains information about your available SMS services and your groups.", "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X GET https://api.lox24.eu/me \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string url = \"https://api.lox24.eu/me\";\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\"; // or application/ld+json\n httpWebRequest.Method = \"GET\";\n //httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n Console.WriteLine(\"Success:{0} {1}\", respCode, \"client resource response\");\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n //int errorCode = int.Parse(Regex.Replace(ex.Message, @\"\\D\", \"\"));\n switch (webResponse.StatusCode)\n {\n\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"GET\"\n\tconst URL = \"https://api.lox24.eu/me\"\n\tconst Token = \"1234567:1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println((string(body)))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.user;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GetAccountInfo {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var url = \"https://api.lox24.eu/me\";\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\")\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .GET()\n .build();\n\n var client = HttpClient.newBuilder().build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"client resource response\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error:\" + httpResponse.statusCode());\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/me',\n method: 'GET',\n headers: {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log('Success: code = 200 - client resource response');\n res.on('data', d => {\n process.stdout.write(d)\n })\n } else {\n console.log(`statusCode: ${res.statusCode}`)\n if (res.statusCode == 200) {\n console.log(\"Success: code = 200 - bulks collection response\");\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n }\n});\n\nreq.on('error', error => {\n console.error(error)\n});\n\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\ntoken = \"4f8432430c640ee96c9f8a3eb880d477\"\nclient_id = \"3\"\n\nurl = 'https://api.lox24.eu/me'\n\n\nheaders = {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print('Success: code = 200 - client resource response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n", "label": "Python" } ] } }, "/me/pricelist/{country}": { "get": { "operationId": "getUserPricelist", "tags": [ "pricelist" ], "summary": "Lista de pre\u00e7os personalizada", "description": "Baixe sua lista de pre\u00e7os pessoal com suas tarifas SMS individuais. Retorna um pre\u00e7o \u00fanico por servi\u00e7o com base no seu n\u00edvel de pre\u00e7o. Especifique um c\u00f3digo de pa\u00eds ISO de 2 letras (por exemplo, DE, CH) ou 'all' para todos os pa\u00edses. Requer autentica\u00e7\u00e3o.", "parameters": [ { "name": "country", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z]{2}$|^all$" }, "description": "C\u00f3digo de pa\u00eds ISO de duas letras ou 'all' para todos os pa\u00edses" }, { "name": "format", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "json", "xlsx", "csv" ], "default": "json" }, "description": "Formato de sa\u00edda" }, { "name": "lang", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "en", "de", "es", "pt", "pl" ], "default": "en" }, "description": "Idioma para os nomes dos pa\u00edses" } ], "responses": { "200": { "description": "User-specific price list", "content": { "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "type": "string", "format": "binary" } }, "text/csv": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.user_pricelist" }, "examples": { "user_pricelist": { "$ref": "#/components/examples/user_pricelist" } } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "x-codeSamples": [ { "lang": "bash", "source": "curl -s 'https://api.lox24.eu/me/pricelist/de?lang=de' -H 'X-LOX24-AUTH-TOKEN: YOUR_API_TOKEN' | jq\n", "label": "Bash - Get user prices for Germany" }, { "lang": "bash", "source": "curl -s 'https://api.lox24.eu/me/pricelist/all?format=xlsx&lang=de' -H 'X-LOX24-AUTH-TOKEN: YOUR_API_TOKEN' -o lox24_user_pricelist_all.xlsx\n", "label": "Bash - Download all user prices in Excel" }, { "lang": "csharp", "source": "using System;\nusing System.Net.Http;\nusing System.Net.Http.Headers;\nusing System.Threading.Tasks;\n\nclass Program\n{\n static async Task Main()\n {\n using var client = new HttpClient();\n client.DefaultRequestHeaders.Add(\"X-LOX24-AUTH-TOKEN\", \"YOUR_API_TOKEN\");\n\n string url = \"https://api.lox24.eu/me/pricelist/de?lang=de\";\n var response = await client.GetStringAsync(url);\n Console.WriteLine(response);\n }\n}\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io\"\n\t\"net/http\"\n)\n\nfunc main() {\n\turl := \"https://api.lox24.eu/me/pricelist/de?lang=de\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\treq.Header.Set(\"X-LOX24-AUTH-TOKEN\", \"YOUR_API_TOKEN\")\n\n\tresp, _ := http.DefaultClient.Do(req)\n\tdefer resp.Body.Close()\n\n\tbody, _ := io.ReadAll(resp.Body)\n\tfmt.Println(string(body))\n}\n", "label": "Go" }, { "lang": "java", "source": "import java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\n\npublic class Main {\n public static void main(String[] args) throws Exception {\n var url = \"https://api.lox24.eu/me/pricelist/de?lang=de\";\n\n var request = HttpRequest.newBuilder()\n .uri(URI.create(url))\n .header(\"X-LOX24-AUTH-TOKEN\", \"YOUR_API_TOKEN\")\n .GET()\n .build();\n\n var response = HttpClient.newHttpClient()\n .send(request, HttpResponse.BodyHandlers.ofString());\n\n System.out.println(response.body());\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const url = 'https://api.lox24.eu/me/pricelist/de?lang=de';\n\nfetch(url, {\n headers: {\n 'X-LOX24-AUTH-TOKEN': 'YOUR_API_TOKEN'\n }\n})\n.then(response => response.json())\n.then(data => console.log(JSON.stringify(data, null, 2)));\n", "label": "JavaScript" }, { "lang": "php", "source": " {\n let data = '';\n res.on('data', chunk => data += chunk);\n res.on('end', () => {\n if (res.statusCode === 200) {\n console.log(JSON.parse(data));\n } else {\n console.log(`Error: ${res.statusCode}`);\n console.log(data);\n }\n });\n}).on('error', err => {\n console.error(err);\n});\n", "label": "JavaScript" }, { "lang": "php", "source": " $uri,\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, true);\n\nif (200 === $code) {\n echo json_encode($data, JSON_PRETTY_PRINT);\n} else {\n echo \"Error: code = {$code}\\n\" . $response;\n}\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\nurl = 'https://api.lox24.eu/pricelist/de'\nparams = {'currency': 'chf', 'lang': 'de'}\n\ntry:\n res = requests.get(url, params=params, timeout=100)\n res.raise_for_status()\n print(json.dumps(res.json(), indent=4))\nexcept requests.HTTPError:\n print(f'Error: {res.status_code}')\n print(res.text)\n", "label": "Python" } ] } }, "/invoices": { "get": { "operationId": "getInvoices", "tags": [ "invoices" ], "responses": { "200": { "description": "Invoice collection", "content": { "application/ld+json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "@context": { "oneOf": [ { "type": "string" }, { "type": "object" } ], "description": "JSON-LD context" }, "@id": { "type": "string", "description": "JSON-LD ID" }, "@type": { "type": "string", "description": "JSON-LD type" }, "member": { "type": "array", "items": { "$ref": "#/components/schemas/schema.invoice.jsonld-invoice_read_item" } }, "hydra:totalItems": { "$ref": "#/components/schemas/hydra.totalItems" }, "hydra:view": { "$ref": "#/components/schemas/hydra.view" }, "hydra:search": { "$ref": "#/components/schemas/hydra.search" } } }, "examples": { "invoices_jsonld": { "$ref": "#/components/examples/invoices.jsonld" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/schema.invoice-invoice_read_item" } }, "examples": { "invoices_json": { "$ref": "#/components/examples/invoices" } } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Listar faturas", "description": "Retorna uma lista paginada de faturas para o usu\u00e1rio autenticado. Suporta filtragem por status, tipo de pagamento, intervalo de datas, intervalo de valor e IDs espec\u00edficos.", "parameters": [ { "$ref": "#/components/parameters/filter.common.page" }, { "$ref": "#/components/parameters/order.common.created_at" }, { "$ref": "#/components/parameters/order.accounting.amount" }, { "$ref": "#/components/parameters/filter.accounting.status.exact" }, { "$ref": "#/components/parameters/filter.accounting.payment_type.exact" }, { "$ref": "#/components/parameters/filter.accounting.id.exact" }, { "$ref": "#/components/parameters/filter.accounting.id.array" }, { "$ref": "#/components/parameters/filter.accounting.created_at.exact" }, { "$ref": "#/components/parameters/filter.accounting.created_at.array" }, { "$ref": "#/components/parameters/filter.accounting.amount.exact" }, { "$ref": "#/components/parameters/filter.accounting.amount.array" }, { "$ref": "#/components/parameters/filter.accounting.paid_at.exact" }, { "$ref": "#/components/parameters/filter.accounting.paid_at.array" }, { "$ref": "#/components/parameters/filter.accounting.paid_at.exists" } ], "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "curl -s 'https://api.lox24.eu/invoices' -H 'X-LOX24-AUTH-TOKEN: YOUR_API_TOKEN' | jq\n", "label": "Bash - List invoices" }, { "lang": "csharp", "source": "using System;\nusing System.Net.Http;\nusing System.Net.Http.Headers;\nusing System.Threading.Tasks;\n\nclass Program\n{\n static async Task Main()\n {\n using var client = new HttpClient();\n client.DefaultRequestHeaders.Add(\"X-LOX24-AUTH-TOKEN\", \"YOUR_API_TOKEN\");\n\n var response = await client.GetStringAsync(\"https://api.lox24.eu/invoices\");\n Console.WriteLine(response);\n }\n}\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io\"\n\t\"net/http\"\n)\n\nfunc main() {\n\treq, _ := http.NewRequest(\"GET\", \"https://api.lox24.eu/invoices\", nil)\n\treq.Header.Set(\"X-LOX24-AUTH-TOKEN\", \"YOUR_API_TOKEN\")\n\n\tresp, _ := http.DefaultClient.Do(req)\n\tdefer resp.Body.Close()\n\tbody, _ := io.ReadAll(resp.Body)\n\tfmt.Println(string(body))\n}\n", "label": "Go" }, { "lang": "java", "source": "import java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\n\npublic class Main {\n public static void main(String[] args) throws Exception {\n var client = HttpClient.newHttpClient();\n var request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://api.lox24.eu/invoices\"))\n .header(\"X-LOX24-AUTH-TOKEN\", \"YOUR_API_TOKEN\")\n .GET()\n .build();\n\n var response = client.send(request, HttpResponse.BodyHandlers.ofString());\n System.out.println(response.body());\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "fetch('https://api.lox24.eu/invoices', {\n headers: { 'X-LOX24-AUTH-TOKEN': 'YOUR_API_TOKEN' }\n})\n.then(res => res.json())\n.then(console.log);\n", "label": "JavaScript" }, { "lang": "php", "source": " res.json())\n.then(console.log);\n", "label": "JavaScript" }, { "lang": "php", "source": " res.blob())\n.then(blob => {\n const url = URL.createObjectURL(blob);\n const a = document.createElement('a');\n a.href = url;\n a.download = 'invoice.pdf';\n a.click();\n});\n", "label": "JavaScript" }, { "lang": "php", "source": " r.json()).then(console.log)\n", "label": "JavaScript" }, { "lang": "php", "source": " r.json()).then(console.log)\n", "label": "JavaScript" }, { "lang": "php", "source": " r.blob()).then(b => { /* save blob */ })\n", "label": "JavaScript" }, { "lang": "php", "source": " res.json())\n.then(console.log);\n", "label": "JavaScript" }, { "lang": "php", "source": " res.json())\n.then(console.log);\n", "label": "JavaScript" }, { "lang": "php", "source": " 100.00, 'type' => 'stored_card', 'method_id' => 94]);\n\n$ch = curl_init('https://api.lox24.eu/payments');\ncurl_setopt($ch, CURLOPT_HTTPHEADER, [\n 'X-LOX24-AUTH-TOKEN: YOUR_API_TOKEN',\n 'Content-Type: application/json'\n]);\ncurl_setopt($ch, CURLOPT_POST, true);\ncurl_setopt($ch, CURLOPT_POSTFIELDS, $data);\ncurl_setopt($ch, CURLOPT_RETURNTRANSFER, true);\n\n$response = curl_exec($ch);\ncurl_close($ch);\n\necho $response;\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import requests\nimport json\n\nresponse = requests.post(\n 'https://api.lox24.eu/payments',\n headers={\n 'X-LOX24-AUTH-TOKEN': 'YOUR_API_TOKEN',\n 'Content-Type': 'application/json'\n },\n data=json.dumps({'net_val': 100.00, 'type': 'stored_card', 'method_id': 94})\n)\nprint(response.json())\n", "label": "Python" } ] } }, "/payments/{id}": { "get": { "operationId": "getPayment", "tags": [ "payments" ], "summary": "Obter status do pagamento", "description": "Retorna informa\u00e7\u00f5es detalhadas sobre uma tentativa de pagamento espec\u00edfica. Requer autentica\u00e7\u00e3o; retorna apenas tentativas de pagamento pertencentes ao usu\u00e1rio autenticado.", "parameters": [ { "$ref": "#/components/parameters/path.accounting.payment_id" } ], "responses": { "200": { "description": "Payment details", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.payment.jsonld-payment_read" }, "examples": { "payment_jsonld": { "$ref": "#/components/examples/payment.jsonld" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.payment-payment_read" }, "examples": { "payment_json": { "$ref": "#/components/examples/payment" } } } } }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "curl -s 'https://api.lox24.eu/payments/123' -H 'X-LOX24-AUTH-TOKEN: YOUR_API_TOKEN' | jq\n", "label": "Bash - Get payment status" }, { "lang": "csharp", "source": "using System;\nusing System.Net.Http;\nusing System.Net.Http.Headers;\nusing System.Threading.Tasks;\n\nclass Program\n{\n static async Task Main()\n {\n using var client = new HttpClient();\n client.DefaultRequestHeaders.Add(\"X-LOX24-AUTH-TOKEN\", \"YOUR_API_TOKEN\");\n\n var response = await client.GetStringAsync(\"https://api.lox24.eu/payments/123\");\n Console.WriteLine(response);\n }\n}\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io\"\n\t\"net/http\"\n)\n\nfunc main() {\n\treq, _ := http.NewRequest(\"GET\", \"https://api.lox24.eu/payments/123\", nil)\n\treq.Header.Set(\"X-LOX24-AUTH-TOKEN\", \"YOUR_API_TOKEN\")\n\n\tresp, _ := http.DefaultClient.Do(req)\n\tdefer resp.Body.Close()\n\tbody, _ := io.ReadAll(resp.Body)\n\tfmt.Println(string(body))\n}\n", "label": "Go" }, { "lang": "java", "source": "import java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\n\npublic class Main {\n public static void main(String[] args) throws Exception {\n var client = HttpClient.newHttpClient();\n var request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://api.lox24.eu/payments/123\"))\n .header(\"X-LOX24-AUTH-TOKEN\", \"YOUR_API_TOKEN\")\n .GET()\n .build();\n\n var response = client.send(request, HttpResponse.BodyHandlers.ofString());\n System.out.println(response.body());\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "fetch('https://api.lox24.eu/payments/123', {\n headers: { 'X-LOX24-AUTH-TOKEN': 'YOUR_API_TOKEN' }\n})\n.then(res => res.json())\n.then(console.log);\n", "label": "JavaScript" }, { "lang": "php", "source": " res.json())\n.then(console.log);\n", "label": "JavaScript" }, { "lang": "php", "source": " {\n if (res.statusCode == 200) {\n console.log('Success: code = 200 - request resource response');\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n\n});\n\nreq.on('error', error => {\n console.error(error)\n});\n\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " '@lox24.eu',\n 'id' => [\n '8481900d-86ce-11ea-aa81-96000028b339',\n 'd5ceb189-86cd-11ea-aa81-96000028b339',\n ],\n 'page' => 1,\n '_order' => [\n 'created_at' => 'asc'\n ],\n];\n\n$uri .= $filters ? '?' . http_build_query($filters) : '';\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_URL => $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: $token\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = $code, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\nurl = 'https://api.lox24.eu/fraud-checks?created_at[gte]=1590737094&request_email.email=lox24.eu'\n\n\nheaders = {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - Fraud request collection response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n", "label": "Python" } ] }, "post": { "operationId": "api_fraud-check_post_collection", "tags": [ "fraud-detection" ], "responses": { "201": { "description": "fraud-check resource created", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.fraud-check.jsonld-fraud_request_read" } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.fraud-check-fraud_request_read" } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "402": { "description": "There are not enough funds on your account!" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "422": { "$ref": "#/components/responses/422-unprocessable-entity" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Creates a new Fraud Check request", "description": "Send a Fraud Check request and get risk score value back.", "parameters": [], "requestBody": { "description": "The new fraud-check resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schema.fraud-check-fraud_request_write" } } }, "required": true }, "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X POST https://api.lox24.eu/fraud-checks \\\n -H 'Content-Type: application/json' \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx' \\\n -d '{\n \"service_code\": \"direct\",\n \"phone\": \"+49751234567\",\n \"email\": \"test@lox24.de\",\n \"ip\": \"1.1.1.1\",\n \"address\": {\n \"iso2\": \"DE\",\n \"city\": \"Berlin\",\n \"postcode\": \"13353\",\n \"street_number\": \"109\",\n \"street_name\": \"Seestra\u00dfe\"\n }\n\n}'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json;\nusing Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string url = \"https://api.lox24.eu/fraud-checks\";\n\n var data = new {\n service_code = \"direct\",\n phone = \"+49751234567\",\n email = \"test@lox24.de\",\n ip = \"1.1.1.1\",\n address = new {\n iso2 = \"DE\",\n city = \"Berlin\",\n postcode = \"13353\",\n street_number = \"109\",\n street_name = \"Seestra\u00dfe\"\n }\n };\n\n string postdata = JsonConvert.SerializeObject(data);\n\n Console.WriteLine(\"Post data: {0}\", postdata);\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.ContentType = \"application/json; charset=utf-8\";\n httpWebRequest.Accept = \"application/json\"; // or application/ld+json\n httpWebRequest.Method = \"POST\";\n httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n using (var streamWriter = new StreamWriter(httpWebRequest.GetRequestStream()))\n {\n streamWriter.Write(postdata);\n streamWriter.Flush();\n streamWriter.Close();\n }\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n\n if(resp.StatusCode == HttpStatusCode.Created) {\n Console.WriteLine(\"Success:{0} {1}\", (int)resp.StatusCode, \"sms resource created\");\n } else {\n Console.WriteLine(\"Error: wrong response code {0} on create sms\", (int)resp.StatusCode);\n }\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.BadRequest: // 400\n Console.WriteLine(\"Error:400 Invalid input\");\n break;\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.PaymentRequired: // 402\n Console.WriteLine(\"Error:402 There are not enough funds on your account!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.NotFound: // 404\n Console.WriteLine(\"Error:404 Resource not found\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"bytes\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"POST\"\n\tconst URL = \"https://api.lox24.eu/fraud-checks\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\taddress := map[string]interface{}{\n\t\t\"iso2\": \"DE\",\n\t\t\"city\": \"Berlin\",\n\t\t\"postcode\": \"13353\",\n\t\t\"street_number\": \"109\",\n\t\t\"street_name\": \"Seestra\u00dfe\",\n\t}\n\tpayload := map[string]interface{}{\n\t\t\"service_code\": \"direct\",\n\t\t\"phone\": \"+49751234567\",\n\t\t\"email\": \"test@lox24.de\",\n\t\t\"ip\": \"1.1.1.1\",\n\t\t\"address\": address,\n\t}\n\n\tjsonPayload, _ := json.Marshal(payload)\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, bytes.NewBuffer(jsonPayload))\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Content-Type\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 201:\n\t\tfmt.Println((string(body)))\n\tcase 400:\n\t\tfmt.Println(\"Error: code = 400 - Invalid input\")\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.fraud_checks;\n\nimport org.json.JSONObject;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class PostFraudRequestCollection {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var url = \"https://api.lox24.eu/fraud-checks\";\n\n var address = new JSONObject();\n json.put(\"iso2\", \"DE\");\n json.put(\"city\", \"Berlin\");\n json.put(\"postcode\", \"13353\");\n json.put(\"street_number\", \"109\");\n json.put(\"street_name\", \"Seestra\u00dfe\");\n\n var json = new JSONObject();\n\t\tjson.put(\"service_code\", \"direct\");\n\t\tjson.put(\"phone\", \"+49751234567\");\n\t\tjson.put(\"email\", \"test@lox24.de\");\n\t\tjson.put(\"ip\", \"1.1.1.1\");\n\t\tjson.put(\"address\", address);\n\n var postData = json.toString();\n\n System.out.println(\"Post data: \" + postData);\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Content-Type\", \"application/json; charset=utf-8\")\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .POST(HttpRequest.BodyPublishers.ofString(postData))\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_CREATED) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"request created\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error: wrong response code \" + httpResponse.statusCode() + \" on create request\");\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_BAD_REQUEST: // 400\n System.out.println(\"Error:400 Invalid input\");\n break;\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_PAYMENT_REQUIRED: // 402\n System.out.println(\"Error:402 There are not enough funds on your account!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const token = \"7b7c6063bab885ce79814b5ff1ee6885\";\n\nlet postObj = {\n\t\"service_code\": \"direct\",\n\t\"phone\": \"+49751234567\",\n\t\"email\": \"test@lox24.de\",\n\t\"ip\": \"1.1.1.1\",\n \"address\": {\n \"iso2\": \"DE\",\n \"city\": \"Berlin\",\n \"postcode\": \"13353\",\n \"street_number\": \"109\",\n \"street_name\": \"Seestra\u00dfe\"\n }\n};\n\nlet postdata = JSON.stringify(postObj);\n\nconst https = require('https');\nconst options = {\n hostname: 'api.lox24.eu',\n path: '/fraud-checks',\n method: 'POST',\n headers: {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'Content-Length': postdata.length,\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 201) {\n console.log(\"Success: code = 201 - request resource created\");\n res.on('data', d => { process.stdout.write(d) })\n }\n else if (res.statusCode == 400) console.log(\"Error: code = 400 - Invalid input\");\n else if (res.statusCode == 401) console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n else if (res.statusCode == 402) console.log(\"Error: code = 402 - There are not enough funds on your account!\");\n else if (res.statusCode == 403) console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n})\n\nreq.on('error', error => {\n console.error(error)\n})\nreq.write(postdata);\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " 'direct',\n 'phone' => '+49751234567',\n 'email' => 'test@lox24.de',\n 'ip' => '1.1.1.1',\n 'address' => [\n 'iso2' => 'DE',\n 'city' => 'Berlin',\n 'postcode' => '13353',\n 'street_number' => '109',\n 'street_name' => 'Seestra\u00dfe',\n ],\n];\n\nif (!$body = json_encode($body)) {\n die('JSON encoding error!');\n}\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_POST => true,\n CURLOPT_URL => $uri,\n CURLOPT_POSTFIELDS => $body,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: $token\",\n 'Accept: application/json', // or application/ld+json\n 'Content-Type: application/json',\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif (201 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = $code, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\nurl = 'https://api.lox24.eu/fraud-checks'\n\n\ndata = {\n\t'service_code': 'direct',\n\t'phone': '+49751234567',\n\t'email': 'test@lox24.de',\n\t'ip': '1.1.1.1',\n 'address': {\n 'iso2': 'DE',\n 'city': 'Berlin',\n 'postcode': '13353',\n 'street_number': '109',\n 'street_name': 'Seestra\u00dfe'\n }\n}\n\n\nheaders = {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\nprint(\"Post data : \", json.dumps(data, indent=4))\n\ntry:\n # timeout is 100 seconds, the payload is automatically converted to json format\n res = requests.post(url, headers=headers, json=data, timeout=100)\n if res.status_code != 201: # Created\n print(\"Error: Wrong response code on create sms\")\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - Fraud request resource created')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 400:\n print(\"Error:400 Invalid input\")\n elif res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 402:\n print(\"Error:402 There are not enough funds on your account!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 404:\n print(\"Error:404 Resource not found\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n\n", "label": "Python" } ] } }, "/fraud-checks/{id}": { "get": { "operationId": "api_fraud-check_get_item", "tags": [ "fraud-detection" ], "responses": { "200": { "description": "fraud-check resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.fraud-check.jsonld-fraud_request_read" } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.fraud-check-fraud_request_read" } } } }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Retrieve Fraud Check request", "description": "Returns the data of a specific Fraud Check request", "parameters": [ { "$ref": "#/components/parameters/path.fraud-check.id" } ], "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl https://api.lox24.eu/fraud-checks/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee \\\n -H 'Content-Type: application/json' \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\n var id = \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\";\n string url = \"https://api.lox24.eu/fraud-checks/\" + id;\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\"; //or application/ld+json\n httpWebRequest.Method = \"GET\";\n httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n Console.WriteLine(\"Success:{0} {1}\", respCode, \"item resource response\");\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.NotFound: // 404\n Console.WriteLine(\"Error:404 Resource not found\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"GET\"\n\tconst URL = \"https://api.lox24.eu/fraud-checks/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println((string(body)))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tcase 404:\n\t\tfmt.Println(\"Error: code = 404 - Resource not found\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.fraud_checks;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GetBulksItem {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var id = \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\";\n\n var url = \"https://api.lox24.eu/fraud-checks/\" + id;\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .GET()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode());\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error: wrong response code \" + httpResponse.statusCode());\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_NOT_FOUND: // 404\n System.out.println(\"Error:404 Resource not found\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nconst id = 'aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee';\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/fraud-checks/' + id,\n method: 'GET',\n headers: {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log('Success: code = 200');\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else if (res.statusCode == 404) {\n console.log(\"Error: code = 404 - Resource not found\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n\n})\n\nreq.on('error', error => {\n console.error(error)\n})\n\nreq.end();\n\n", "label": "JavaScript" }, { "lang": "php", "source": " $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: $token\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} elseif(404 === $code) {\n echo \"Request with id = $id not found!\";\n} else {\n echo \"Error: code = $code, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\nsms_id = \"11111111-2222-3333-4444-55555555555\"\n\nurl = f'https://api.lox24.eu/fraud-checks/{sms_id}'\n\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - Fraud request resource response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 404:\n print(\"Error:404 Resource not found\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n\n", "label": "Python" } ] }, "delete": { "operationId": "api_fraud-check_delete_item", "tags": [ "fraud-detection" ], "responses": { "204": { "$ref": "#/components/responses/204-deleted" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Delete a specific previous Fraud Check request", "description": "Remove all information about a previous Fraud Check request.", "parameters": [ { "$ref": "#/components/parameters/path.fraud-check.id" } ], "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X DELETE https://api.lox24.eu/fraud-checks/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee \\\n -H 'Content-Type: application/json' \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\n var id = \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\";\n string url = \"https://api.lox24.eu/fraud-checks/\" + id;\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\";\n httpWebRequest.Method = \"DELETE\";\n //httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n if(resp.StatusCode == HttpStatusCode.NoContent) { //204\n Console.WriteLine(\"Success: sms was deleted\");\n } else {\n Console.WriteLine(\"Error: something went wrong, code({0})\", respCode);\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n\n JObject parsed = JObject.Parse(responseText);\n\n foreach (var pair in parsed)\n {\n Console.WriteLine(\"{0}: {1}\", pair.Key, pair.Value);\n }\n }\n }\n\n }\n\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.NotFound: // 404\n Console.WriteLine(\"Error:404 Resource not found\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"DELETE\"\n\tconst URL = \"https://api.lox24.eu/fraud-checks/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tswitch res.StatusCode {\n\tcase 204:\n\t\tfmt.Println(\"Fraud request was deleted!\")\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tcase 404:\n\t\tfmt.Println(\"Error: code = 404 - Resource not found\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.fraud_checks;\n\nimport org.json.JSONObject;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class DeleteFraudRequestItem {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\n var id = \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\";\n var url = \"https://api.lox24.eu/fraud-checks/\" + id;\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .DELETE()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_NO_CONTENT) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"request was deleted.\");\n } else {\n System.out.println(\"Error: something went wrong, code(\" + httpResponse.statusCode() + \")\");\n\n JSONObject parsed = new JSONObject(httpResponse.body());\n\n parsed.keys().forEachRemaining(jsonKey -> System.out.println(jsonKey + \":\" + parsed.get(jsonKey)));\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_NOT_FOUND: // 404\n System.out.println(\"Error:404 Resource not found\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nlet id = 'aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee';\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/fraud-checks/' + id,\n method: 'DELETE',\n headers: {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 204) {\n console.log('Success: code = 204 - fraud request resource deleted');\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else if (res.statusCode == 404) {\n console.log(\"Error: code = 404 - Resource not found\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n});\n\nreq.on('error', error => {\n console.error(error)\n});\n\nreq.end();\n\n", "label": "JavaScript" }, { "lang": "php", "source": " $uri,\n CURLOPT_CUSTOMREQUEST => 'DELETE',\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: $token\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\nif(204 === $code) {\n echo \"Fraud check request with id = $id was deleted!\";\n} elseif(404 === $code) {\n echo \"Fraud check request with id = $id not found!\";\n} else {\n $data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n echo \"Fraud check request: code = $code, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\nsms_id = \"11111111-2222-3333-4444-55555555555\"\n\nurl = f'https://api.lox24.eu/fraud-checks/{sms_id}'\n\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.delete(url, headers=headers, timeout=100)\n if res.status_code != 204: # No Content\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - Fraud request was deleted')\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 404:\n print(\"Error:404 Resource not found\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n\n", "label": "Python" } ] } }, "/groups": { "get": { "operationId": "api_groups_get_collection", "tags": [ "groups" ], "responses": { "200": { "description": "groups collection", "content": { "application/ld+json": { "schema": { "type": "object", "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/schema.groups.jsonld-group_read" } }, "hydra:totalItems": { "type": "integer", "minimum": 0 }, "hydra:view": { "$ref": "#/components/schemas/hydra.view" }, "hydra:search": { "$ref": "#/components/schemas/hydra.search" } }, "required": [ "member" ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/schema.groups-group_read" } } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Recupera a cole\u00e7\u00e3o de Grupos", "description": "Retorna todos os seus grupos (lista de distribui\u00e7\u00e3o SMS).", "parameters": [ { "$ref": "#/components/parameters/filter.common.page" } ], "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X GET https://api.lox24.eu/groups \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string url = \"https://api.lox24.eu/groups?page=1\";\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\"; // or \"application/ld+json\"\n httpWebRequest.Method = \"GET\";\n //httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n Console.WriteLine(\"Success:{0} {1}\", respCode, \"groups collection response\");\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"GET\"\n\tconst URL = \"https://api.lox24.eu/groups?page=1\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println((string(body)))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.group;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GetGroupsCollection {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var url = \"https://api.lox24.eu/groups?page=1\";\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .GET()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"groups collection response\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n } else {\n System.out.println(\"Error: something went wrong, code(\" + httpResponse.statusCode() + \")\");\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar query = \"page=1\";\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/groups?' + query,\n method: 'GET',\n headers: {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log('Success: code = 200 - groups list response');\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n\n});\n\nreq.on('error', error => {\n console.error(error)\n});\n\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " 1,\n];\n\n$uri .= $filters ? '?' . http_build_query($filters) : '';\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_URL => $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\nurl = \"https://api.lox24.eu/groups?page=1\"\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - groups collection response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n", "label": "Python" } ] }, "post": { "operationId": "api_groups_post_collection", "tags": [ "groups" ], "responses": { "201": { "description": "groups resource created", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.groups.jsonld-group_read" } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.groups-group_read" } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "422": { "$ref": "#/components/responses/422-unprocessable-entity" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Criar um Grupo", "description": "Com este comando voc\u00ea cria uma lista de mailing SMS que \u00e9 armazenada em nosso sistema para voc\u00ea. Uma lista de mailing tem um nome, uma descri\u00e7\u00e3o e cinco colunas adicionais que voc\u00ea pode adicionar al\u00e9m do n\u00famero de telefone.", "parameters": [], "requestBody": { "description": "The new groups resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schema.groups-write" } } }, "required": true }, "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X POST https://api.lox24.eu/groups \\\n -H 'Content-Type: application/json' \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx' \\\n -d '{\n \"name\": \"My Clients\",\n \"description\": \"Best clients\",\n \"name_a\": \"prefix\",\n \"name_b\": \"name\",\n \"name_c\": \"datetime\",\n \"name_d\": \"price\",\n \"name_e\": \"something_else\"\n}'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json;\nusing Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string url = \"https://api.lox24.eu/groups\";\n\n\n var data = new {\n name = \"My Clients\",\n description = \"Best clients\",\n name_a = \"prefix\",\n name_b = \"name\",\n name_c = \"datetime\",\n name_d = \"price\",\n name_e = \"something_else\"\n };\n\n string postdata = JsonConvert.SerializeObject(data);\n\n Console.WriteLine(\"Post data: {0}\", postdata);\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.ContentType = \"application/json; charset=utf-8\";\n httpWebRequest.Accept = \"application/json\"; // or application/ld+json\n httpWebRequest.Method = \"POST\";\n httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n using (var streamWriter = new StreamWriter(httpWebRequest.GetRequestStream()))\n {\n streamWriter.Write(postdata);\n streamWriter.Flush();\n streamWriter.Close();\n }\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n\n if(resp.StatusCode == HttpStatusCode.Created) {\n Console.WriteLine(\"Success:{0} {1}\", (int)resp.StatusCode, \"group resource created\");\n } else {\n Console.WriteLine(\"Error: wrong response code {0} on create group\", (int)resp.StatusCode);\n }\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.BadRequest: // 400\n Console.WriteLine(\"Error:400 Invalid input\");\n break;\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"bytes\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"POST\"\n\tconst URL = \"https://api.lox24.eu/groups\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tpayload := map[string]interface{}{\n\t\t\"name\": \"My Clients\",\n\t\t\"description\": \"Best clients\",\n\t\t\"name_a\": \"prefix\",\n\t\t\"name_b\": \"name\",\n\t\t\"name_c\": \"datetime\",\n\t\t\"name_d\": \"price\",\n\t\t\"name_e\": \"something_else\",\n\t}\n\n\tjsonPayload, _ := json.Marshal(payload)\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, bytes.NewBuffer(jsonPayload))\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Content-Type\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 201:\n\t\tfmt.Println((string(body)))\n\tcase 400:\n\t\tfmt.Println(\"Error: code = 400 - Invalid input\")\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.group;\n\nimport org.json.JSONObject;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class PostGroupCollection {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var url = \"https://api.lox24.eu/groups\";\n\n var json = new JSONObject();\n json.put(\"name\", \"My Clients\");\n json.put(\"description\", \"Best clients\");\n json.put(\"name_a\", \"prefix\");\n json.put(\"name_b\", \"name\");\n json.put(\"name_c\", \"datetime\");\n json.put(\"name_d\", \"price\");\n json.put(\"name_e\", \"something_else\");\n\n var postData = json.toString();\n\n System.out.println(\"Post data: \" + postData);\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Content-Type\", \"application/json; charset=utf-8\")\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .POST(HttpRequest.BodyPublishers.ofString(postData))\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_CREATED) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"group resource created\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error: wrong response code \" + httpResponse.statusCode() + \" on create group\");\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_BAD_REQUEST: // 400\n System.out.println(\"Error:400 Invalid input\");\n break;\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar postObj = {\n sender_id: 'My Sender',\n text: 'Test message',\n service_code: 'direct',\n phone: '+49751234567',\n delivery_at: 1573724611,\n is_unicode: true\n};\n\nvar postdata = JSON.stringify(postObj);\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/groups',\n method: 'POST',\n headers: {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'Content-Length': postdata.length,\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 201) {\n console.log(\"Success: code = 201 - group resource created\");\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 400) {\n console.log(\"Error: code = 400 - Invalid input\");\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 402) {\n console.log(\"Error: code = 402 - There are not enough funds on your account!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n})\n\nreq.on('error', error => {\n console.error(error)\n})\nreq.write(postdata);\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " \"My Clients\",\n \"description\" => \"Best clients\",\n \"name_a\" => \"prefix\",\n \"name_b\" => \"name\",\n \"name_c\" => \"datetime\",\n \"name_d\" => \"price\",\n \"name_e\" => \"something_else\",\n];\n\nif(!$body = json_encode($body)) {\n die('JSON encoding error!');\n}\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_POST => true,\n CURLOPT_URL => $uri,\n CURLOPT_POSTFIELDS => $body,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n 'Content-Type: application/json',\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(201 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\nurl = 'https://api.lox24.eu/groups'\n\n\ndata = {\n 'name': 'My Clients',\n 'description': 'Best clients',\n 'name_a': 'prefix',\n 'name_b': 'name',\n 'name_c': 'datetime',\n 'name_d': 'price',\n 'name_e': 'something_else'\n}\n\nheaders = {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\nprint(\"Post data : \", json.dumps(data, indent=4))\n\ntry:\n # timeout is 100 seconds, the payload is automatically converted to json format\n res = requests.post(url, headers=headers, json=data, timeout=100)\n if res.status_code != 201: # Created\n print(\"Error: Wrong response code on create group\")\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - group resource created')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 400:\n print(\"Error:400 Invalid input\")\n elif res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 402:\n print(\"Error:402 There are not enough funds on your account!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n\n", "label": "Python" } ] } }, "/groups/{id}": { "get": { "operationId": "api_groups_get_item", "tags": [ "groups" ], "responses": { "200": { "description": "groups resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.groups.jsonld-group_read" } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.groups-group_read" } } } }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Recupera a entrada de Grupos", "description": "Retorna os dados do grupo espec\u00edfico, como nome do grupo e da coluna.", "parameters": [ { "$ref": "#/components/parameters/path.groups.id" } ], "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl https://api.lox24.eu/groups/12344 \\\n -H 'Content-Type: application/json' \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var id = \"12344\";\n\n string url = \"https://api.lox24.eu/groups/\" + id;\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\"; //or application/ld+json\n httpWebRequest.Method = \"GET\";\n httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n Console.WriteLine(\"Success:{0} {1}\", respCode, \"groups resource response\");\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.NotFound: // 404\n Console.WriteLine(\"Error:404 Resource not found\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"GET\"\n\tconst URL = \"https://api.lox24.eu/groups/12344\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println((string(body)))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tcase 404:\n\t\tfmt.Println(\"Error: code = 404 - Resource not found\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.group;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GetGroupItem {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var userId = \"1234567\";\n var id = \"12344\";\n\n var url = \"https://api.lox24.eu/groups/\" + id;\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .GET()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode());\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error: wrong response code \" + httpResponse.statusCode());\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_NOT_FOUND: // 404\n System.out.println(\"Error:404 Resource not found\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar id = '12344';\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/groups/' + id,\n method: 'GET',\n headers: {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log('Success: code = 200');\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else if (res.statusCode == 404) {\n console.log(\"Error: code = 404 - Resource not found\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n\n})\n\nreq.on('error', error => {\n console.error(error)\n})\n\nreq.end();\n\n", "label": "JavaScript" }, { "lang": "php", "source": " $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} elseif(404 === $code) {\n echo \"Group with id = {$id} not found!\";\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\nid = \"12344\"\n\nurl = f'https://api.lox24.eu/groups/{id}'\n\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - group resource response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 404:\n print(\"Error:404 Resource not found\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n\n", "label": "Python" } ] }, "put": { "operationId": "api_groups_put_item", "tags": [ "groups" ], "responses": { "200": { "description": "groups resource updated", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.groups.jsonld-group_read" } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.groups-group_read" } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "422": { "$ref": "#/components/responses/422-unprocessable-entity" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Editar um Grupo", "description": "Alterar a configura\u00e7\u00e3o de um grupo, como o nome do grupo ou descri\u00e7\u00e3o.", "parameters": [ { "$ref": "#/components/parameters/path.groups.id" } ], "requestBody": { "description": "The updated groups resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schema.groups-write" } } }, "required": true }, "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X PUT https://api.lox24.eu/groups/12344 \\\n -H 'Content-Type: application/json' \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx' \\\n -d '{\n \"name\": \"My Clients\",\n \"description\": \"Best clients\",\n \"name_a\": \"prefix\",\n \"name_b\": \"name\",\n \"name_c\": \"datetime\",\n \"name_d\": \"price\",\n \"name_e\": \"something_else\"\n}'\n", "label": "Bash" }, { "lang": "csharp", "source": "\nusing Newtonsoft.Json;\nusing Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string url = \"https://api.lox24.eu/groups/12344\";\n\n\n var data = new {\n name = \"New group name\"\n };\n\n string postdata = JsonConvert.SerializeObject(data);\n\n Console.WriteLine(\"Post data: {0}\", postdata);\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.ContentType = \"application/json; charset=utf-8\";\n httpWebRequest.Accept = \"application/json\"; // or application/ld+json\n httpWebRequest.Method = \"POST\";\n httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n using (var streamWriter = new StreamWriter(httpWebRequest.GetRequestStream()))\n {\n streamWriter.Write(postdata);\n streamWriter.Flush();\n streamWriter.Close();\n }\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n\n if(resp.StatusCode == HttpStatusCode.Created) {\n Console.WriteLine(\"Success:{0} {1}\", (int)resp.StatusCode, \"group resource created\");\n } else {\n Console.WriteLine(\"Error: wrong response code {0} on create group\", (int)resp.StatusCode);\n }\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.BadRequest: // 400\n Console.WriteLine(\"Error:400 Invalid input\");\n break;\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.NotFound: // 404\n Console.WriteLine(\"Error:404 Resource not found\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"bytes\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"PUT\"\n\tconst URL = \"https://api.lox24.eu/groups/12344\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tpayload := map[string]interface{}{\n\t\t\"name\": \"New group name\",\n\t}\n\n\tjsonPayload, _ := json.Marshal(payload)\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, bytes.NewBuffer(jsonPayload))\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Content-Type\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println((string(body)))\n\tcase 400:\n\t\tfmt.Println(\"Error: code = 400 - Invalid input\")\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.group;\n\nimport org.json.JSONObject;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class PutGroupCollection {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var url = \"https://api.lox24.eu/groups/12344\";\n\n var json = new JSONObject();\n json.put(\"name\", \"New group name Clients\");\n\n var data = json.toString();\n\n System.out.println(\"PUT data: \" + data);\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Content-Type\", \"application/json; charset=utf-8\")\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .PUT(HttpRequest.BodyPublishers.ofString(data))\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"group resource updated);\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error: wrong response code \" + httpResponse.statusCode() + \" on update group\");\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_BAD_REQUEST: // 400\n System.out.println(\"Error:400 Invalid input\");\n break;\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_NOT_FOUND: // 404\n System.out.println(\"Error:404 Resource not found\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar id = '12344';\n\nvar postObj = {\n \"name\": \"New group name\"\n};\n\nvar postdata = JSON.stringify(postObj);\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/groups/' + id,\n method: 'PUT',\n headers: {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'Content-Length': postdata.length,\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log(\"Success: code = 201 - group resource updated\");\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 400) {\n console.log(\"Error: code = 400 - Invalid input\");\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else if (res.statusCode == 404) {\n console.log(\"Error: code = 404 - Resource not found\");\n } else {\n console.log(\"Error: code = \" + res.statusCode);\n }\n})\n\nreq.on('error', error => {\n console.error(error)\n})\nreq.write(postdata);\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " 'New group name',\n];\n\nif(!$body = json_encode($body)) {\n die('JSON encoding error!');\n}\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_CUSTOMREQUEST => 'PUT',\n CURLOPT_URL => $uri,\n CURLOPT_POSTFIELDS => $body,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n 'Content-Type: application/json',\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\nid = \"12344\"\n\nurl = f'https://api.lox24.eu/groups/{id}'\n\n\ndata = {\n 'name': 'New group name'\n}\n\nheaders = {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\nprint(\"Post data : \", json.dumps(data, indent=4))\n\ntry:\n # timeout is 100 seconds, the payload is automatically converted to json format\n res = requests.put(url, headers=headers, json=data, timeout=100)\n if res.status_code != 200: # OK\n print(\"Error: Wrong response code on update group\")\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - group resource updated')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 400:\n print(\"Error:400 Invalid input\")\n elif res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 404:\n print(\"Error:404 Resource not found\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n\n", "label": "Python" } ] }, "delete": { "operationId": "api_groups_delete_item", "tags": [ "groups" ], "responses": { "204": { "$ref": "#/components/responses/204-deleted" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Excluir um Grupo", "description": "Excluir o grupo junto com todos os n\u00fameros de telefone associados.", "parameters": [ { "$ref": "#/components/parameters/path.groups.id" } ], "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X DELETE https://api.lox24.eu/groups/12344 \\\n -H 'Content-Type: application/json' \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "\nusing Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\n var id = \"12344\";\n string url = \"https://api.lox24.eu/groups/\" + id;\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\";\n httpWebRequest.Method = \"DELETE\";\n //httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n if(resp.StatusCode == HttpStatusCode.NoContent) { //204\n Console.WriteLine(\"Success: group was deleted\");\n } else {\n Console.WriteLine(\"Error: something went wrong, code({0})\", respCode);\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n\n JObject parsed = JObject.Parse(responseText);\n\n foreach (var pair in parsed)\n {\n Console.WriteLine(\"{0}: {1}\", pair.Key, pair.Value);\n }\n }\n }\n\n }\n\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.NotFound: // 404\n Console.WriteLine(\"Error:404 Resource not found\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "\npackage main\n\nimport (\n\t\"fmt\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"DELETE\"\n\tconst URL = \"https://api.lox24.eu/groups/12344\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tswitch res.StatusCode {\n\tcase 204:\n\t\tfmt.Println(\"Group and related phones was deleted!\")\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tcase 404:\n\t\tfmt.Println(\"Error: code = 404 - Resource not found\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.group;\n\nimport org.json.JSONObject;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class DeleteGroupItem {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var userId = \"1234567\";\n\n var id = \"12344\";\n var url = \"https://api.lox24.eu/groups/\" + id;\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .DELETE()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_NO_CONTENT) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"group was delete.\");\n } else {\n System.out.println(\"Error: something went wrong, code(\" + httpResponse.statusCode() + \")\");\n\n JSONObject parsed = new JSONObject(httpResponse.body());\n\n parsed.keys().forEachRemaining(jsonKey -> System.out.println(jsonKey + \":\" + parsed.get(jsonKey)));\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_NOT_FOUND: // 404\n System.out.println(\"Error:404 Resource not found\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar id = '12344';\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/groups/' + id,\n method: 'DELETE',\n headers: {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 204) {\n console.log('Success: code = 204 - group resource deleted');\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else if (res.statusCode == 404) {\n console.log(\"Error: code = 404 - Resource not found\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n});\n\nreq.on('error', error => {\n console.error(error)\n});\n\nreq.end();\n\n\n", "label": "JavaScript" }, { "lang": "php", "source": " $uri,\n CURLOPT_CUSTOMREQUEST => 'DELETE',\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\nif(204 === $code) {\n echo \"Group with id = {$id} was deleted!\";\n} elseif(404 === $code) {\n echo \"Group with id = {$id} not found!\";\n} else {\n $data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n echo \"Group: code = {$code}, data = \" . var_export($data, true);\n}\n\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\nid = \"12344\"\n\nurl = f'https://api.lox24.eu/groups/{id}'\n\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.delete(url, headers=headers, timeout=100)\n if res.status_code != 204: # No Content\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - group was deleted')\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 404:\n print(\"Error:404 Resource not found\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n\n\n", "label": "Python" } ] } }, "/groups/{id}/file/csv": { "get": { "operationId": "group_export_to_file", "tags": [ "phones" ], "responses": { "200": { "description": "Exportar os telefones do grupo como ficheiro CSV", "content": { "text/csv": { "schema": { "$ref": "#/components/schemas/schema.groups-group_read" } } } }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Exportar CSV dos Telefones", "description": "##### Example of the CSV\n\n|id|phone|col_A|col_B|col_C|col_D|col_E|callback_data|\n|---|---|---|---|---|---|---|---|\n|7848412|+49123456780|Name|Second name|Foo|Bar|Zoo|12345|\n|7848413|+49123456781|Name|Second name|Foo|Bar|Zoo|12346|\n|7848414|+49123456782|Name|Second name|Foo|Bar|Zoo|12347|\n|7848415|+49123456783|Name|Second name|Foo|Bar|Zoo|12348|\n\nThe names of the columns will correspond to the values in the fields \n`name_X` of the corresponding `/group` object. If the corresponding \nvalue is missing, the default is `col_X`, where X = (a, b, c, d, e).\n", "parameters": [ { "$ref": "#/components/parameters/path.groups.id" } ], "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl https://api.lox24.eu/groups/7116/file/csv \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class phones\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var id = \"12344\";\n\n string url = \"https://api.lox24.eu/groups/\" + id + \"/file/csv\";\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"text/csv\";\n httpWebRequest.Method = \"GET\";\n httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n Console.WriteLine(\"Success:{0} {1}\", respCode, \"phones resource response\");\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.NotFound: // 404\n Console.WriteLine(\"Error:404 Resource not found\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\turl := \"https://api.lox24.eu/groups/7116/file/csv\"\n\tmethod := \"GET\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(method, url, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println(string(body))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tcase 404:\n\t\tfmt.Println(\"Error: code = 404 - Resource not found\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.phones;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GroupExportToFilePhonesItem {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var id = \"7116\";\n\n var url = \"https://api.lox24.eu/groups/\" + id + \"/file/csv\";\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"text/csv\")\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .GET()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"Import phones items as CSV file\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error: wrong response code \" + httpResponse.statusCode() + \" on import phone items as CSV file\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_NOT_FOUND: // 404\n System.out.println(\"Error:404 Resource not found\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/groups/12344/file/csv',\n method: 'GET',\n headers: {\n 'Accept': 'text/csv',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log('Success: code = 200 - phones list response');\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n\n});\n\nreq.on('error', error => {\n console.error(error)\n});\n\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " 1,\n];\n\n$uri .= $filters ? '?' . http_build_query($filters) : '';\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_URL => $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: text/csv', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . $data;\n} else {\n echo \"Error: code = {$code}, data = \" . $data;\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\ngroup_id = \"7116\"\n\nurl = f'https://api.lox24.eu/groups/{group_id}/file/csv'\n\n\nheaders = {\n 'Accept': 'text/csv',\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - Import phone items as CSV file')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 404:\n print(\"Error:404 Resource not found\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n", "label": "Python" } ] } }, "/groups/{id}/phones": { "get": { "operationId": "api_phones_get_collection", "tags": [ "phones" ], "responses": { "200": { "description": "groups resource", "content": { "application/ld+json": { "schema": { "properties": { "member": { "items": { "$ref": "#/components/schemas/schema.phones.jsonld-phone_read" } } } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/schema.phones-phone_read" } } } } }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Recupera a cole\u00e7\u00e3o de Telefones por ID do Grupo", "description": "Recupera a cole\u00e7\u00e3o de Telefones por ID do Grupo", "parameters": [ { "$ref": "#/components/parameters/path.groups.id" } ], "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl https://api.lox24.eu/groups/7116/phones \\\n -H 'Content-Type: application/json' \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class phones\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string id = \"12344\"\n string url = \"https://api.lox24.eu/groups/12344/phones\";\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\"; // or \"application/ld+json\"\n httpWebRequest.Method = \"GET\";\n //httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n Console.WriteLine(\"Success:{0} {1}\", respCode, \"phones collection response\");\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\turl := \"https://api.lox24.eu/groups/7116/phones\"\n\tmethod := \"GET\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(method, url, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println(string(body))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tcase 404:\n\t\tfmt.Println(\"Error: code = 404 - Resource not found\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.phones;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GetGroupPhonesGroupsItem {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var id = \"7116\";\n\n var url = \"https://api.lox24.eu/groups/\" + id + \"/phones\";\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .GET()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"phones resource response\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error: wrong response code \" + httpResponse.statusCode() + \" on get group's items\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_NOT_FOUND: // 404\n System.out.println(\"Error:404 Resource not found\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/groups/12344/phones',\n method: 'GET',\n headers: {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log('Success: code = 200 - phones list response');\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n\n});\n\nreq.on('error', error => {\n console.error(error)\n});\n\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\ngroup_id = \"7116\"\n\nurl = f'https://api.lox24.eu/groups/{group_id}/phones'\n\n\nheaders = {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - get group phones response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 404:\n print(\"Error:404 Resource not found\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n", "label": "Python" } ] }, "post": { "operationId": "api_phones_post_collection", "tags": [ "phones" ], "responses": { "201": { "description": "phones resource created", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.phones.jsonld-phone_read" } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.phones-phone_read" } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "422": { "$ref": "#/components/responses/422-unprocessable-entity" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Criar um Telefone", "description": "Criar uma entrada com um n\u00famero de telefone.", "parameters": [ { "$ref": "#/components/parameters/path.groups.id" } ], "requestBody": { "description": "The new phones resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schema.phones-phone_write" } } }, "required": true }, "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X POST https://api.lox24.eu/groups/12344/phones \\\n -H 'Content-Type: application/json' \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx' \\\n -d '{\n \"phone\": \"+93701234567\",\n \"a\": \"Mr. \",\n \"b\": \"Smith \",\n \"c\": \"2020-02-23 18:00\",\n \"d\": \"12.34\",\n \"e\": \"restaurant Blue Oyster\"\n}'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json;\nusing Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class phones\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string url = \"https://api.lox24.eu/groups/12344/phones\";\n\n var data = new {\n phone = \"+93701234567\",\n a = \"Mr. \",\n b = \"Smith\",\n c = \"2020-02-23 18:00\",\n d = \"12.34\",\n e = \"restaurant Blue Oyster\"\n };\n\n string postdata = JsonConvert.SerializeObject(data);\n\n Console.WriteLine(\"Post data: {0}\", postdata);\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.ContentType = \"application/json; charset=utf-8\";\n httpWebRequest.Accept = \"application/json\"; // or application/ld+json\n httpWebRequest.Method = \"POST\";\n httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n using (var streamWriter = new StreamWriter(httpWebRequest.GetRequestStream()))\n {\n streamWriter.Write(postdata);\n streamWriter.Flush();\n streamWriter.Close();\n }\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n\n if(resp.StatusCode == HttpStatusCode.Created) {\n Console.WriteLine(\"Success:{0} {1}\", (int)resp.StatusCode, \"phone resource created\");\n } else {\n Console.WriteLine(\"Error: wrong response code {0} on create phone\", (int)resp.StatusCode);\n }\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.BadRequest: // 400\n Console.WriteLine(\"Error:400 Invalid input\");\n break;\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"bytes\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\turl := \"https://api.lox24.eu/groups/7116/phones\"\n\tmethod := \"POST\"\n\n\tpayload := map[string]string{\n\t\t\"phone\": \"+93701234567\",\n\t\t\"a\": \"Mr. \",\n\t\t\"b\": \"Smith \",\n\t\t\"c\": \"2020-02-23 18:00\",\n\t\t\"d\": \"12.34\",\n\t\t\"e\": \"restaurant Blue Oyster\",\n\t}\n\n\tjsonPayload, _ := json.Marshal(payload)\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(method, url, bytes.NewBuffer(jsonPayload))\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\")\n\treq.Header.Add(\"Content-Type\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 201:\n\t\tfmt.Println(string(body))\n\tcase 400:\n\t\tfmt.Println(\"Error: code = 400 - Invalid input\")\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tcase 404:\n\t\tfmt.Println(\"Error: code = 404 - Resource not found\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.phones;\n\nimport org.json.JSONObject;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class PostPhonesCollection {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var id = \"12344\";\n\n var url = \"https://api.lox24.eu/groups/\" + id + \"/phones\";\n\n var json = new JSONObject();\n json.put(\"phone\", \"+93701234567\");\n json.put(\"a\", \"Mr. \");\n json.put(\"b\", \"Smith \");\n json.put(\"c\", \"2020-02-23 18:00\");\n json.put(\"d\", \"12.34\");\n json.put(\"e\", \"restaurant Blue Oyster\");\n\n var postData = json.toString();\n\n System.out.println(\"Post data: \" + postData);\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Content-Type\", \"application/json; charset=utf-8\")\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .POST(HttpRequest.BodyPublishers.ofString(postData))\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_CREATED) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"phones resource created\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error: wrong response code \" + httpResponse.statusCode() + \" on create phone\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_BAD_REQUEST: // 400\n System.out.println(\"Error:400 Invalid input\");\n break;\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_NOT_FOUND: // 404\n System.out.println(\"Error:404 Resource not found\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar postObj = {\n phone: '+93701234567',\n a: 'Mr. ',\n b: 'Smith',\n c: '2020-02-23 18:00',\n d: '12.34',\n e: 'restaurant Blue Oyster'\n};\n\nvar postdata = JSON.stringify(postObj);\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/groups',\n method: 'POST',\n headers: {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'Content-Length': postdata.length,\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 201) {\n console.log(\"Success: code = 201 - phone resource created\");\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 400) {\n console.log(\"Error: code = 400 - Invalid input\");\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 402) {\n console.log(\"Error: code = 402 - There are not enough funds on your account!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n})\n\nreq.on('error', error => {\n console.error(error)\n})\nreq.write(postdata);\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " '+93701234567',\n 'a' => 'Mr. ',\n 'b' => 'Smith ',\n 'c' => '2020-02-23 18 =>00',\n 'd' => '12.34',\n 'e' => 'restaurant Blue Oyster',\n];\n\nif(!$body = json_encode($body)) {\n die('JSON encoding error!');\n}\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_POST => true,\n CURLOPT_URL => $uri,\n CURLOPT_POSTFIELDS => $body,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n 'Content-Type: application/json',\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(201 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\ngroup_id = \"12344\"\n\nurl = f'https://api.lox24.eu/groups/{group_id}/phones'\n\n\ndata = {\n \"phone\": \"+93701234567\",\n \"a\": \"Mr. \",\n \"b\": \"Smith \",\n \"c\": \"2020-02-23 18:00\",\n \"d\": \"12.34\",\n \"e\": \"restaurant Blue Oyster\",\n}\n\nheaders = {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\nprint(\"Post data : \", json.dumps(data, indent=4))\n\ntry:\n # timeout is 100 seconds, the payload is automatically converted to json format\n res = requests.post(url, headers=headers, json=data, timeout=100)\n if res.status_code != 201: # Created\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - phones resource created')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 400:\n print(\"Error:400 Invalid input\")\n elif res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 404:\n print(\"Error:404 Resource not found\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n\n", "label": "Python" } ] } }, "/groups/{id}/phones/batch": { "post": { "operationId": "phone_batch_post", "tags": [ "phones" ], "responses": { "201": { "description": "groups resource created", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.phones.jsonld-batch-read" } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.phones-batch-read" } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "422": { "$ref": "#/components/responses/422-unprocessable-entity" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Criar Telefones em lote", "description": "Em vez de enviar m\u00faltiplas solicita\u00e7\u00f5es, \u00e9 melhor enviar uma \u00fanica solicita\u00e7\u00e3o com uma lista de objetos de Telefone como corpo da solicita\u00e7\u00e3o.", "parameters": [ { "$ref": "#/components/parameters/path.groups.id" } ], "requestBody": { "description": "The new groups resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schema.phones-batch-write" } } }, "required": true }, "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json;\nusing Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class phones\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string url = \"https://api.lox24.eu/groups/12344/phones/batch\";\n\n var data = new[] {\n new {\n phone = \"+93701234567\",\n a = \"Mr. \",\n b = \"Smith\"\n },\n new {\n phone = \"+93701234568\",\n a = \"Ms. \",\n b = \"Smith\"\n }\n }\n\n string postdata = JsonConvert.SerializeObject(data);\n\n Console.WriteLine(\"Post data: {0}\", postdata);\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.ContentType = \"application/json; charset=utf-8\";\n httpWebRequest.Accept = \"application/json\"; // or application/ld+json\n httpWebRequest.Method = \"POST\";\n httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n using (var streamWriter = new StreamWriter(httpWebRequest.GetRequestStream()))\n {\n streamWriter.Write(postdata);\n streamWriter.Flush();\n streamWriter.Close();\n }\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n\n if(resp.StatusCode == HttpStatusCode.Created) {\n Console.WriteLine(\"Success:{0} {1}\", (int)resp.StatusCode, \"phone resource created\");\n } else {\n Console.WriteLine(\"Error: wrong response code {0} on create phone\", (int)resp.StatusCode);\n }\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.BadRequest: // 400\n Console.WriteLine(\"Error:400 Invalid input\");\n break;\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"bytes\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\turl := \"https://api.lox24.eu/groups/7116/phones/batch\"\n\tmethod := \"POST\"\n\n\tpayload := []map[string]string{\n\t\t{\n\t\t\t\"phone\": \"+93701234567\",\n\t\t\t\"a\": \"Mr. \",\n\t\t\t\"b\": \"Smith \",\n\t\t\t\"c\": \"2020-02-23 18:00\",\n\t\t\t\"d\": \"12.34\",\n\t\t\t\"e\": \"restaurant Blue Oyster\",\n\t\t},\n\t}\n\n\tjsonPayload, _ := json.Marshal(payload)\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(method, url, bytes.NewBuffer(jsonPayload))\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\")\n\treq.Header.Add(\"Content-Type\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 201:\n\t\tfmt.Println(string(body))\n\tcase 400:\n\t\tfmt.Println(\"Error: code = 400 - Invalid input\")\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tcase 404:\n\t\tfmt.Println(\"Error: code = 404 - Resource not found\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.phones;\n\nimport org.json.JSONArray;\nimport org.json.JSONObject;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class PhoneBatchPostGroupsItem {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var id = \"7116\";\n\n var url = \"https://api.lox24.eu/groups/\" + id + \"/phones/batch\";\n\n var jsonArray = new JSONArray();\n var validPhoneNumber = new JSONObject();\n validPhoneNumber.put(\"phone\", \"+4912345678\");\n validPhoneNumber.put(\"a\", \"column A text\");\n\n var invalidPhoneNumber = new JSONObject();\n invalidPhoneNumber.put(\"a\", \"column A text #2\");\n\n jsonArray.put(validPhoneNumber);\n jsonArray.put(invalidPhoneNumber);\n\n var postData = jsonArray.toString();\n\n System.out.println(\"Post data: \" + postData);\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Content-Type\", \"application/json; charset=utf-8\")\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .POST(HttpRequest.BodyPublishers.ofString(postData))\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_CREATED) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"phones resource created by the batch\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error: wrong response code \" + httpResponse.statusCode() + \" on phones resource by the batch\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_BAD_REQUEST: // 400\n System.out.println(\"Error:400 Invalid input\");\n break;\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_NOT_FOUND: // 404\n System.out.println(\"Error:404 Resource not found\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar postObj = [{\n phone: '+93701234567',\n a: 'Mr. ',\n b: 'Smith',\n}, {\n a: \"wrong phone resource\"\n}];\n\n\nvar postdata = JSON.stringify(postObj);\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/groups/12344/phone/batch',\n method: 'POST',\n headers: {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'Content-Length': postdata.length,\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 201) {\n console.log(\"Success: code = 201 - phone resource created\");\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 400) {\n console.log(\"Error: code = 400 - Invalid input\");\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 402) {\n console.log(\"Error: code = 402 - There are not enough funds on your account!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n})\n\nreq.on('error', error => {\n console.error(error)\n})\nreq.write(postdata);\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " '+93701234567',\n 'a' => 'Mr. ',\n 'b' => 'Smith ',\n 'c' => '2020-02-23 18 =>00',\n 'd' => '12.34',\n 'e' => 'restaurant Blue Oyster',\n ],\n [\n 'a' => 'Invalid phone object',\n ]\n];\n\nif(!$body = json_encode($body)) {\n die('JSON encoding error!');\n}\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_POST => true,\n CURLOPT_URL => $uri,\n CURLOPT_POSTFIELDS => $body,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n 'Content-Type: application/json',\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(201 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\ngroup_id = \"7116\"\n\nurl = f'https://api.lox24.eu/groups/{group_id}/phones/batch'\n\n\ndata = [\n {\n \"phone\": \"+4912345678\",\n \"a\": \"column A text\"\n },\n {\n \"a\": \"column A text #2\"\n }\n]\n\n\nheaders = {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\nprint(\"Post data : \", json.dumps(data, indent=4))\n\ntry:\n # timeout is 100 seconds, the payload is automatically converted to json format\n res = requests.post(url, headers=headers, json=data, timeout=100)\n if res.status_code != 201: # Created\n res.raise_for_status()\n else:\n print(\n f'Success: code = {res.status_code} - phones resource created by the batch')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 404:\n print(\"Error:404 Resource not found\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n", "label": "Python" } ] } }, "/incomings": { "get": { "operationId": "api_incomings_get_collection", "tags": [ "incomings" ], "responses": { "200": { "description": "incomings collection", "content": { "application/ld+json": { "schema": { "type": "object", "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/schema.incomings.jsonld-incoming_read" } }, "hydra:totalItems": { "$ref": "#/components/schemas/hydra.totalItems" }, "hydra:view": { "$ref": "#/components/schemas/hydra.view" }, "hydra:search": { "$ref": "#/components/schemas/hydra.search" } }, "required": [ "member" ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/schema.incomings-incoming_read" } } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Retrieves the collection of Incoming SMS", "description": "Getting the list of incoming SMS ordered by the field `received_at` in descending order. The postbox contains all inbound sms and replies. For SMS replies property 'msg_uuid' filled by correspond /sms entity.", "parameters": [ { "$ref": "#/components/parameters/filter.common.page" }, { "$ref": "#/components/parameters/order.incomings.received_at" }, { "$ref": "#/components/parameters/filter.messages.text.partial" }, { "$ref": "#/components/parameters/filter.incomings.from" }, { "$ref": "#/components/parameters/filter.incomings.to" }, { "$ref": "#/components/parameters/filter.incomings.msg_uuid" }, { "$ref": "#/components/parameters/filter.incomings.msg_uuid.array" } ], "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X GET https://api.lox24.eu/incomings \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string url = \"https://api.lox24.eu/incomings?text=Test&msg_uuid[]=8481900d-86ce-11ea-aa81-96000028b339&msg_uuid[]=d5ceb189-86cd-11ea-aa81-96000028b339&page=1&_order[created_at]=desc\";\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\"; // or \"application/ld+json\"\n httpWebRequest.Method = \"GET\";\n //httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n Console.WriteLine(\"Success:{0} {1}\", respCode, \"Incoming SMS collection response\");\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"GET\"\n\tconst URL = \"https://api.lox24.eu/incomings\"\n\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println(string(body))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.incomings;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GetIncomingsCollection {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var url = \"https://api.lox24.eu/incomings?text=Test&msg_uuid[]=8481900d-86ce-11ea-aa81-96000028b339&msg_uuid[]=d5ceb189-86cd-11ea-aa81-96000028b339&page=1&_order[created_at]=desc\";\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .GET()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"incomings collection response\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n } else {\n System.out.println(\"Error: something went wrong, code(\" + httpResponse.statusCode() + \")\");\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar query = \"text=Test&msg_uuid[]=8481900d-86ce-11ea-aa81-96000028b339&msg_uuid[]=d5ceb189-86cd-11ea-aa81-96000028b339&page=1&_order[created_at]=desc\";\n\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/incomings?' + query,\n method: 'GET',\n headers: {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log('Success: code = 200 - incoming messages collection response');\n res.on('data', d => {process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n})\n\nreq.on('error', error => {\n console.error(error)\n})\n\nreq.end();\n\n\n", "label": "JavaScript" }, { "lang": "php", "source": " 'Test',\n 'msg_uuid' => [\n '8481900d-86ce-11ea-aa81-96000028b339',\n 'd5ceb189-86cd-11ea-aa81-96000028b339',\n ],\n 'page' => 1,\n '_order' => [\n 'received_at' => 'desc'\n ],\n];\n\n$uri .= $filters ? '?' . http_build_query($filters) : '';\n$curl = curl_init();\n\necho $uri;\n\ncurl_setopt_array($curl, [\n CURLOPT_URL => $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\nurl = \"https://api.lox24.eu/incomings?text=Test&msg_uuid[]=8481900d-86ce-11ea-aa81-96000028b339&msg_uuid[]=d5ceb189-86cd-11ea-aa81-96000028b339&page=1&_order[created_at]=desc\"\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - incomings collection response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n", "label": "Python" } ] } }, "/incomings/{uuid}": { "get": { "operationId": "api_incomings_get_item", "deprecated": false, "tags": [ "incomings" ], "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X GET https://api.lox24.eu/incomings/20f39273-0566-11ea-a637-96000028b339 \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var id = \"343c785b-8567-11ea-aa81-96000028b339\";\n\n string url = \"https://api.lox24.eu/incomings/\" + id;\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\"; //or application/ld+json\n httpWebRequest.Method = \"GET\";\n httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n Console.WriteLine(\"Success:{0} {1}\", respCode, \"Incoming SMS resource response\");\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.NotFound: // 404\n Console.WriteLine(\"Error:404 Resource not found\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"GET\"\n\tconst URL = \"https://api.lox24.eu/incomings/85c2b099-9d84-11ea-b2e9-b8ca3a65338c\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println(string(body))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tcase 404:\n\t\tfmt.Println(\"Error: code = 404 - Resource not found\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.incomings;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GetIncomingsItem {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var id = \"343c785b-8567-11ea-aa81-96000028b339\";\n\n var url = \"https://api.lox24.eu/incomings/\" + id;\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .GET()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"incomings resource created\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error:\" + httpResponse.statusCode());\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_NOT_FOUND: // 404\n System.out.println(\"Error:404 Resource not found\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "//const host = 'api.lox24.eu';\n//const clientid = \"1234567\";\n//const token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\nconst host = 'api2-test.lox24.eu';\nconst token = \"21911_4f8432430c640ee96c9f8a3eb880d477\";\n\nvar id = '8481900d-86ce-11ea-aa81-96000028b339';\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/incomings/' + id,\n method: 'GET',\n headers: {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log('Success: code = 200 - incoming message resource response');\n res.on('data', d => { process.stdout.write(d)})\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else if (res.statusCode == 404) {\n console.log(\"Error: code = 404 - Resource not found\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n})\n\nreq.on('error', error => {\n console.error(error)\n})\n\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} elseif(404 === $code) {\n echo \"Incoming SMS with id = {$id} not found!\";\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\nincoming_id = \"343c785b-8567-11ea-aa81-96000028b339\"\n\nurl = f'https://api.lox24.eu/incomings/{incoming_id}'\n\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - incoming sms resource response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 404:\n print(\"Error:404 Resource not found\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n", "label": "Python" } ], "responses": { "200": { "description": "incomings resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.incomings.jsonld-incoming_read" } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.incomings-incoming_read" } } } }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Retrieves the entry of Incoming SMS", "description": "Getting the entry of incoming SMS. The postbox contains all inbound sms and replies. For SMS replies property 'msg_uuid' filled by correspond /sms entity.", "parameters": [ { "$ref": "#/components/parameters/path.incomings.id" } ] }, "delete": { "operationId": "api_incomings_delete_item", "deprecated": false, "tags": [ "incomings" ], "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X DELETE https://api.lox24.eu/incomings/20f39273-0566-11ea-a637-96000028b339 \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var id = \"343c785b-8567-11ea-aa81-96000028b339\";\n\n string url = \"https://api.lox24.eu/incomings/\" + id;\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\"; //or application/ld+json\n httpWebRequest.Method = \"DELETE\";\n httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n Console.WriteLine(\"Success:{0} {1}\", respCode, \"Incoming SMS resource response\");\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.NotFound: // 404\n Console.WriteLine(\"Error:404 Resource not found\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"DELETE\"\n\tconst URL = \"https://api.lox24.eu/incomings/85c2b099-9d84-11ea-b2e9-b8ca3a65338c\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println(string(body))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tcase 404:\n\t\tfmt.Println(\"Error: code = 404 - Resource not found\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.incomings;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GetIncomingsItem {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var id = \"343c785b-8567-11ea-aa81-96000028b339\";\n\n var url = \"https://api.lox24.eu/incomings/\" + id;\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .DELETE()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"incomings resource created\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error:\" + httpResponse.statusCode());\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_NOT_FOUND: // 404\n System.out.println(\"Error:404 Resource not found\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "//const host = 'api.lox24.eu';\n//const clientid = \"1234567\";\n//const token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\nconst host = 'api2-test.lox24.eu';\nconst token = \"21911_4f8432430c640ee96c9f8a3eb880d477\";\n\nvar id = '8481900d-86ce-11ea-aa81-96000028b339';\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/incomings/' + id,\n method: 'DELETE',\n headers: {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log('Success: code = 200 - incoming message resource response');\n res.on('data', d => { process.stdout.write(d)})\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else if (res.statusCode == 404) {\n console.log(\"Error: code = 404 - Resource not found\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n})\n\nreq.on('error', error => {\n console.error(error)\n})\n\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_CUSTOMREQUEST => 'DELETE',\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} elseif(404 === $code) {\n echo \"Incoming SMS with id = {$id} not found!\";\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\nincoming_id = \"343c785b-8567-11ea-aa81-96000028b339\"\n\nurl = f'https://api.lox24.eu/incomings/{incoming_id}'\n\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.delete(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - incoming sms resource response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 404:\n print(\"Error:404 Resource not found\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n", "label": "Python" } ], "responses": { "204": { "$ref": "#/components/responses/204-deleted" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Deleting an Inbound SMS", "description": "Received SMS (inbound or reply SMS) can be deleted from the server based on the UUID.", "parameters": [ { "$ref": "#/components/parameters/path.incomings.id" } ] } }, "/phones/{id}": { "get": { "operationId": "api_phones_get_item", "tags": [ "phones" ], "responses": { "200": { "description": "phones resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.phones.jsonld-phone_read" } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.phones-phone_read" } } } }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Recupera a entrada de Telefone", "description": "Consultar uma entrada com um n\u00famero de telefone.", "parameters": [ { "$ref": "#/components/parameters/path.phones.id" } ], "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl https://api.lox24.eu/phones/12344 \\\n -H 'Content-Type: application/json' \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class phones\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var id = \"12344\";\n\n string url = \"https://api.lox24.eu/phones/\" + id;\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\"; //or application/ld+json\n httpWebRequest.Method = \"GET\";\n httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n Console.WriteLine(\"Success:{0} {1}\", respCode, \"phones resource response\");\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.NotFound: // 404\n Console.WriteLine(\"Error:404 Resource not found\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\turl := \"https://api.lox24.eu/phones/12344\"\n\tmethod := \"GET\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(method, url, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println(string(body))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tcase 404:\n\t\tfmt.Println(\"Error: code = 404 - Resource not found\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.phones;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GetPhonesItem {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var id = \"12344\";\n\n var url = \"https://api.lox24.eu/phones/\" + id;\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .GET()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"phones resource response\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error: wrong response code \" + httpResponse.statusCode() + \" on get phones item\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_NOT_FOUND: // 404\n System.out.println(\"Error:404 Resource not found\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar id = '12344';\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/phones/' + id,\n method: 'GET',\n headers: {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log('Success: code = 200');\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else if (res.statusCode == 404) {\n console.log(\"Error: code = 404 - Resource not found\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n\n})\n\nreq.on('error', error => {\n console.error(error)\n})\n\nreq.end();\n\n", "label": "JavaScript" }, { "lang": "php", "source": " $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} elseif(404 === $code) {\n echo \"Group with id = {$id} not found!\";\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\nphone_id = \"12344\"\n\nurl = f'https://api.lox24.eu/phones/{phone_id}'\n\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - phones resource response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 404:\n print(\"Error:404 Resource not found\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n\n", "label": "Python" } ] }, "put": { "operationId": "api_phones_put_item", "tags": [ "phones" ], "responses": { "200": { "description": "phones resource updated", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.phones.jsonld-phone_read" } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.phones-phone_read" } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "422": { "$ref": "#/components/responses/422-unprocessable-entity" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Editar a entrada de Telefone", "description": "Editar uma entrada com um n\u00famero de telefone.", "parameters": [ { "$ref": "#/components/parameters/path.phones.id" } ], "requestBody": { "description": "The updated phones resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schema.phones-phone_write" } } }, "required": true }, "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X PUT https://api.lox24.eu/phones/12344 \\\n -H 'Content-Type: application/json' \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx' \\\n -d '{\n \"phone\": \"+93701234567\",\n \"a\": \"Mr. \",\n \"b\": \"Smith \",\n \"c\": \"2020-02-23 18:00\",\n \"d\": \"12.34\",\n \"e\": \"restaurant Blue Oyster\"\n}'\n", "label": "Bash" }, { "lang": "csharp", "source": "\nusing Newtonsoft.Json;\nusing Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string url = \"https://api.lox24.eu/phones/12344\";\n\n\n var data = new {\n phone = \"+93701234599\"\n };\n\n string postdata = JsonConvert.SerializeObject(data);\n\n Console.WriteLine(\"Post data: {0}\", postdata);\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.ContentType = \"application/json; charset=utf-8\";\n httpWebRequest.Accept = \"application/json\"; // or application/ld+json\n httpWebRequest.Method = \"POST\";\n httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n using (var streamWriter = new StreamWriter(httpWebRequest.GetRequestStream()))\n {\n streamWriter.Write(postdata);\n streamWriter.Flush();\n streamWriter.Close();\n }\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n\n if(resp.StatusCode == HttpStatusCode.Created) {\n Console.WriteLine(\"Success:{0} {1}\", (int)resp.StatusCode, \"phone resource updated\");\n } else {\n Console.WriteLine(\"Error: wrong response code {0} on update phone\", (int)resp.StatusCode);\n }\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.BadRequest: // 400\n Console.WriteLine(\"Error:400 Invalid input\");\n break;\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.NotFound: // 404\n Console.WriteLine(\"Error:404 Resource not found\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"bytes\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\turl := \"https://api.lox24.eu/phones/12344\"\n\tmethod := \"PUT\"\n\n\tpayload := map[string]string{\n\t\t\"phone\": \"+93701234567\",\n\t\t\"a\": \"Mr. \",\n\t\t\"b\": \"Smith \",\n\t\t\"c\": \"2020-02-23 18:00\",\n\t\t\"d\": \"12.34\",\n\t\t\"e\": \"restaurant Blue Oyster\",\n\t}\n\n\tjsonPayload, _ := json.Marshal(payload)\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(method, url, bytes.NewBuffer(jsonPayload))\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\")\n\treq.Header.Add(\"Content-Type\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println(string(body))\n\tcase 400:\n\t\tfmt.Println(\"Error: code = 400 - Invalid input\")\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tcase 404:\n\t\tfmt.Println(\"Error: code = 404 - Resource not found\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.phones;\n\nimport org.json.JSONObject;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class PutPhonesItem {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var id = \"12344\";\n var url = \"https://api.lox24.eu/phones/\" + id;\n\n var json = new JSONObject();\n json.put(\"phone\", \"+93701234567\");\n json.put(\"a\", \"Mr. \");\n json.put(\"b\", \"Smith \");\n json.put(\"c\", \"2020-02-23 18:00\");\n json.put(\"d\", \"12.34\");\n json.put(\"e\", \"restaurant Blue Oyster\");\n\n\n var putData = json.toString();\n\n System.out.println(\"Put data: \" + putData);\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Content-Type\", \"application/json; charset=utf-8\")\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .PUT(HttpRequest.BodyPublishers.ofString(putData))\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"phones resource updated\");\n\n JSONObject parsed = new JSONObject(httpResponse.body());\n\n parsed.keys().forEachRemaining(jsonKey -> System.out.println(jsonKey + \":\" + parsed.get(jsonKey)));\n } else {\n\n System.out.println(\"Error: wrong response code \" + httpResponse.statusCode() + \" on update phone\");\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_BAD_REQUEST: // 400\n System.out.println(\"Error:400 Invalid input\");\n break;\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_NOT_FOUND: // 404\n System.out.println(\"Error:404 Resource not found\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar postObj = {\n phone: '+93701234567',\n a: 'Mr. ',\n b: 'Smith',\n c: '2020-02-23 18:00',\n d: '12.34',\n e: 'restaurant Blue Oyster'\n};\n\nvar postdata = JSON.stringify(postObj);\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/phones/1234',\n method: 'PUT',\n headers: {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'Content-Length': postdata.length,\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log(\"Success: code = 200 - phone resource created\");\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 400) {\n console.log(\"Error: code = 400 - Invalid input\");\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 402) {\n console.log(\"Error: code = 402 - There are not enough funds on your account!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n})\n\nreq.on('error', error => {\n console.error(error)\n})\nreq.write(postdata);\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " '+93701234567',\n];\n\nif(!$body = json_encode($body)) {\n die('JSON encoding error!');\n}\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_CUSTOMREQUEST => 'PUT',\n CURLOPT_URL => $uri,\n CURLOPT_POSTFIELDS => $body,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n 'Content-Type: application/json',\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\nphone_id = \"12344\"\n\nurl = f'https://api.lox24.eu/phones/{phone_id}'\n\ndata = {\n \"phone\": \"+93701234567\",\n \"a\": \"Mr. \",\n \"b\": \"Smith \",\n \"c\": \"2020-02-23 18:00\",\n \"d\": \"12.34\",\n \"e\": \"restaurant Blue Oyster\",\n}\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'Content-Type': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.put(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - phones resource updated')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 400:\n print(\"Error:400 Invalid input\")\n elif res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 404:\n print(\"Error:404 Resource not found\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n\n", "label": "Python" } ] }, "delete": { "operationId": "api_phones_delete_item", "tags": [ "phones" ], "responses": { "204": { "$ref": "#/components/responses/204-deleted" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Excluir a entrada de Telefone", "description": "Excluir uma entrada com um n\u00famero de telefone.", "parameters": [ { "$ref": "#/components/parameters/path.phones.id" } ], "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X DELETE https://api.lox24.eu/phones/12344 \\\n -H 'Content-Type: application/json' \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "\nusing Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class phones\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\n var id = \"12344\";\n string url = \"https://api.lox24.eu/phones/\" + id;\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\";\n httpWebRequest.Method = \"DELETE\";\n //httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n if(resp.StatusCode == HttpStatusCode.NoContent) { //204\n Console.WriteLine(\"Success: phone was deleted\");\n } else {\n Console.WriteLine(\"Error: something went wrong, code({0})\", respCode);\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n\n JObject parsed = JObject.Parse(responseText);\n\n foreach (var pair in parsed)\n {\n Console.WriteLine(\"{0}: {1}\", pair.Key, pair.Value);\n }\n }\n }\n\n }\n\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.NotFound: // 404\n Console.WriteLine(\"Error:404 Resource not found\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\turl := \"https://api.lox24.eu/phones/12344\"\n\tmethod := \"DELETE\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(method, url, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tswitch res.StatusCode {\n\tcase 204:\n\t\tfmt.Println(\"Success: code = 204 - phones resource deleted\")\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tcase 404:\n\t\tfmt.Println(\"Error: code = 404 - Resource not found\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.phones;\n\nimport org.json.JSONObject;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class DeletePhonesItem {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\n var id = \"12344\";\n var url = \"https://api.lox24.eu/phones/\" + id;\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .DELETE()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_NO_CONTENT) {\n System.out.println(\"Success: phone was deleted\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error: something went wrong \" + httpResponse.statusCode());\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n JSONObject parsed = new JSONObject(httpResponse.body());\n\n parsed.keys().forEachRemaining(jsonKey -> System.out.println(jsonKey + \":\" + parsed.get(jsonKey)));\n\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_BAD_REQUEST: // 400\n System.out.println(\"Error:400 Invalid input\");\n break;\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_NOT_FOUND: // 404\n System.out.println(\"Error:404 Resource not found\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar id = '12344';\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/phones/' + id,\n method: 'DELETE',\n headers: {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 204) {\n console.log('Success: code = 204 - phones resource deleted');\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else if (res.statusCode == 404) {\n console.log(\"Error: code = 404 - Resource not found\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n});\n\nreq.on('error', error => {\n console.error(error)\n});\n\nreq.end();\n\n\n", "label": "JavaScript" }, { "lang": "php", "source": " $uri,\n CURLOPT_CUSTOMREQUEST => 'DELETE',\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\nif(204 === $code) {\n echo \"Phone with id = {$id} was deleted!\";\n} elseif(404 === $code) {\n echo \"Phone with id = {$id} not found!\";\n} else {\n $data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n echo \"Phone: code = {$code}, data = \" . var_export($data, true);\n}\n\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\nid = \"12344\"\n\nurl = f'https://api.lox24.eu/phones/{id}'\n\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.delete(url, headers=headers, timeout=100)\n if res.status_code != 204: # No Content\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - phones resource was deleted')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 404:\n print(\"Error:404 Resource not found\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n\n", "label": "Python" } ] } }, "/short_link_campaigns": { "get": { "operationId": "api_short_link_campaigns_get_collection", "tags": [ "campaigns" ], "responses": { "200": { "description": "short_link_campaigns collection", "content": { "application/ld+json": { "schema": { "type": "object", "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/schema.short_link_campaigns.jsonld-short_link_campaign_read" } }, "hydra:totalItems": { "type": "integer", "minimum": 0 }, "hydra:view": { "$ref": "#/components/schemas/hydra.view" }, "hydra:search": { "$ref": "#/components/schemas/hydra.search" } }, "required": [ "member" ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/schema.short_link_campaigns-short_link_campaign_read" } } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "List of all Short Link Campaigns", "description": "Retrieve the list of all existing Short Link Campaigns ordered by the field `created_at` in descending order.", "parameters": [ { "$ref": "#/components/parameters/filter.common.page" }, { "$ref": "#/components/parameters/order.common.created_at" }, { "$ref": "#/components/parameters/filter.short_link.name.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.url.partial" }, { "$ref": "#/components/parameters/filter.common.created_at.exact" }, { "$ref": "#/components/parameters/filter.common.created_at.array" }, { "$ref": "#/components/parameters/filter.short_link_request.type.exact" }, { "$ref": "#/components/parameters/filter.short_link_request.type.array" } ], "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X GET https://api.lox24.eu/short_link_campaigns \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string url = \"https://api.lox24.eu/short_link_campaigns?page=1\";\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\"; // or \"application/ld+json\"\n httpWebRequest.Method = \"GET\";\n //httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n Console.WriteLine(\"Success:{0} {1}\", respCode, \"collection response\");\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"GET\"\n\tconst URL = \"https://api.lox24.eu/short_link_campaigns?page=1\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println((string(body)))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.short_links;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GetShortLinkCampaignCollection {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var url = \"https://api.lox24.eu/short_link_campaigns?page=1\";\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .GET()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" collection response\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n } else {\n System.out.println(\"Error: something went wrong, code(\" + httpResponse.statusCode() + \")\");\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar query = \"page=1\";\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/short_link_campaigns?' + query,\n method: 'GET',\n headers: {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log('Success: code = 200 - list response');\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n\n});\n\nreq.on('error', error => {\n console.error(error)\n});\n\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " 1,\n];\n\n$uri .= $filters ? '?' . http_build_query($filters) : '';\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_URL => $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: $token\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = $code, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\nurl = \"https://api.lox24.eu/short_link_campaigns?page=1\"\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - items collection response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n", "label": "Python" } ] }, "post": { "operationId": "api_short_link_campaigns_post_collection", "tags": [ "campaigns" ], "responses": { "201": { "description": "short_link_campaigns resource created", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.short_link_campaigns.jsonld-short_link_campaign_read" } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.short_link_campaigns-short_link_campaign_read" } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "422": { "$ref": "#/components/responses/422-unprocessable-entity" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Create a Short Link Campaign", "description": "Create a new Short Link Campaign entity with destination url, type and name", "parameters": [], "requestBody": { "description": "The new short_link_campaigns resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schema.short_link_campaigns-short_link_campaign_write" } } }, "required": true }, "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X POST https://api.lox24.eu/short_link_campaigns \\\n -H 'Content-Type: application/json' \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx' \\\n -d '{\n \"type\": 2,\n \"name\": \"test #2\",\n \"url\": \"https://some-destination-endpoint.here\"\n }'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json;\nusing Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string url = \"https://api.lox24.eu/short_link_campaigns\";\n\n var data = new {\n type = 2,\n name = \"test #2\",\n url = \"https://some-destination-endpoint.here\",\n };\n\n string postdata = JsonConvert.SerializeObject(data);\n\n Console.WriteLine(\"Post data: {0}\", postdata);\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.ContentType = \"application/json; charset=utf-8\";\n httpWebRequest.Accept = \"application/json\"; // or application/ld+json\n httpWebRequest.Method = \"POST\";\n httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n using (var streamWriter = new StreamWriter(httpWebRequest.GetRequestStream()))\n {\n streamWriter.Write(postdata);\n streamWriter.Flush();\n streamWriter.Close();\n }\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n\n if(resp.StatusCode == HttpStatusCode.Created) {\n Console.WriteLine(\"Success:{0} {1}\", (int)resp.StatusCode, \"item resource created\");\n } else {\n Console.WriteLine(\"Error: wrong response code {0} on create item\", (int)resp.StatusCode);\n }\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.BadRequest: // 400\n Console.WriteLine(\"Error:400 Invalid input\");\n break;\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"bytes\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"POST\"\n\tconst URL = \"https://api.lox24.eu/short_link_campaigns\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tpayload := map[string]interface{}{\n\t\t\"type\": 2,\n\t\t\"name\": \"test #2\",\n\t\t\"url\": \"https://some-destination-endpoint.here\",\n\t}\n\n\tjsonPayload, _ := json.Marshal(payload)\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, bytes.NewBuffer(jsonPayload))\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Content-Type\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 201:\n\t\tfmt.Println((string(body)))\n\tcase 400:\n\t\tfmt.Println(\"Error: code = 400 - Invalid input\")\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.short_links;\n\nimport org.json.JSONObject;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class AddShortLinkCampaignItem {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var url = \"https://api.lox24.eu/short_link_campaigns\";\n\n var json = new JSONObject();\n\n json.put(\"type\", 2);\n json.put(\"name\", \"test #2\");\n json.put(\"url\", \"https://some-destination-endpoint.here\");\n\n var postData = json.toString();\n\n System.out.println(\"Post data: \" + postData);\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Content-Type\", \"application/json; charset=utf-8\")\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .POST(HttpRequest.BodyPublishers.ofString(postData))\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_CREATED) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" resource created\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error: wrong response code \" + httpResponse.statusCode() + \" on create item\");\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_BAD_REQUEST: // 400\n System.out.println(\"Error:400 Invalid input\");\n break;\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar postObj = {\n type: 2,\n name: \"test #2\",\n url: \"https://some-destination-endpoint.here\"\n};\n\nvar postdata = JSON.stringify(postObj);\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/short_link_campaigns',\n method: 'POST',\n headers: {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'Content-Length': postdata.length,\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 201) {\n console.log(\"Success: code = 201 - resource created\");\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 400) {\n console.log(\"Error: code = 400 - Invalid input\");\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 402) {\n console.log(\"Error: code = 402 - There are not enough funds on your account!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n})\n\nreq.on('error', error => {\n console.error(error)\n})\nreq.write(postdata);\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " 2,\n \"name\" => \"test #2\",\n \"url\" => \"https://some-destination-endpoint.here\",\n];\n\nif(!$body = json_encode($body)) {\n die('JSON encoding error!');\n}\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_POST => true,\n CURLOPT_URL => $uri,\n CURLOPT_POSTFIELDS => $body,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: $token\",\n 'Accept: application/json', // or application/ld+json\n 'Content-Type: application/json',\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(201 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = $code, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\nurl = 'https://api.lox24.eu/short_link_campaigns'\n\n\ndata = {\n 'type': 2,\n 'name': 'test #2',\n 'url': 'https://some-destination-endpoint.here'\n}\n\nheaders = {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\nprint(\"Post data : \", json.dumps(data, indent=4))\n\ntry:\n # timeout is 100 seconds, the payload is automatically converted to json format\n res = requests.post(url, headers=headers, json=data, timeout=100)\n if res.status_code != 201: # Created\n print(\"Error: Wrong response code on create campaign\")\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - resource created')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 400:\n print(\"Error:400 Invalid input\")\n elif res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 402:\n print(\"Error:402 There are not enough funds on your account!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n\n", "label": "Python" } ] } }, "/short_link_campaigns/subscribe": { "post": { "operationId": "post_subscribe", "tags": [ "campaigns" ], "responses": { "201": { "description": "short_link_campaigns resource created", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.short_link_campaigns.jsonld-short_link_campaign_subscribe_read" } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.short_link_campaigns-short_link_campaign_subscribe_read" } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "422": { "$ref": "#/components/responses/422-unprocessable-entity" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Create a subscription form campaign", "description": "Cria uma campanha de links curtos que fornece URL para um formul\u00e1rio de inscri\u00e7\u00e3o onde os usu\u00e1rios podem se inscrever em campanhas. O n\u00famero de telefone do usu\u00e1rio ser\u00e1 adicionado a um grupo definido pelo usu\u00e1rio que voc\u00ea especificar durante a cria\u00e7\u00e3o da campanha.", "parameters": [], "requestBody": { "description": "The new short_link_campaigns resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schema.short_link_campaigns-short_link_campaign_subscribe_write" } } }, "required": true }, "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X POST https://api.lox24.eu/short_link_campaigns/subscription \\\n -H 'Content-Type: application/json' \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx' \\\n -d '{\n \"name\": \"test #2\",\n \"group_id\": 12345\n }'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json;\nusing Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string url = \"https://api.lox24.eu/short_link_campaigns/subscription\";\n\n var data = new {\n name = \"test #2\",\n group_id = 12345,\n };\n\n string postdata = JsonConvert.SerializeObject(data);\n\n Console.WriteLine(\"Post data: {0}\", postdata);\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.ContentType = \"application/json; charset=utf-8\";\n httpWebRequest.Accept = \"application/json\"; // or application/ld+json\n httpWebRequest.Method = \"POST\";\n httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n using (var streamWriter = new StreamWriter(httpWebRequest.GetRequestStream()))\n {\n streamWriter.Write(postdata);\n streamWriter.Flush();\n streamWriter.Close();\n }\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n\n if(resp.StatusCode == HttpStatusCode.Created) {\n Console.WriteLine(\"Success:{0} {1}\", (int)resp.StatusCode, \"item resource created\");\n } else {\n Console.WriteLine(\"Error: wrong response code {0} on create item\", (int)resp.StatusCode);\n }\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.BadRequest: // 400\n Console.WriteLine(\"Error:400 Invalid input\");\n break;\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"bytes\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"POST\"\n\tconst URL = \"https://api.lox24.eu/short_link_campaigns/subscription\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tpayload := map[string]interface{}{\n\t\t\"name\": \"test #2\",\n\t\t\"group_id\": 12345\n\t}\n\n\tjsonPayload, _ := json.Marshal(payload)\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, bytes.NewBuffer(jsonPayload))\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Content-Type\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 201:\n\t\tfmt.Println((string(body)))\n\tcase 400:\n\t\tfmt.Println(\"Error: code = 400 - Invalid input\")\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.short_links;\n\nimport org.json.JSONObject;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class AddShortLinkCampaignItem {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var url = \"https://api.lox24.eu/short_link_campaigns/subscription\";\n\n var json = new JSONObject();\n\n json.put(\"name\", \"test #2\");\n json.put(\"group_id\", 12345);\n\n var postData = json.toString();\n\n System.out.println(\"Post data: \" + postData);\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Content-Type\", \"application/json; charset=utf-8\")\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .POST(HttpRequest.BodyPublishers.ofString(postData))\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_CREATED) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" resource created\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error: wrong response code \" + httpResponse.statusCode() + \" on create item\");\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_BAD_REQUEST: // 400\n System.out.println(\"Error:400 Invalid input\");\n break;\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar postObj = {\n group_id: 12345,\n name: \"test #2\"\n};\n\nvar postdata = JSON.stringify(postObj);\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/short_link_campaigns/subscription',\n method: 'POST',\n headers: {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'Content-Length': postdata.length,\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 201) {\n console.log(\"Success: code = 201 - resource created\");\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 400) {\n console.log(\"Error: code = 400 - Invalid input\");\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 402) {\n console.log(\"Error: code = 402 - There are not enough funds on your account!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n})\n\nreq.on('error', error => {\n console.error(error)\n})\nreq.write(postdata);\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " 12345,\n \"name\" => \"test #2\",\n];\n\nif(!$body = json_encode($body)) {\n die('JSON encoding error!');\n}\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_POST => true,\n CURLOPT_URL => $uri,\n CURLOPT_POSTFIELDS => $body,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: $token\",\n 'Accept: application/json', // or application/ld+json\n 'Content-Type: application/json',\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(201 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = $code, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\nurl = 'https://api.lox24.eu/short_link_campaigns/subscription'\n\n\ndata = {\n 'group_id': 2,\n 'name': 'test #2',\n}\n\nheaders = {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\nprint(\"Post data : \", json.dumps(data, indent=4))\n\ntry:\n # timeout is 100 seconds, the payload is automatically converted to json format\n res = requests.post(url, headers=headers, json=data, timeout=100)\n if res.status_code != 201: # Created\n print(\"Error: Wrong response code on create campaign\")\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - resource created')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 400:\n print(\"Error:400 Invalid input\")\n elif res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 402:\n print(\"Error:402 There are not enough funds on your account!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n\n", "label": "Python" } ] } }, "/short_link_campaigns/unsubscribe": { "post": { "operationId": "post_unsubscribe", "tags": [ "campaigns" ], "responses": { "201": { "description": "short_link_campaigns resource created", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.short_link_campaigns.jsonld-short_link_campaign_subscribe_read" } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.short_link_campaigns-short_link_campaign_subscribe_read" } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "422": { "$ref": "#/components/responses/422-unprocessable-entity" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Create a unsubscription form campaign", "description": "Cria uma campanha de links curtos que redireciona os usu\u00e1rios para um formul\u00e1rio especial de cancelamento de inscri\u00e7\u00e3o onde podem cancelar a inscri\u00e7\u00e3o de notifica\u00e7\u00f5es SMS e opcionalmente fornecer uma raz\u00e3o. Voc\u00ea pode especificar opcionalmente um grupo de telefones onde os dados ser\u00e3o coletados. Mesmo sem especificar um grupo, o n\u00famero de telefone ser\u00e1 adicionado \u00e0 lista de n\u00fameros bloqueados com tipo 2 (cancelado).", "parameters": [], "requestBody": { "description": "The new short_link_campaigns resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schema.short_link_campaigns-short_link_campaign_subscribe_write" } } }, "required": true }, "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X POST https://api.lox24.eu/short_link_campaigns/unsubscription \\\n -H 'Content-Type: application/json' \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx' \\\n -d '{\n \"name\": \"test #2\",\n \"group_id\": 12345\n }'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json;\nusing Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string url = \"https://api.lox24.eu/short_link_campaigns/unsubscription\";\n\n var data = new {\n name = \"test #2\",\n group_id = 12345,\n };\n\n string postdata = JsonConvert.SerializeObject(data);\n\n Console.WriteLine(\"Post data: {0}\", postdata);\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.ContentType = \"application/json; charset=utf-8\";\n httpWebRequest.Accept = \"application/json\"; // or application/ld+json\n httpWebRequest.Method = \"POST\";\n httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n using (var streamWriter = new StreamWriter(httpWebRequest.GetRequestStream()))\n {\n streamWriter.Write(postdata);\n streamWriter.Flush();\n streamWriter.Close();\n }\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n\n if(resp.StatusCode == HttpStatusCode.Created) {\n Console.WriteLine(\"Success:{0} {1}\", (int)resp.StatusCode, \"item resource created\");\n } else {\n Console.WriteLine(\"Error: wrong response code {0} on create item\", (int)resp.StatusCode);\n }\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.BadRequest: // 400\n Console.WriteLine(\"Error:400 Invalid input\");\n break;\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"bytes\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"POST\"\n\tconst URL = \"https://api.lox24.eu/short_link_campaigns/unsubscription\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tpayload := map[string]interface{}{\n\t\t\"name\": \"test #2\",\n\t\t\"group_id\": 12345\n\t}\n\n\tjsonPayload, _ := json.Marshal(payload)\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, bytes.NewBuffer(jsonPayload))\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Content-Type\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 201:\n\t\tfmt.Println((string(body)))\n\tcase 400:\n\t\tfmt.Println(\"Error: code = 400 - Invalid input\")\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.short_links;\n\nimport org.json.JSONObject;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class AddShortLinkCampaignItem {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var url = \"https://api.lox24.eu/short_link_campaigns/unsubscription\";\n\n var json = new JSONObject();\n\n json.put(\"name\", \"test #2\");\n json.put(\"group_id\", 12345);\n\n var postData = json.toString();\n\n System.out.println(\"Post data: \" + postData);\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Content-Type\", \"application/json; charset=utf-8\")\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .POST(HttpRequest.BodyPublishers.ofString(postData))\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_CREATED) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" resource created\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error: wrong response code \" + httpResponse.statusCode() + \" on create item\");\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_BAD_REQUEST: // 400\n System.out.println(\"Error:400 Invalid input\");\n break;\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar postObj = {\n group_id: 12345,\n name: \"test #2\"\n};\n\nvar postdata = JSON.stringify(postObj);\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/short_link_campaigns/unsubscription',\n method: 'POST',\n headers: {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'Content-Length': postdata.length,\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 201) {\n console.log(\"Success: code = 201 - resource created\");\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 400) {\n console.log(\"Error: code = 400 - Invalid input\");\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 402) {\n console.log(\"Error: code = 402 - There are not enough funds on your account!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n})\n\nreq.on('error', error => {\n console.error(error)\n})\nreq.write(postdata);\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " 12345,\n \"name\" => \"test #2\",\n];\n\nif(!$body = json_encode($body)) {\n die('JSON encoding error!');\n}\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_POST => true,\n CURLOPT_URL => $uri,\n CURLOPT_POSTFIELDS => $body,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: $token\",\n 'Accept: application/json', // or application/ld+json\n 'Content-Type: application/json',\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(201 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = $code, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\nurl = 'https://api.lox24.eu/short_link_campaigns/unsubscription'\n\n\ndata = {\n 'group_id': 2,\n 'name': 'test #2',\n}\n\nheaders = {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\nprint(\"Post data : \", json.dumps(data, indent=4))\n\ntry:\n # timeout is 100 seconds, the payload is automatically converted to json format\n res = requests.post(url, headers=headers, json=data, timeout=100)\n if res.status_code != 201: # Created\n print(\"Error: Wrong response code on create campaign\")\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - resource created')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 400:\n print(\"Error:400 Invalid input\")\n elif res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 402:\n print(\"Error:402 There are not enough funds on your account!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n\n", "label": "Python" } ] } }, "/short_link_campaigns/{code}": { "get": { "operationId": "api_short_link_campaigns_get_item", "tags": [ "campaigns" ], "responses": { "200": { "description": "short_link_campaigns resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.short_link_campaigns.jsonld-short_link_campaign_read" } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.short_link_campaigns-short_link_campaign_read" } } } }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Get Short Link data by Campaign-ID", "description": "Retrieve a specific Short Link Campaign by it's ID. If the Campaign is not found then the HTTP code response will be 404.", "parameters": [ { "$ref": "#/components/parameters/path.short_link_campaigns.code" } ], "deprecated": false }, "put": { "operationId": "api_short_link_campaigns_put_item", "tags": [ "campaigns" ], "responses": { "200": { "description": "short_link_campaigns resource updated", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.short_link_campaigns.jsonld-short_link_campaign_read" } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.short_link_campaigns-short_link_campaign_read" } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Edit a Short Link Campaign", "description": "Edit the values of a specific Short Link Campaigns. If the Campaign is not found then the HTTP code response will be 404.", "parameters": [ { "$ref": "#/components/parameters/path.short_link_campaigns.code" } ], "requestBody": { "description": "The updated short_link_campaigns resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schema.short_link_campaigns-short_link_campaign_write" } } }, "required": true }, "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X PUT https://api.lox24.eu/short_link_campaigns/campaign_id_here \\\n -H 'Content-Type: application/json' \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx' \\\n -d '{\n \"type\": 2,\n \"name\": \"test #2\",\n \"url\": \"https://some-destination-endpoint.here\"\n }'\n", "label": "Bash" }, { "lang": "csharp", "source": "\nusing Newtonsoft.Json;\nusing Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string url = \"https://api.lox24.eu/short_link_campaigns/campaign_id_here\";\n\n var data = new {\n name = \"test #2\",\n url = \"https://some-destination-endpoint.here\",\n };\n\n\n string postdata = JsonConvert.SerializeObject(data);\n\n Console.WriteLine(\"Post data: {0}\", postdata);\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.ContentType = \"application/json; charset=utf-8\";\n httpWebRequest.Accept = \"application/json\"; // or application/ld+json\n httpWebRequest.Method = \"POST\";\n httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n using (var streamWriter = new StreamWriter(httpWebRequest.GetRequestStream()))\n {\n streamWriter.Write(postdata);\n streamWriter.Flush();\n streamWriter.Close();\n }\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n\n if(resp.StatusCode == HttpStatusCode.Created) {\n Console.WriteLine(\"Success:{0} {1}\", (int)resp.StatusCode, \"item resource created\");\n } else {\n Console.WriteLine(\"Error: wrong response code {0} on create item\", (int)resp.StatusCode);\n }\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.BadRequest: // 400\n Console.WriteLine(\"Error:400 Invalid input\");\n break;\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.NotFound: // 404\n Console.WriteLine(\"Error:404 Resource not found\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"bytes\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"PUT\"\n\tconst URL = \"https://api.lox24.eu/short_link_campaigns/campaign_id_here\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tpayload := map[string]interface{}{\n\t\t\"name\": \"test #2\",\n\t\t\"url\": \"https://some-destination-endpoint.here\",\n\t}\n\n\tjsonPayload, _ := json.Marshal(payload)\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, bytes.NewBuffer(jsonPayload))\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Content-Type\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println((string(body)))\n\tcase 400:\n\t\tfmt.Println(\"Error: code = 400 - Invalid input\")\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.short_links;\n\nimport org.json.JSONObject;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class EditShortLinkCampaignItem {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var url = \"https://api.lox24.eu/short_link_campaigns/campaign_id_here\";\n\n var json = new JSONObject();\n json.put(\"type\", 2);\n json.put(\"name\", \"test #2\");\n json.put(\"url\", \"https://some-destination-endpoint.here\");\n\n var data = json.toString();\n\n System.out.println(\"PUT data: \" + data);\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Content-Type\", \"application/json; charset=utf-8\")\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .PUT(HttpRequest.BodyPublishers.ofString(data))\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success: \" + httpResponse.statusCode() + \" resource updated\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error: wrong response code \" + httpResponse.statusCode() + \" on update a campaign\");\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_BAD_REQUEST: // 400\n System.out.println(\"Error:400 Invalid input\");\n break;\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_NOT_FOUND: // 404\n System.out.println(\"Error:404 Resource not found\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar id = 'campaign_id_here';\n\nvar postObj = {\n name: \"test #2\",\n url: \"https://some-destination-endpoint.here\"\n};\n\nvar postdata = JSON.stringify(postObj);\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/short_link_campaigns/' + id,\n method: 'PUT',\n headers: {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'Content-Length': postdata.length,\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log(\"Success: code = 201 - resource updated\");\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 400) {\n console.log(\"Error: code = 400 - Invalid input\");\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else if (res.statusCode == 404) {\n console.log(\"Error: code = 404 - Resource not found\");\n } else {\n console.log(\"Error: code = \" + res.statusCode);\n }\n})\n\nreq.on('error', error => {\n console.error(error)\n})\nreq.write(postdata);\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " \"test #2\",\n \"url\" => \"https://some-destination-endpoint.here\",\n];\n\nif(!$body = json_encode($body)) {\n die('JSON encoding error!');\n}\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_CUSTOMREQUEST => 'PUT',\n CURLOPT_URL => $uri,\n CURLOPT_POSTFIELDS => $body,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: $token\",\n 'Accept: application/json', // or application/ld+json\n 'Content-Type: application/json',\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = $code, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\nid = \"short_link_campaigns\"\n\nurl = f'https://api.lox24.eu/short_link_campaigns/{id}'\n\n\ndata = {\n 'name': 'test #2',\n 'url': 'https://some-destination-endpoint.here'\n}\nheaders = {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\nprint(\"Post data : \", json.dumps(data, indent=4))\n\ntry:\n # timeout is 100 seconds, the payload is automatically converted to json format\n res = requests.put(url, headers=headers, json=data, timeout=100)\n if res.status_code != 200: # OK\n print(\"Error: Wrong response code on update campaign\")\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - campaign updated')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 400:\n print(\"Error:400 Invalid input\")\n elif res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 404:\n print(\"Error:404 Resource not found\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n\n", "label": "Python" } ] }, "delete": { "operationId": "api_short_link_campaigns_delete_item", "tags": [ "campaigns" ], "responses": { "204": { "$ref": "#/components/responses/204-deleted" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Delete a Short Link Campaign", "description": "Delete a Short Link Campaign. If the Campaign is not found then the HTTP code response will be 404.", "parameters": [ { "$ref": "#/components/parameters/path.short_link_campaigns.code" } ], "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X DELETE https://api.lox24.eu/short_link_campaigns/campaign_id_here \\\n -H 'Content-Type: application/json' \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "\nusing Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\n var id = \"campaign_id_here\";\n string url = \"https://api.lox24.eu/short_link_campaigns/\" + id;\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\";\n httpWebRequest.Method = \"DELETE\";\n //httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n if(resp.StatusCode == HttpStatusCode.NoContent) { //204\n Console.WriteLine(\"Success: item was deleted\");\n } else {\n Console.WriteLine(\"Error: something went wrong, code({0})\", respCode);\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n\n JObject parsed = JObject.Parse(responseText);\n\n foreach (var pair in parsed)\n {\n Console.WriteLine(\"{0}: {1}\", pair.Key, pair.Value);\n }\n }\n }\n\n }\n\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.NotFound: // 404\n Console.WriteLine(\"Error:404 Resource not found\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "\npackage main\n\nimport (\n\t\"fmt\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"DELETE\"\n\tconst URL = \"https://api.lox24.eu/short_link_campaigns/campaign_id_here\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tswitch res.StatusCode {\n\tcase 204:\n\t\tfmt.Println(\"Item was deleted!\")\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tcase 404:\n\t\tfmt.Println(\"Error: code = 404 - Resource not found\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.short_links;\n\nimport org.json.JSONObject;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class DeleteShortLinkCampaignItem {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var userId = \"1234567\";\n\n var id = \"campaign_id_here\";\n var url = \"https://api.lox24.eu/short_link_campaigns/\" + id;\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .DELETE()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_NO_CONTENT) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"item was delete.\");\n } else {\n System.out.println(\"Error: something went wrong, code(\" + httpResponse.statusCode() + \")\");\n\n JSONObject parsed = new JSONObject(httpResponse.body());\n\n parsed.keys().forEachRemaining(jsonKey -> System.out.println(jsonKey + \":\" + parsed.get(jsonKey)));\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_NOT_FOUND: // 404\n System.out.println(\"Error:404 Resource not found\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar id = 'campaign_id_here';\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/short_link_campaigns/' + id,\n method: 'DELETE',\n headers: {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 204) {\n console.log('Success: code = 204 - resource deleted');\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else if (res.statusCode == 404) {\n console.log(\"Error: code = 404 - Resource not found\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n});\n\nreq.on('error', error => {\n console.error(error)\n});\n\nreq.end();\n\n\n", "label": "JavaScript" }, { "lang": "php", "source": " $uri,\n CURLOPT_CUSTOMREQUEST => 'DELETE',\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: $token\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\nif(204 === $code) {\n echo \"Item with id = $id was deleted!\";\n} elseif(404 === $code) {\n echo \"Item with id = $id not found!\";\n} else {\n $data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n echo \"Campaign: code = $code, data = \" . var_export($data, true);\n}\n\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\nid = \"campaign_id_here\"\n\nurl = f'https://api.lox24.eu/short_link_campaigns/{id}'\n\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.delete(url, headers=headers, timeout=100)\n if res.status_code != 204: # No Content\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - item was deleted')\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 404:\n print(\"Error:404 Resource not found\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n\n\n", "label": "Python" } ] } }, "/bulks/{id}/requests": { "get": { "operationId": "get_bulk_requests", "tags": [ "requests" ], "responses": { "200": { "description": "short_link_requests collection", "content": { "application/ld+json": { "schema": { "type": "object", "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/schema.short_link_requests.jsonld-short_link_request_read" } }, "hydra:totalItems": { "type": "integer", "minimum": 0 }, "hydra:view": { "$ref": "#/components/schemas/hydra.view" }, "hydra:search": { "$ref": "#/components/schemas/hydra.search" } }, "required": [ "member" ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/schema.short_link_requests-short_link_request_read" } } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "List by a bulk sms ID", "description": "List of all requests by a SMS Bulk ID", "parameters": [ { "$ref": "#/components/parameters/path.bulks.id" }, { "$ref": "#/components/parameters/filter.common.page" }, { "$ref": "#/components/parameters/order.short_link_request.date" }, { "$ref": "#/components/parameters/filter.short_link_request.ip.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.url.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.user_agent.partial" }, { "$ref": "#/components/parameters/filter.common.country.exact" }, { "$ref": "#/components/parameters/filter.common.country.array" }, { "$ref": "#/components/parameters/filter.short_link_request.referer.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.date.exact" }, { "$ref": "#/components/parameters/filter.short_link_request.date.array" }, { "$ref": "#/components/parameters/filter.short_link_request.type.exact" }, { "$ref": "#/components/parameters/filter.short_link_request.type.array" }, { "$ref": "#/components/parameters/filter.short_link_request.browser.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.os.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.os_version.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.software_type.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.hardware_type.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.date.between" }, { "$ref": "#/components/parameters/filter.short_link_request.date.gt" }, { "$ref": "#/components/parameters/filter.short_link_request.date.gte" }, { "$ref": "#/components/parameters/filter.short_link_request.date.lt" }, { "$ref": "#/components/parameters/filter.short_link_request.date.lte" } ], "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X GET https://api.lox24.eu/bulks/{bulk_id_here}/requests \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string bulk = \"bulk_id_here\";\n string url = \"https://api.lox24.eu/bulks/\" + bulk + \"/requests?page=1\";\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\"; // or \"application/ld+json\"\n httpWebRequest.Method = \"GET\";\n //httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n Console.WriteLine(\"Success:{0} {1}\", respCode, \"collection response\");\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"GET\"\n\tconst URL = \"https://api.lox24.eu/bulks/{bulk_id_here}/requests?page=1\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println((string(body)))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.sms_clicks;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GetCollection {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var url = \"https://api.lox24.eu/bulks/{bulk_id_here}/requests?page=1\";\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .GET()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" collection response\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n } else {\n System.out.println(\"Error: something went wrong, code(\" + httpResponse.statusCode() + \")\");\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar query = \"page=1\";\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/bulks/{bulk_id_here}/requests?' + query,\n method: 'GET',\n headers: {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log('Success: code = 200 - list response');\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n\n});\n\nreq.on('error', error => {\n console.error(error)\n});\n\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " 1,\n];\n\n$uri .= $filters ? '?' . http_build_query($filters) : '';\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_URL => $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: $token\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = $code, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\nbulkId = \"bulk_id\"\n\nurl = \"https://api.lox24.eu/bulks/{bulk_id}/requests?page=1\"\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - items collection response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n", "label": "Python" } ] } }, "/short_link_campaigns/{code}/requests": { "get": { "operationId": "get_campaign_requests", "tags": [ "requests" ], "responses": { "200": { "description": "short_link_requests collection", "content": { "application/ld+json": { "schema": { "type": "object", "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/schema.short_link_requests.jsonld-short_link_request_read" } }, "hydra:totalItems": { "type": "integer", "minimum": 0 }, "hydra:view": { "$ref": "#/components/schemas/hydra.view" }, "hydra:search": { "$ref": "#/components/schemas/hydra.search" } }, "required": [ "member" ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/schema.short_link_requests-short_link_request_read" } } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "List requests by campaign", "description": "Lists all clicks on shortlinks for a specific campaign", "parameters": [ { "$ref": "#/components/parameters/path.short_link_campaigns.code" }, { "$ref": "#/components/parameters/filter.common.page" }, { "$ref": "#/components/parameters/order.short_link_request.date" }, { "$ref": "#/components/parameters/filter.short_link_request.ip.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.url.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.user_agent.partial" }, { "$ref": "#/components/parameters/filter.common.country.exact" }, { "$ref": "#/components/parameters/filter.common.country.array" }, { "$ref": "#/components/parameters/filter.short_link_request.referer.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.date.exact" }, { "$ref": "#/components/parameters/filter.short_link_request.date.array" }, { "$ref": "#/components/parameters/filter.short_link_request.type.exact" }, { "$ref": "#/components/parameters/filter.short_link_request.type.array" }, { "$ref": "#/components/parameters/filter.short_link_request.browser.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.os.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.os_version.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.software_type.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.hardware_type.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.date.between" }, { "$ref": "#/components/parameters/filter.short_link_request.date.gt" }, { "$ref": "#/components/parameters/filter.short_link_request.date.gte" }, { "$ref": "#/components/parameters/filter.short_link_request.date.lt" }, { "$ref": "#/components/parameters/filter.short_link_request.date.lte" } ], "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X GET https://api.lox24.eu//short_link_campaigns/{campaign_id}/requests \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string campaign = \"campaign_id_here\";\n string url = \"https://api.lox24.eu/short_link_campaigns/\" + campaign + \"/requests?page=1\";\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\"; // or \"application/ld+json\"\n httpWebRequest.Method = \"GET\";\n //httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n Console.WriteLine(\"Success:{0} {1}\", respCode, \"collection response\");\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"GET\"\n\tconst URL = \"https://api.lox24.eu/short_link_campaigns/{campaign_id_here}/requests?page=1\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println((string(body)))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.sms_clicks;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GetCollection {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var url = \"https://api.lox24.eu/short_link_campaigns/{campaign_id_here}/requests?page=1\";\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .GET()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" collection response\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n } else {\n System.out.println(\"Error: something went wrong, code(\" + httpResponse.statusCode() + \")\");\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar query = \"page=1\";\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/short_link_campaigns/{campaign_id_here}/requests?' + query,\n method: 'GET',\n headers: {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log('Success: code = 200 - list response');\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n\n});\n\nreq.on('error', error => {\n console.error(error)\n});\n\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " 1,\n];\n\n$uri .= $filters ? '?' . http_build_query($filters) : '';\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_URL => $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: $token\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = $code, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\ncampaignId = \"campaign_id\"\n\nurl = \"https://api.lox24.eu/short_link_campaigns/{campaignId}/requests?page=1\"\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - items collection response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n", "label": "Python" } ] } }, "/short_link_requests": { "get": { "operationId": "api_short_link_requests_get_collection", "tags": [ "requests" ], "responses": { "200": { "description": "short_link_requests collection", "content": { "application/ld+json": { "schema": { "type": "object", "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/schema.short_link_requests.jsonld-short_link_request_read" } }, "hydra:totalItems": { "type": "integer", "minimum": 0 }, "hydra:view": { "$ref": "#/components/schemas/hydra.view" }, "hydra:search": { "$ref": "#/components/schemas/hydra.search" } }, "required": [ "member" ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/schema.short_link_requests-short_link_request_read" } } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "List all requests", "description": "Lists all clicks on shortlinks", "parameters": [ { "$ref": "#/components/parameters/filter.common.page" }, { "$ref": "#/components/parameters/order.short_link_request.date" }, { "$ref": "#/components/parameters/filter.short_link_request.ip.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.url.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.user_agent.partial" }, { "$ref": "#/components/parameters/filter.common.country.exact" }, { "$ref": "#/components/parameters/filter.common.country.array" }, { "$ref": "#/components/parameters/filter.short_link_request.referer.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.date.exact" }, { "$ref": "#/components/parameters/filter.short_link_request.date.array" }, { "$ref": "#/components/parameters/filter.short_link_request.type.exact" }, { "$ref": "#/components/parameters/filter.short_link_request.type.array" }, { "$ref": "#/components/parameters/filter.short_link_request.browser.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.browser_version.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.os.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.os_version.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.software_type.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.hardware_type.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.date.between" }, { "$ref": "#/components/parameters/filter.short_link_request.date.gt" }, { "$ref": "#/components/parameters/filter.short_link_request.date.gte" }, { "$ref": "#/components/parameters/filter.short_link_request.date.lt" }, { "$ref": "#/components/parameters/filter.short_link_request.date.lte" } ], "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X GET https://api.lox24.eu/short_link_requests \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string url = \"https://api.lox24.eu/short_link_requests?page=1\";\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\"; // or \"application/ld+json\"\n httpWebRequest.Method = \"GET\";\n //httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n Console.WriteLine(\"Success:{0} {1}\", respCode, \"collection response\");\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"GET\"\n\tconst URL = \"https://api.lox24.eu/short_link_requests?page=1\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println((string(body)))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.sms_clicks;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GetCollection {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var url = \"https://api.lox24.eu/short_link_requests?page=1\";\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .GET()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" collection response\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n } else {\n System.out.println(\"Error: something went wrong, code(\" + httpResponse.statusCode() + \")\");\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar query = \"page=1\";\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/short_link_requests?' + query,\n method: 'GET',\n headers: {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log('Success: code = 200 - list response');\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n\n});\n\nreq.on('error', error => {\n console.error(error)\n});\n\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " 1,\n];\n\n$uri .= $filters ? '?' . http_build_query($filters) : '';\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_URL => $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: $token\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = $code, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\nurl = \"https://api.lox24.eu/short_link_requests?page=1\"\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - items collection response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n", "label": "Python" } ] } }, "/short_link_requests/{id}": { "get": { "operationId": "api_short_link_requests_get_item", "tags": [ "requests" ], "responses": { "200": { "description": "short_link_requests resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.short_link_requests.jsonld-short_link_request_read" } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.short_link_requests-short_link_request_read" } } } }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Request info", "description": "Retrieve the detail information about a short link click", "parameters": [ { "$ref": "#/components/parameters/path.short_link_requests.id" } ], "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl https://api.lox24.eu/short_link_requests/request_id_here \\\n -H 'Content-Type: application/json' \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string id = \"request_id_here\";\n\n string url = \"https://api.lox24.eu/short_link_requests/\" + id;\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\"; //or application/ld+json\n httpWebRequest.Method = \"GET\";\n httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n Console.WriteLine(\"Success:{0} {1}\", respCode, \"item resource response\");\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.NotFound: // 404\n Console.WriteLine(\"Error:404 Resource not found\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"GET\"\n\tconst URL = \"https://api.lox24.eu/short_link_requests/request_id_here\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println((string(body)))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tcase 404:\n\t\tfmt.Println(\"Error: code = 404 - Resource not found\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.sms_clicks;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GetItem {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var userId = \"1234567\";\n var id = \"request_id_here\";\n\n var url = \"https://api.lox24.eu/short_link_requests\" + id;\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .GET()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode());\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error: wrong response code \" + httpResponse.statusCode());\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_NOT_FOUND: // 404\n System.out.println(\"Error:404 Resource not found\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar id = 'request_id_here';\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/short_link_requests/' + id,\n method: 'GET',\n headers: {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log('Success: code = 200');\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else if (res.statusCode == 404) {\n console.log(\"Error: code = 404 - Resource not found\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n\n})\n\nreq.on('error', error => {\n console.error(error)\n})\n\nreq.end();\n\n", "label": "JavaScript" }, { "lang": "php", "source": " $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: $token\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} elseif(404 === $code) {\n echo \"Item with id = $id not found!\";\n} else {\n echo \"Error: code = $code, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\nid = \"request_id\"\n\nurl = f'https://api.lox24.eu/short_link_requests/{id}'\n\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - resource response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 404:\n print(\"Error:404 Resource not found\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n\n", "label": "Python" } ] } }, "/short_links/{shortCode}/requests": { "get": { "operationId": "get_short_links_requests", "tags": [ "requests" ], "responses": { "200": { "description": "short_link_requests collection", "content": { "application/ld+json": { "schema": { "type": "object", "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/schema.short_link_requests.jsonld-short_link_request_read" } }, "hydra:totalItems": { "type": "integer", "minimum": 0 }, "hydra:view": { "$ref": "#/components/schemas/hydra.view" }, "hydra:search": { "$ref": "#/components/schemas/hydra.search" } }, "required": [ "member" ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/schema.short_link_requests-short_link_request_read" } } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "List by a short link", "description": "List of all requests by a short link campaign code", "parameters": [ { "$ref": "#/components/parameters/path.short_links.shortCode" }, { "$ref": "#/components/parameters/filter.common.page" }, { "$ref": "#/components/parameters/order.short_link_request.date" }, { "$ref": "#/components/parameters/filter.short_link_request.ip.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.url.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.user_agent.partial" }, { "$ref": "#/components/parameters/filter.common.country.exact" }, { "$ref": "#/components/parameters/filter.common.country.array" }, { "$ref": "#/components/parameters/filter.short_link_request.referer.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.date.exact" }, { "$ref": "#/components/parameters/filter.short_link_request.date.array" }, { "$ref": "#/components/parameters/filter.short_link_request.type.exact" }, { "$ref": "#/components/parameters/filter.short_link_request.type.array" }, { "$ref": "#/components/parameters/filter.short_link_request.browser.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.browser_version.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.os.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.os_version.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.software_type.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.hardware_type.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.date.between" }, { "$ref": "#/components/parameters/filter.short_link_request.date.gt" }, { "$ref": "#/components/parameters/filter.short_link_request.date.gte" }, { "$ref": "#/components/parameters/filter.short_link_request.date.lt" }, { "$ref": "#/components/parameters/filter.short_link_request.date.lte" } ], "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X GET https://api.lox24.eu/short_links/{short_link_id}/requests \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string link = \"short_link_id\";\n string url = \"https://api.lox24.eu/short_links/\" + link + \"/requests?page=1\";\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\"; // or \"application/ld+json\"\n httpWebRequest.Method = \"GET\";\n //httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n Console.WriteLine(\"Success:{0} {1}\", respCode, \"collection response\");\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"GET\"\n\tconst URL = \"https://api.lox24.eu/short_links/{short_link_id_here}/requests?page=1\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println((string(body)))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.sms_clicks;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GetCollection {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var url = \"https://api.lox24.eu/short_links/{short_link_id_here}/requests?page=1\";\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .GET()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" collection response\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n } else {\n System.out.println(\"Error: something went wrong, code(\" + httpResponse.statusCode() + \")\");\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar query = \"page=1\";\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/short_links/{short_link_id_here}/requests?' + query,\n method: 'GET',\n headers: {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log('Success: code = 200 - list response');\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n\n});\n\nreq.on('error', error => {\n console.error(error)\n});\n\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " 1,\n];\n\n$uri .= $filters ? '?' . http_build_query($filters) : '';\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_URL => $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: $token\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = $code, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\nlinkId = \"short_link_id\"\n\nurl = \"https://api.lox24.eu/short_links/{linkId}/requests?page=1\"\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - items collection response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n", "label": "Python" } ] } }, "/sms/{uuid}/requests": { "get": { "operationId": "get_sms_requests", "tags": [ "requests" ], "responses": { "200": { "description": "short_link_requests collection", "content": { "application/ld+json": { "schema": { "type": "object", "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/schema.short_link_requests.jsonld-short_link_request_read" } }, "hydra:totalItems": { "type": "integer", "minimum": 0 }, "hydra:view": { "$ref": "#/components/schemas/hydra.view" }, "hydra:search": { "$ref": "#/components/schemas/hydra.search" } }, "required": [ "member" ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/schema.short_link_requests-short_link_request_read" } } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "List by a SMS", "description": "List of all requests by a single SMS ID", "parameters": [ { "$ref": "#/components/parameters/path.sms.uuid" }, { "$ref": "#/components/parameters/filter.common.page" }, { "$ref": "#/components/parameters/order.short_link_request.date" }, { "$ref": "#/components/parameters/filter.short_link_request.ip.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.url.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.user_agent.partial" }, { "$ref": "#/components/parameters/filter.common.country.exact" }, { "$ref": "#/components/parameters/filter.common.country.array" }, { "$ref": "#/components/parameters/filter.short_link_request.referer.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.date.exact" }, { "$ref": "#/components/parameters/filter.short_link_request.date.array" }, { "$ref": "#/components/parameters/filter.short_link_request.type.exact" }, { "$ref": "#/components/parameters/filter.short_link_request.type.array" }, { "$ref": "#/components/parameters/filter.short_link_request.browser.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.os.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.os_version.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.software_type.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.hardware_type.partial" }, { "$ref": "#/components/parameters/filter.short_link_request.date.between" }, { "$ref": "#/components/parameters/filter.short_link_request.date.gt" }, { "$ref": "#/components/parameters/filter.short_link_request.date.gte" }, { "$ref": "#/components/parameters/filter.short_link_request.date.lt" }, { "$ref": "#/components/parameters/filter.short_link_request.date.lte" } ], "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X GET https://api.lox24.eu/sms/{sms_id}/requests \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\t\t\tstring sms = \"sms_id\";\n\t\t\tstring url = \"https://api.lox24.eu/sms/\" + sms + \"/requests?page=1\";\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\"; // or \"application/ld+json\"\n httpWebRequest.Method = \"GET\";\n //httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n Console.WriteLine(\"Success:{0} {1}\", respCode, \"collection response\");\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"GET\"\n\tconst URL = \"https://api.lox24.eu/sms/{sms_id_here}/requests?page=1\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println((string(body)))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.sms_clicks;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GetCollection {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var url = \"https://api.lox24.eu/sms/{sms_id_here}/requests?page=1\";\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .GET()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" collection response\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n } else {\n System.out.println(\"Error: something went wrong, code(\" + httpResponse.statusCode() + \")\");\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar query = \"page=1\";\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/sms/{sms_id_here}/requests?' + query,\n method: 'GET',\n headers: {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log('Success: code = 200 - list response');\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n\n});\n\nreq.on('error', error => {\n console.error(error)\n});\n\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " 1,\n];\n\n$uri .= $filters ? '?' . http_build_query($filters) : '';\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_URL => $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: $token\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = $code, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\nsmsId = \"sms_id\"\n\nurl = \"https://api.lox24.eu/sms/{smsId}/requests?page=1\"\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - items collection response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n", "label": "Python" } ] } }, "/short_links": { "get": { "operationId": "api_short_links_get_collection", "tags": [ "links" ], "responses": { "200": { "description": "short_links collection", "content": { "application/ld+json": { "schema": { "type": "object", "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/schema.short_links.jsonld-short_link_read" } }, "hydra:totalItems": { "type": "integer", "minimum": 0 }, "hydra:view": { "$ref": "#/components/schemas/hydra.view" }, "hydra:search": { "$ref": "#/components/schemas/hydra.search" } }, "required": [ "member" ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/schema.short_links-short_link_read" } } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "List of all individual short links", "description": "List of all short links which were used in all existing campaigns.", "parameters": [ { "$ref": "#/components/parameters/filter.common.page" }, { "$ref": "#/components/parameters/order.common.updated_at" }, { "$ref": "#/components/parameters/filter.short_link_request.url.partial" }, { "$ref": "#/components/parameters/filter.common.updated_at.exact" }, { "$ref": "#/components/parameters/filter.common.updated_at.array" } ], "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X GET https://api.lox24.eu/short_links \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string url = \"https://api.lox24.eu/short_links?page=1\";\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\"; // or \"application/ld+json\"\n httpWebRequest.Method = \"GET\";\n //httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n Console.WriteLine(\"Success:{0} {1}\", respCode, \"collection response\");\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"GET\"\n\tconst URL = \"https://api.lox24.eu/short_links?page=1\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println((string(body)))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.sms_clicks;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GetCollection {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var url = \"https://api.lox24.eu/short_links?page=1\";\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .GET()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" collection response\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n } else {\n System.out.println(\"Error: something went wrong, code(\" + httpResponse.statusCode() + \")\");\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar query = \"page=1\";\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/short_links?' + query,\n method: 'GET',\n headers: {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log('Success: code = 200 - list response');\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n\n});\n\nreq.on('error', error => {\n console.error(error)\n});\n\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " 1,\n];\n\n$uri .= $filters ? '?' . http_build_query($filters) : '';\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_URL => $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: $token\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = $code, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\nurl = \"https://api.lox24.eu/short_links?page=1\"\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - items collection response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n", "label": "Python" } ] } }, "/short_links/{shortCode}": { "get": { "operationId": "api_short_links_get_item", "deprecated": false, "responses": { "200": { "description": "short_links resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.short_links.jsonld-short_link_read" } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.short_links-short_link_read" } } } }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Individual short link data by ID", "description": "Retrieve all the information about a specific short link.", "parameters": [ { "$ref": "#/components/parameters/path.short_links.shortCode" } ], "tags": [ "links" ], "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl https://api.lox24.eu/short_links/short_link_id \\\n -H 'Content-Type: application/json' \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string id = \"short_link_id\";\n\n string url = \"https://api.lox24.eu/short_links/\" + id;\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\"; //or application/ld+json\n httpWebRequest.Method = \"GET\";\n httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n Console.WriteLine(\"Success:{0} {1}\", respCode, \"item resource response\");\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.NotFound: // 404\n Console.WriteLine(\"Error:404 Resource not found\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"GET\"\n\tconst URL = \"https://api.lox24.eu/short_links/short_link_id\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println((string(body)))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tcase 404:\n\t\tfmt.Println(\"Error: code = 404 - Resource not found\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.sms_clicks;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GetItem {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var userId = \"1234567\";\n var id = \"short_link_id\";\n\n var url = \"https://api.lox24.eu/short_links/\" + id;\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .GET()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode());\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error: wrong response code \" + httpResponse.statusCode());\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_NOT_FOUND: // 404\n System.out.println(\"Error:404 Resource not found\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar id = 'short_link_id';\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/short_links/' + id,\n method: 'GET',\n headers: {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log('Success: code = 200');\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else if (res.statusCode == 404) {\n console.log(\"Error: code = 404 - Resource not found\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n\n})\n\nreq.on('error', error => {\n console.error(error)\n})\n\nreq.end();\n\n", "label": "JavaScript" }, { "lang": "php", "source": " $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: $token\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} elseif(404 === $code) {\n echo \"Item with id = $id not found!\";\n} else {\n echo \"Error: code = $code, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\nid = \"short_link_id\"\n\nurl = f'https://api.lox24.eu/short_links/{id}'\n\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - resource response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 404:\n print(\"Error:404 Resource not found\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n\n", "label": "Python" } ] } }, "/sms": { "get": { "operationId": "api_sms_get_collection", "tags": [ "sms" ], "responses": { "200": { "description": "sms collection", "content": { "application/ld+json": { "schema": { "type": "object", "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/schema.sms.jsonld-sms_read" } }, "hydra:totalItems": { "$ref": "#/components/schemas/hydra.totalItems" }, "hydra:view": { "$ref": "#/components/schemas/hydra.view" }, "hydra:search": { "$ref": "#/components/schemas/hydra.search" } }, "required": [ "member" ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/schema.sms-sms_read" } } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Retrieves the collection of SMS", "description": "Getting the list of messages from the postbox, ordered by the field `created_at` in descending order. The postbox contains all sent, not sent and terminated SMS. You can also optionally sort according to the price or the time of transmit to the network operator. You also have the option of transferring different search criteria to limit the output of postbox's messages.", "parameters": [ { "$ref": "#/components/parameters/filter.common.page" }, { "$ref": "#/components/parameters/order.common.created_at" }, { "$ref": "#/components/parameters/order.messages.gateway_sent_at" }, { "$ref": "#/components/parameters/filter.messages.is_sent.boolean" }, { "$ref": "#/components/parameters/filter.messages.is_unicode.boolean" }, { "$ref": "#/components/parameters/filter.messages.uuid.exact" }, { "$ref": "#/components/parameters/filter.messages.uuid.array" }, { "$ref": "#/components/parameters/filter.messages.iso2.exact" }, { "$ref": "#/components/parameters/filter.messages.iso2.array" }, { "$ref": "#/components/parameters/filter.messages.dlr_code.exact" }, { "$ref": "#/components/parameters/filter.messages.dlr_code.array" }, { "$ref": "#/components/parameters/filter.messages.status_code.exact" }, { "$ref": "#/components/parameters/filter.messages.status_code.array" }, { "$ref": "#/components/parameters/filter.messages.gateway_sent_at.exact" }, { "$ref": "#/components/parameters/filter.messages.gateway_sent_at.array" }, { "$ref": "#/components/parameters/filter.messages.delivery_at.exact" }, { "$ref": "#/components/parameters/filter.messages.delivery_at.array" }, { "$ref": "#/components/parameters/filter.common.created_at.exact" }, { "$ref": "#/components/parameters/filter.common.created_at.array" }, { "$ref": "#/components/parameters/filter.messages.chars_count.exact" }, { "$ref": "#/components/parameters/filter.messages.chars_count.array" }, { "$ref": "#/components/parameters/filter.messages.parts_count.exact" }, { "$ref": "#/components/parameters/filter.messages.parts_count.array" }, { "$ref": "#/components/parameters/filter.messages.bulk.exact" }, { "$ref": "#/components/parameters/filter.messages.bulk.array" }, { "$ref": "#/components/parameters/filter.messages.source.exact" }, { "$ref": "#/components/parameters/filter.messages.source.array" }, { "$ref": "#/components/parameters/filter.messages.text.partial" }, { "$ref": "#/components/parameters/filter.messages.phone.partial" }, { "$ref": "#/components/parameters/filter.messages.sender_id.partial" }, { "$ref": "#/components/parameters/filter.messages.ip.partial" }, { "$ref": "#/components/parameters/filter.common.key_id.exact" }, { "$ref": "#/components/parameters/filter.common.key_id.array" }, { "$ref": "#/components/parameters/filter.messages.callback_data.exact" }, { "$ref": "#/components/parameters/filter.messages.callback_data.array" } ], "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X GET https://api.lox24.eu/sms \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string url = \"https://api.lox24.eu/sms\";\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\"; // or \"application/ld+json\"\n httpWebRequest.Method = \"GET\";\n //httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n Console.WriteLine(\"Success:{0} {1}\", respCode, \"bulks collection response\");\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"GET\"\n\tconst URL = \"https://api.lox24.eu/sms?created_at[gte]=1590737094\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println((string(body)))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.sms;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GetSmsCollection {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var url = \"https://api.lox24.eu/sms?created_at[gte]=1590737094\";\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\")\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .GET()\n .build();\n\n var client = HttpClient.newBuilder().build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"bulks collection response\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error:\" + httpResponse.statusCode());\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar query = \"uuid[]=44657141-9830-11ea-aa81-96000028b339&uuid[]=5dd2ba0e-9830-11ea-aa81-96000028b339&_order[created_at]=desc\";\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/sms?' + query,\n method: 'GET',\n headers: {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log('Success: code = 200 - sms resource response');\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n\n});\n\nreq.on('error', error => {\n console.error(error)\n});\n\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " 'Test',\n 'uuid' => [\n '8481900d-86ce-11ea-aa81-96000028b339',\n 'd5ceb189-86cd-11ea-aa81-96000028b339',\n ],\n 'page' => 1,\n '_order' => [\n 'created_at' => 'asc'\n ],\n];\n\n$uri .= $filters ? '?' . http_build_query($filters) : '';\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_URL => $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\nurl = 'https://api.lox24.eu/sms?created_at[gte]=1590737094'\n\n\nheaders = {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - sms collection response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n", "label": "Python" } ] }, "post": { "operationId": "api_sms_post_collection", "tags": [ "sms" ], "responses": { "201": { "description": "sms resource created", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.sms.jsonld-sms_read" }, "examples": { "example_sms_response_basic_sms": { "$ref": "#/components/examples/example_sms_response_basic_sms_jsonld" }, "example_sms_response_jsonld_translit": { "$ref": "#/components/examples/example_sms_response_translit_jsonld" }, "example_sms_response_jsonld_delete_text": { "$ref": "#/components/examples/example_sms_response_delete_text_jsonld" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.sms-sms_read" }, "examples": { "example_sms_response_basic_sms": { "$ref": "#/components/examples/example_sms_response_basic_sms" }, "example_sms_response_translit": { "$ref": "#/components/examples/example_sms_response_translit" }, "example_sms_response_delete_text": { "$ref": "#/components/examples/example_sms_response_delete_text" } } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "402": { "$ref": "#/components/responses/402-not-enough-funds" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "422": { "$ref": "#/components/responses/422-unprocessable-entity" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Send the SMS", "description": "Send short message data, such as text, destination number and sender identification by sending a POST request and we transfer the message to the destination network.", "parameters": [], "requestBody": { "description": "The new sms resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schema.sms-write" }, "examples": { "example_sms_request_minimal": { "$ref": "#/components/examples/example_sms_request_minimal" }, "example_sms_request_text2speech": { "$ref": "#/components/examples/example_sms_request_text2speech" }, "example_sms_request_text2speech_ssml": { "$ref": "#/components/examples/example_sms_request_text2speech_ssml" }, "example_sms_request_text2speech_single_call": { "$ref": "#/components/examples/example_sms_request_text2speech_single_call" }, "example_sms_request_unicode": { "$ref": "#/components/examples/example_sms_request_unicode" }, "example_sms_request_translit": { "$ref": "#/components/examples/example_sms_request_translit" }, "example_sms_request_delete_text": { "$ref": "#/components/examples/example_sms_request_delete_text" }, "example_sms_request_callback": { "$ref": "#/components/examples/example_sms_request_callback" } } } }, "required": true }, "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X POST https://api.lox24.eu/sms \\\n -H 'Content-Type: application/json' \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx' \\\n -d '{\n \"sender_id\": \"My Sender\",\n \"phone\": \"+49751234567\",\n \"source\": 111,\n \"service_code\": \"direct\",\n \"text\": \"Test message\",\n \"delivery_at\": 1573724611,\n \"is_unicode\": true,\n \"callback_data\": \"123456\",\n \"voice_lang\": \"DE\"\n}'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json;\nusing Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string url = \"https://api.lox24.eu/sms\";\n\n var data = new {\n sender_id = \"My Sender\",\n text = \"Test message\",\n service_code = \"direct\",\n phone = \"+49751234567\",\n delivery_at = 1573724611,\n is_unicode = true,\n callback_data = \"123456\",\n voice_lang = \"DE\"\n };\n\n string postdata = JsonConvert.SerializeObject(data);\n\n Console.WriteLine(\"Post data: {0}\", postdata);\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.ContentType = \"application/json; charset=utf-8\";\n httpWebRequest.Accept = \"application/json\"; // or application/ld+json\n httpWebRequest.Method = \"POST\";\n httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n using (var streamWriter = new StreamWriter(httpWebRequest.GetRequestStream()))\n {\n streamWriter.Write(postdata);\n streamWriter.Flush();\n streamWriter.Close();\n }\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n\n if(resp.StatusCode == HttpStatusCode.Created) {\n Console.WriteLine(\"Success:{0} {1}\", (int)resp.StatusCode, \"sms resource created\");\n } else {\n Console.WriteLine(\"Error: wrong response code {0} on create sms\", (int)resp.StatusCode);\n }\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.BadRequest: // 400\n Console.WriteLine(\"Error:400 Invalid input\");\n break;\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.PaymentRequired: // 402\n Console.WriteLine(\"Error:402 There are not enough funds on your account!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.NotFound: // 404\n Console.WriteLine(\"Error:404 Resource not found\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"bytes\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"POST\"\n\tconst URL = \"https://api.lox24.eu/sms\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tpayload := map[string]interface{}{\n\t\t\"sender_id\": \"My Sender\",\n\t\t\"phone\": \"+49751234567\",\n\t\t\"source\": 111,\n\t\t\"service_code\": \"direct\",\n\t\t\"text\": \"Test message\",\n\t\t\"delivery_at\": 1593724611,\n\t\t\"is_unicode\": true,\n\t\t\"callback_data\": \"123456\",\n\t\t\"voice_lang\": \"DE\",\n\t}\n\n\tjsonPayload, _ := json.Marshal(payload)\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, bytes.NewBuffer(jsonPayload))\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Content-Type\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 201:\n\t\tfmt.Println((string(body)))\n\tcase 400:\n\t\tfmt.Println(\"Error: code = 400 - Invalid input\")\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.sms;\n\nimport org.json.JSONObject;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class PostSmsCollection {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var url = \"https://api.lox24.eu/sms\";\n\n var json = new JSONObject();\n json.put(\"sender_id\", \"My Sender\");\n json.put(\"text\", \"Test message\");\n json.put(\"service_code\", \"direct\");\n json.put(\"phone\", \"+49751234567\");\n json.put(\"delivery_at\", 1573724611);\n json.put(\"is_unicode\", true);\n json.put(\"callback_data\", \"123456\");\n json.put(\"voice_lang\", \"DE\");\n\n var postData = json.toString();\n\n System.out.println(\"Post data: \" + postData);\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Content-Type\", \"application/json; charset=utf-8\")\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .POST(HttpRequest.BodyPublishers.ofString(postData))\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_CREATED) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"sms resource created\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error: wrong response code \" + httpResponse.statusCode() + \" on create sms\");\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_BAD_REQUEST: // 400\n System.out.println(\"Error:400 Invalid input\");\n break;\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_PAYMENT_REQUIRED: // 402\n System.out.println(\"Error:402 There are not enough funds on your account!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "/*\n * Post sms\n */\nconst token = \"7b7c6063bab885ce79814b5ff1ee6885\";\n\nvar postObj = {\n sender_id: 'My Sender',\n text: 'Test message',\n service_code: 'direct',\n phone: '+49751234567',\n delivery_at: 1573724611,\n is_unicode: true,\n callback_data: \"123456\",\n voice_lang: \"DE\"\n};\n\nvar postdata = JSON.stringify(postObj);\n\nconst https = require('https');\nconst options = {\n hostname: 'api.lox24.eu',\n path: '/sms',\n method: 'POST',\n headers: {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'Content-Length': postdata.length,\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 201) {\n console.log(\"Success: code = 201 - sms resource created\");\n res.on('data', d => { process.stdout.write(d) })\n }\n else if (res.statusCode == 400) console.log(\"Error: code = 400 - Invalid input\");\n else if (res.statusCode == 401) console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n else if (res.statusCode == 402) console.log(\"Error: code = 402 - There are not enough funds on your account!\");\n else if (res.statusCode == 403) console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n})\n\nreq.on('error', error => {\n console.error(error)\n})\nreq.write(postdata);\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " 'My Sender',\n 'text' => \"First line\\nSecond line\",\n 'service_code' => 'direct',\n 'phone' => '+49751234567',\n 'delivery_at' => 1573724611,\n 'is_unicode' => true,\n 'callback_data' => '123456',\n 'voice_lang' => 'DE',\n];\n\nif(!$body = json_encode($body)) {\n die('JSON encoding error!');\n}\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_POST => true,\n CURLOPT_URL => $uri,\n CURLOPT_POSTFIELDS => $body,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n 'Content-Type: application/json',\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(201 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\nurl = 'https://api.lox24.eu/sms'\n\n\ndata = {\n 'sender_id': \"My Sender\",\n 'text' : \"Test message\",\n 'service_code' : \"direct\",\n 'phone': \"+49751234567\",\n 'delivery_at': 1573724611,\n 'is_unicode': True,\n 'callback_data' => '123456',\n 'voice_lang' => 'DE'\n}\n\nheaders = {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\nprint(\"Post data : \", json.dumps(data, indent=4))\n\ntry:\n # timeout is 100 seconds, the payload is automatically converted to json format\n res = requests.post(url, headers=headers, json=data, timeout=100)\n if res.status_code != 201: # Created\n print(\"Error: Wrong response code on create sms\")\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - sms resource created')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 400:\n print(\"Error:400 Invalid input\")\n elif res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 402:\n print(\"Error:402 There are not enough funds on your account!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 404:\n print(\"Error:404 Resource not found\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n\n", "label": "Python" } ] } }, "/sms/dryrun": { "post": { "operationId": "api_sms_post_dryrun_collection", "tags": [ "sms" ], "responses": { "201": { "description": "sms resource created", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.sms.jsonld-sms_read" }, "examples": { "example_sms_response_basic_sms": { "$ref": "#/components/examples/example_sms_response_basic_sms_jsonld" }, "example_sms_response_jsonld_translit": { "$ref": "#/components/examples/example_sms_response_translit_jsonld" }, "example_sms_response_jsonld_delete_text": { "$ref": "#/components/examples/example_sms_response_delete_text_jsonld" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.sms-sms_read" }, "examples": { "example_sms_response_basic_sms": { "$ref": "#/components/examples/example_sms_response_basic_sms" }, "example_sms_response_dryrun_translit": { "$ref": "#/components/examples/example_sms_response_translit" }, "example_sms_response_dryrun_delete_text": { "$ref": "#/components/examples/example_sms_response_delete_text" } } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "422": { "$ref": "#/components/responses/422-unprocessable-entity" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Simulate sending an SMS (for testing)", "description": "This endpoint doesn't send any SMS but emulates the proccess and response. This can be used to get the SMS price or test the API during the integration process. The property `uuid` will be always equal to `11111111-2222-3333-4444-55555555555`. No data will be saved at LOX24, therefore you can't extract any SMS info by `GET /sms/{id}`. [DLR report](/info/sms-delivery-report-codes-dlr/) are send back in same way as per real SMS, if DLR url/email was set-up before, but with statuscode 0.", "parameters": [], "requestBody": { "description": "The new sms resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schema.sms-write" }, "examples": { "example_sms_dryrun_request_minimal": { "$ref": "#/components/examples/example_sms_request_minimal" }, "example_sms_dryrun_request_text2speech": { "$ref": "#/components/examples/example_sms_request_text2speech" }, "example_sms_dryrun_request_text2speech_ssml": { "$ref": "#/components/examples/example_sms_request_text2speech_ssml" }, "example_sms_dryrun_request_unicode": { "$ref": "#/components/examples/example_sms_request_unicode" }, "example_sms_dryrun_request_translit": { "$ref": "#/components/examples/example_sms_request_translit" }, "example_sms_dryrun_request_delete_text": { "$ref": "#/components/examples/example_sms_request_delete_text" }, "example_sms_dryrun_request_callback": { "$ref": "#/components/examples/example_sms_request_callback" } } } }, "required": true }, "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X POST https://api.lox24.eu/sms/dryrun \\\n -H 'Content-Type: application/json' \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx' \\\n -d '{\n \"sender_id\": \"My Sender\",\n \"phone\": \"+49751234567\",\n \"source\": 111,\n \"service_code\": \"direct\",\n \"text\": \"Test message\",\n \"delivery_at\": 1573724611,\n \"is_unicode\": true,\n \"callback_data\": \"123456\",\n \"voice_lang\": \"DE\"\n}'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json;\nusing Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string url = \"https://api.lox24.eu/sms/dryrun\";\n\n var data = new {\n sender_id = \"My Sender\",\n text = \"Test message\",\n service_code = \"direct\",\n phone = \"+49751234567\",\n delivery_at = 1573724611,\n is_unicode = true,\n voice_lang = \"DE\"\n };\n\n string postdata = JsonConvert.SerializeObject(data);\n\n Console.WriteLine(\"Post data: {0}\", postdata);\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.ContentType = \"application/json; charset=utf-8\";\n httpWebRequest.Accept = \"application/json\"; // or application/ld+json\n httpWebRequest.Method = \"POST\";\n httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n using (var streamWriter = new StreamWriter(httpWebRequest.GetRequestStream()))\n {\n streamWriter.Write(postdata);\n streamWriter.Flush();\n streamWriter.Close();\n }\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n if(resp.StatusCode == HttpStatusCode.Created) {\n Console.WriteLine(\"Success:{0} {1}\", (int)resp.StatusCode, \"sms resource created in dryrun mode\");\n } else {\n Console.WriteLine(\"Error: wrong response code {0} on create sms\", (int)resp.StatusCode);\n }\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.BadRequest: // 400\n Console.WriteLine(\"Error:400 Invalid input\");\n break;\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"bytes\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"POST\"\n\tconst URL = \"https://api.lox24.eu/sms/dryrun\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tpayload := map[string]interface{}{\n\t\t\"sender_id\": \"My Sender\",\n\t\t\"phone\": \"+49751234567\",\n\t\t\"source\": 111,\n\t\t\"service_code\": \"direct\",\n\t\t\"text\": \"Test message\",\n\t\t\"delivery_at\": 1593724611,\n\t\t\"is_unicode\": true,\n\t\t\"voice_lang\": \"DE\",\n\t}\n\n\tjsonPayload, _ := json.Marshal(payload)\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, bytes.NewBuffer(jsonPayload))\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Content-Type\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 201:\n\t\tfmt.Println((string(body)))\n\tcase 400:\n\t\tfmt.Println(\"Error: code = 400 - Invalid input\")\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.sms;\n\nimport org.json.JSONObject;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class PostSmsCollection {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var url = \"https://api.lox24.eu/sms/dryrun\";\n\n var json = new JSONObject();\n json.put(\"sender_id\", \"My Sender\");\n json.put(\"text\", \"Test message\");\n json.put(\"service_code\", \"direct\");\n json.put(\"phone\", \"+49751234567\");\n json.put(\"delivery_at\", 1573724611);\n json.put(\"is_unicode\", true);\n json.put(\"voice_lang\", \"DE\");\n\n var postData = json.toString();\n\n System.out.println(\"Post data: \" + postData);\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Content-Type\", \"application/json; charset=utf-8\")\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .POST(HttpRequest.BodyPublishers.ofString(postData))\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_CREATED) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"sms resource created\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error: wrong response code \" + httpResponse.statusCode() + \" on create sms\");\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_BAD_REQUEST: // 400\n System.out.println(\"Error:400 Invalid input\");\n break;\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar postObj = {\n sender_id: 'My Sender',\n text: 'Test message',\n service_code: 'direct',\n phone: '+49751234567',\n delivery_at: 1573724611,\n is_unicode: true,\n voice_lang: \"DE\"\n};\n\nvar postdata = JSON.stringify(postObj);\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/sms/dryrun',\n method: 'POST',\n headers: {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'Content-Length': postdata.length,\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 201) {\n console.log(\"Success: code = 201 - sms resource created\");\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 400) {\n console.log(\"Error: code = 400 - Invalid input\");\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 402) {\n console.log(\"Error: code = 402 - There are not enough funds on your account!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n})\n\nreq.on('error', error => {\n console.error(error)\n})\nreq.write(postdata);\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " 'My Sender',\n 'text' => \"First line\\nSecond line\",\n 'service_code' => 'direct',\n 'phone' => '+49751234567',\n 'delivery_at' => 1573724611,\n 'is_unicode' => true,\n 'voice_lang' => 'DE',\n];\n\n;\nif(!$body = json_encode($body)) {\n die('JSON encoding error!');\n}\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_POST => true,\n CURLOPT_URL => $uri,\n CURLOPT_POSTFIELDS => $body,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n 'Content-Type: application/json',\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(201 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\nurl = 'https://api.lox24.eu/sms/dryrun'\n\n\ndata = {\n 'sender_id': \"My Sender\",\n 'text' : \"Test message\",\n 'service_code' : \"direct\",\n 'phone': \"+49751234567\",\n 'delivery_at': 1573724611,\n 'is_unicode': True,\n 'callback_data' => '123456',\n 'voice_lang' => 'DE'\n}\n\nheaders = {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\nprint(\"Post data : \", json.dumps(data, indent=4))\n\ntry:\n # timeout is 100 seconds, the payload is automatically converted to json format\n res = requests.post(url, headers=headers, json=data, timeout=100)\n if res.status_code != 201: # Created\n print(\"Error: Wrong response code on create sms\")\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - sms resource created')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 400:\n print(\"Error:400 Invalid input\")\n elif res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 402:\n print(\"Error:402 There are not enough funds on your account!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 404:\n print(\"Error:404 Resource not found\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n\n", "label": "Python" } ] } }, "/sms/ops/batch_cancel": { "post": { "operationId": "sms_ops_cancel", "tags": [ "sms" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schema.sms-batch-cancel-response" } } }, "description": "Count of the canceled SMS" }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "422": { "$ref": "#/components/responses/422-unprocessable-entity" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Stopping postponed and not yet sent SMS messages", "description": "With this API you can delete SMS messages that have not yet been sent or interrupt the sending process. For scheduled SMS messages, the transmission time must be in the future. If the SMS is not scheduled, the transmission to the mobile phone provider may take a few seconds, which will possibly allow you to stop the transmission in exceptional cases.", "parameters": [ { "$ref": "#/components/parameters/order.common.created_at" }, { "$ref": "#/components/parameters/order.messages.gateway_sent_at" }, { "$ref": "#/components/parameters/filter.messages.is_sent.boolean" }, { "$ref": "#/components/parameters/filter.messages.is_unicode.boolean" }, { "$ref": "#/components/parameters/filter.messages.uuid.exact" }, { "$ref": "#/components/parameters/filter.messages.uuid.array" }, { "$ref": "#/components/parameters/filter.messages.iso2.exact" }, { "$ref": "#/components/parameters/filter.messages.iso2.array" }, { "$ref": "#/components/parameters/filter.messages.dlr_code.exact" }, { "$ref": "#/components/parameters/filter.messages.dlr_code.array" }, { "$ref": "#/components/parameters/filter.messages.status_code.exact" }, { "$ref": "#/components/parameters/filter.messages.status_code.array" }, { "$ref": "#/components/parameters/filter.messages.gateway_sent_at.exact" }, { "$ref": "#/components/parameters/filter.messages.gateway_sent_at.array" }, { "$ref": "#/components/parameters/filter.messages.delivery_at.exact" }, { "$ref": "#/components/parameters/filter.messages.delivery_at.array" }, { "$ref": "#/components/parameters/filter.common.created_at.exact" }, { "$ref": "#/components/parameters/filter.common.created_at.array" }, { "$ref": "#/components/parameters/filter.messages.chars_count.exact" }, { "$ref": "#/components/parameters/filter.messages.chars_count.array" }, { "$ref": "#/components/parameters/filter.messages.parts_count.exact" }, { "$ref": "#/components/parameters/filter.messages.parts_count.array" }, { "$ref": "#/components/parameters/filter.messages.bulk.exact" }, { "$ref": "#/components/parameters/filter.messages.bulk.array" }, { "$ref": "#/components/parameters/filter.messages.source.exact" }, { "$ref": "#/components/parameters/filter.messages.source.array" }, { "$ref": "#/components/parameters/filter.messages.text.partial" }, { "$ref": "#/components/parameters/filter.messages.phone.partial" }, { "$ref": "#/components/parameters/filter.messages.sender_id.partial" }, { "$ref": "#/components/parameters/filter.messages.ip.partial" }, { "$ref": "#/components/parameters/filter.common.key_id.exact" }, { "$ref": "#/components/parameters/filter.common.key_id.array" }, { "$ref": "#/components/parameters/filter.messages.callback_data.exact" }, { "$ref": "#/components/parameters/filter.messages.callback_data.array" } ], "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "curl -X POST https://api.lox24.eu/sms/ops/batch_cancel?uuid=20f39273-0566-11ea-a637-96000028b339 \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string text = \"Test\";\n\n var query = \"text=\" + text + \"&uuid[]=ab6b6ceb-903a-11ea-aa81-96000028b339&uuid[]=7c7a6661-902e-11ea-aa81-96000028b339\";\n string url = \"https://api.lox24.eu/sms/ops/batch_cancel?\" + query;\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\";\n httpWebRequest.Method = \"POST\";\n //httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n if(resp.StatusCode == HttpStatusCode.OK) {\n Console.WriteLine(\"Success: SMS was canceled!\");\n } else {\n Console.WriteLine(\"Error: SMS wasn't canceled canceled!\");\n }\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n\n }\n catch (WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"POST\"\n\tconst URL = \"https://api.lox24.eu/sms/ops/batch_cancel?uuid=20f39273-0566-11ea-a637-96000028b339\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println((string(body)))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.sms;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class SmsOpsCancelSmsCollection {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\n var text = \"\";\n var query = \"text=\" + text + \"&uuid[]=ab6b6ceb-903a-11ea-aa81-96000028b339&uuid[]=7c7a6661-902e-11ea-aa81-96000028b339\";\n var url = \"https://api.lox24.eu/sms/ops/batch_cancel?\" + query;\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .POST(HttpRequest.BodyPublishers.ofString(\"\"))\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"Success: SMS was canceled!\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n } else {\n System.out.println(\"Error: SMS wasn't canceled!\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n\n System.out.println(\"Error: \" + httpResponse.statusCode());\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_NOT_FOUND: // 404\n System.out.println(\"Error:404 Resource not found\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar query = \"uuid[]=44657141-9830-11ea-aa81-96000028b339&uuid[]=5dd2ba0e-9830-11ea-aa81-96000028b339&_order[created_at]=desc\";\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/sms/ops/batch_cancel?' + query,\n method: 'POST',\n headers: {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log(\"Success: code = 200 - Count of the canceled SMS\");\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n})\n\nreq.on('error', error => {\n console.error(error)\n})\n\nreq.end();\n\n", "label": "JavaScript" }, { "lang": "php", "source": " 'Test',\n 'uuid' => [\n '8481900d-86ce-11ea-aa81-96000028b339',\n 'd5ceb189-86cd-11ea-aa81-96000028b339',\n ],\n];\n\n$uri .= $filters ? '?' . http_build_query($filters) : '';\n$curl = curl_init();\n\necho $uri;\n\ncurl_setopt_array($curl, [\n CURLOPT_POST => true,\n CURLOPT_URL => $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(201 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\ntext = \"Test\"\n\nquery = f\"text={text}&uuid[]=ab6b6ceb-903a-11ea-aa81-96000028b339&uuid[]=7c7a6661-902e-11ea-aa81-96000028b339\"\n\nurl = f\"https://api.lox24.eu/sms/ops/batch_cancel?{query}\"\n\n\nheaders = {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds, the payload is automatically converted to json format\n res = requests.post(url, headers=headers, timeout=100)\n if res.status_code != 200: # Ok\n print(\"Error: SMS wasn't canceled\")\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - SMS was canceled')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n\n", "label": "Python" } ] } }, "/sms/ops/batch_delete": { "post": { "operationId": "sms_ops_delete", "tags": [ "sms" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schema.sms-batch-delete-response" } } }, "description": "Count of the deleted SMS" }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "422": { "$ref": "#/components/responses/422-unprocessable-entity" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Bulk delete SMS messages", "description": "With this API you can delete SMS any messages ", "parameters": [ { "$ref": "#/components/parameters/order.common.created_at" }, { "$ref": "#/components/parameters/order.messages.gateway_sent_at" }, { "$ref": "#/components/parameters/filter.messages.is_sent.boolean" }, { "$ref": "#/components/parameters/filter.messages.is_unicode.boolean" }, { "$ref": "#/components/parameters/filter.messages.uuid.exact" }, { "$ref": "#/components/parameters/filter.messages.uuid.array" }, { "$ref": "#/components/parameters/filter.messages.iso2.exact" }, { "$ref": "#/components/parameters/filter.messages.iso2.array" }, { "$ref": "#/components/parameters/filter.messages.dlr_code.exact" }, { "$ref": "#/components/parameters/filter.messages.dlr_code.array" }, { "$ref": "#/components/parameters/filter.messages.status_code.exact" }, { "$ref": "#/components/parameters/filter.messages.status_code.array" }, { "$ref": "#/components/parameters/filter.messages.gateway_sent_at.exact" }, { "$ref": "#/components/parameters/filter.messages.gateway_sent_at.array" }, { "$ref": "#/components/parameters/filter.messages.delivery_at.exact" }, { "$ref": "#/components/parameters/filter.messages.delivery_at.array" }, { "$ref": "#/components/parameters/filter.common.created_at.exact" }, { "$ref": "#/components/parameters/filter.common.created_at.array" }, { "$ref": "#/components/parameters/filter.messages.chars_count.exact" }, { "$ref": "#/components/parameters/filter.messages.chars_count.array" }, { "$ref": "#/components/parameters/filter.messages.parts_count.exact" }, { "$ref": "#/components/parameters/filter.messages.parts_count.array" }, { "$ref": "#/components/parameters/filter.messages.bulk.exact" }, { "$ref": "#/components/parameters/filter.messages.bulk.array" }, { "$ref": "#/components/parameters/filter.messages.source.exact" }, { "$ref": "#/components/parameters/filter.messages.source.array" }, { "$ref": "#/components/parameters/filter.messages.text.partial" }, { "$ref": "#/components/parameters/filter.messages.phone.partial" }, { "$ref": "#/components/parameters/filter.messages.sender_id.partial" }, { "$ref": "#/components/parameters/filter.messages.ip.partial" }, { "$ref": "#/components/parameters/filter.common.key_id.exact" }, { "$ref": "#/components/parameters/filter.common.key_id.array" }, { "$ref": "#/components/parameters/filter.messages.callback_data.exact" }, { "$ref": "#/components/parameters/filter.messages.callback_data.array" } ], "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X POST https://api.lox24.eu/sms/ops/batch_delete?uuid=20f39273-0566-11ea-a637-96000028b339 \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string text = \"Test\";\n\n var query = \"text=\" + text + \"&uuid[]=ab6b6ceb-903a-11ea-aa81-96000028b339&uuid[]=7c7a6661-902e-11ea-aa81-96000028b339\";\n string url = \"https://api.lox24.eu/sms/ops/batch_delete?\" + query;\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\";\n httpWebRequest.Method = \"POST\";\n //httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n if(resp.StatusCode == HttpStatusCode.OK) {\n Console.WriteLine(\"Success: SMS was deleted!\");\n } else {\n Console.WriteLine(\"Error: SMS wasn't deleted!\");\n }\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n\n }\n catch (WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"POST\"\n\tconst URL = \"https://api.lox24.eu/sms/ops/batch_delete?uuid=20f39273-0566-11ea-a637-96000028b339\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println((string(body)))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.sms;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class SmsOpsCancelSmsCollection {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\n var text = \"\";\n var query = \"text=\" + text + \"&uuid[]=ab6b6ceb-903a-11ea-aa81-96000028b339&uuid[]=7c7a6661-902e-11ea-aa81-96000028b339\";\n var url = \"https://api.lox24.eu/sms/ops/batch_delete?\" + query;\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .POST(HttpRequest.BodyPublishers.ofString(\"\"))\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"Success: SMS was canceled!\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n } else {\n System.out.println(\"Error: SMS wasn't canceled!\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n\n System.out.println(\"Error: \" + httpResponse.statusCode());\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_NOT_FOUND: // 404\n System.out.println(\"Error:404 Resource not found\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar query = \"uuid[]=44657141-9830-11ea-aa81-96000028b339&uuid[]=5dd2ba0e-9830-11ea-aa81-96000028b339&_order[created_at]=desc\";\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/sms/ops/batch_delete?' + query,\n method: 'POST',\n headers: {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log(\"Success: code = 200 - Count of the deleted SMS\");\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n})\n\nreq.on('error', error => {\n console.error(error)\n})\n\nreq.end();\n\n", "label": "JavaScript" }, { "lang": "php", "source": " 'Test',\n 'uuid' => [\n '8481900d-86ce-11ea-aa81-96000028b339',\n 'd5ceb189-86cd-11ea-aa81-96000028b339',\n ],\n];\n\n$uri .= $filters ? '?' . http_build_query($filters) : '';\n$curl = curl_init();\n\necho $uri;\n\ncurl_setopt_array($curl, [\n CURLOPT_POST => true,\n CURLOPT_URL => $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'SMS canceled, info = ' . var_export($data, true);\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\ntext = \"Test\"\n\nquery = f\"text={text}&uuid[]=ab6b6ceb-903a-11ea-aa81-96000028b339&uuid[]=7c7a6661-902e-11ea-aa81-96000028b339\"\n\nurl = f\"https://api.lox24.eu/sms/ops/batch_delete?{query}\"\n\n\nheaders = {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\n\n\ntry:\n # timeout is 100 seconds, the payload is automatically converted to json format\n res = requests.post(url, headers=headers, timeout=100)\n if res.status_code != 200: # Ok\n print(\"Error: SMS wasn't canceled\")\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - SMS was canceled')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n\n", "label": "Python" } ] } }, "/sms/{uuid}": { "get": { "operationId": "api_sms_get_item", "deprecated": false, "tags": [ "sms" ], "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X GET https://api.lox24.eu/sms/20f39273-0566-11ea-a637-96000028b339 \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var id = \"343c785b-8567-11ea-aa81-96000028b339\";\n\n string url = \"https://api.lox24.eu/sms/\" + id;\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\"; //or application/ld+json\n httpWebRequest.Method = \"GET\";\n httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n Console.WriteLine(\"Success:{0} {1}\", respCode, \"sms resource response\");\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.NotFound: // 404\n Console.WriteLine(\"Error:404 Resource not found\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"GET\"\n\tconst URL = \"https://api.lox24.eu/sms/981f6497-a03e-11ea-b2e9-b8ca3a65338c\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println((string(body)))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tcase 404:\n\t\tfmt.Println(\"Error: code = 404 - Resource not found\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.sms;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GetBulksItem {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var id = \"343c785b-8567-11ea-aa81-96000028b339\";\n\n var url = \"https://api.lox24.eu/sms/\" + id;\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .GET()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode());\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error: wrong response code \" + httpResponse.statusCode());\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_NOT_FOUND: // 404\n System.out.println(\"Error:404 Resource not found\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar id = '5dd2ba0e-9830-11ea-aa81-96000028b339';\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/sms/' + id,\n method: 'GET',\n headers: {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log('Success: code = 200');\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else if (res.statusCode == 404) {\n console.log(\"Error: code = 404 - Resource not found\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n\n})\n\nreq.on('error', error => {\n console.error(error)\n})\n\nreq.end();\n\n", "label": "JavaScript" }, { "lang": "php", "source": " $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} elseif(404 === $code) {\n echo \"SMS with id = {$id} not found!\";\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\nsms_id = \"343c785b-8567-11ea-aa81-96000028b339\"\n\nurl = f'https://api.lox24.eu/sms/{sms_id}'\n\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - sms resource response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 404:\n print(\"Error:404 Resource not found\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n\n", "label": "Python" } ], "responses": { "200": { "description": "sms resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.sms.jsonld-sms_read" } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.sms-sms_read" } } } }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Retrieves the entry of SMS", "description": "Getting the single SMS entity by the ID (`uuid`). If SMS not found then HTTP code 404 will response.", "parameters": [ { "$ref": "#/components/parameters/path.sms.uuid" } ] }, "delete": { "operationId": "api_sms_delete_item", "deprecated": false, "tags": [ "sms" ], "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X DELETE https://api.lox24.eu/sms/20f39273-0566-11ea-a637-96000028b339 \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\n var id = \"851b600d-901e-11ea-aa81-96000028b339\";\n string url = \"https://api.lox24.eu/sms/\" + id;\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\";\n httpWebRequest.Method = \"DELETE\";\n //httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n if(resp.StatusCode == HttpStatusCode.NoContent) { //204\n Console.WriteLine(\"Success: sms was deleted\");\n } else {\n Console.WriteLine(\"Error: something went wrong, code({0})\", respCode);\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n\n JObject parsed = JObject.Parse(responseText);\n\n foreach (var pair in parsed)\n {\n Console.WriteLine(\"{0}: {1}\", pair.Key, pair.Value);\n }\n }\n }\n\n }\n\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.NotFound: // 404\n Console.WriteLine(\"Error:404 Resource not found\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"DELETE\"\n\tconst URL = \"https://api.lox24.eu/sms/981f6497-a03e-11ea-b2e9-b8ca3a65338c\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tswitch res.StatusCode {\n\tcase 204:\n\t\tfmt.Println(\"Sms was deleted!\")\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tcase 404:\n\t\tfmt.Println(\"Error: code = 404 - Resource not found\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.sms;\n\nimport org.json.JSONObject;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class DeleteSmsItem {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\n var id = \"851b600d-901e-11ea-aa81-96000028b339\";\n var url = \"https://api.lox24.eu/sms/\" + id;\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .DELETE()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_NO_CONTENT) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"sms was delete.\");\n } else {\n System.out.println(\"Error: something went wrong, code(\" + httpResponse.statusCode() + \")\");\n\n JSONObject parsed = new JSONObject(httpResponse.body());\n\n parsed.keys().forEachRemaining(jsonKey -> System.out.println(jsonKey + \":\" + parsed.get(jsonKey)));\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_NOT_FOUND: // 404\n System.out.println(\"Error:404 Resource not found\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar id = '20f39273-0566-11ea-a637-96000028b339';\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/sms/' + id,\n method: 'DELETE',\n headers: {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 204) {\n console.log('Success: code = 204 - sms resource deleted');\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else if (res.statusCode == 404) {\n console.log(\"Error: code = 404 - Resource not found\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n});\n\nreq.on('error', error => {\n console.error(error)\n});\n\nreq.end();\n\n", "label": "JavaScript" }, { "lang": "php", "source": " $uri,\n CURLOPT_CUSTOMREQUEST => 'DELETE',\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\nif(204 === $code) {\n echo \"SMS with id = {$id} was deleted!\";\n} elseif(404 === $code) {\n echo \"SMS with id = {$id} not found!\";\n} else {\n $data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n echo \"SMS: code = {$code}, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\nsms_id = \"343c785b-8567-11ea-aa81-96000028b339\"\n\nurl = f'https://api.lox24.eu/sms/{sms_id}'\n\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.delete(url, headers=headers, timeout=100)\n if res.status_code != 204: # No Content\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - sms was deleted')\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 404:\n print(\"Error:404 Resource not found\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n\n", "label": "Python" } ], "responses": { "204": { "$ref": "#/components/responses/204-deleted" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Delete a SMS", "description": "Remove the SMS entity by the ID (`uuid`). Endpoint response doesn't contains the body and has HTTP code 204 if SMS was removed or 404 if it doesn't exists. Attention. The SMS is also deleted from the itemised bill. Later complaints are therefore excluded due to lack of traceability.", "parameters": [ { "name": "uuid", "in": "path", "required": true, "deprecated": false, "schema": { "type": "string" }, "description": "SMS ID (`uuid`)" } ] } }, "/sms/clicks": { "get": { "operationId": "api_sms_clicks_get_collection", "tags": [ "click-rate" ], "responses": { "200": { "description": "sms_clicks collection", "content": { "application/ld+json": { "schema": { "type": "object", "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/schema.sms_clicks.jsonld-short_link_msg_read" } }, "hydra:totalItems": { "type": "integer", "minimum": 0 }, "hydra:view": { "$ref": "#/components/schemas/hydra.view" }, "hydra:search": { "$ref": "#/components/schemas/hydra.search" } }, "required": [ "member" ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/schema.sms_clicks-short_link_msg_read" } } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "List of all SMS with clicks", "description": "Retrieves the list of sms which contain a short link and the number of clicks on these links.", "parameters": [ { "$ref": "#/components/parameters/filter.common.page" }, { "name": "_order[created_at]", "in": "query", "description": "Sort a list by 'created_at' property", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "asc", "enum": [ "asc", "desc" ] }, "style": "form", "explode": false, "allowReserved": false }, { "name": "requests_count", "in": "query", "description": "*Exact* filter by the requests count value", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "integer" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "requests_count[]", "in": "query", "description": "*Exact* and *range* filter by the requests count value", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "type": "integer" } }, "style": "form", "explode": true, "allowReserved": false }, { "name": "created_at", "in": "query", "description": "*Exact* filter by SMS creating date", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "integer" }, "style": "form", "explode": false, "allowReserved": false }, { "name": "created_at[]", "in": "query", "description": "*Exact* and *range* filter by SMS creating date", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "type": "integer" } }, "style": "form", "explode": true, "allowReserved": false } ], "deprecated": false, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X GET https://api.lox24.eu/sms/clicks \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string url = \"https://api.lox24.eu/sms/clicks?page=1\";\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\"; // or \"application/ld+json\"\n httpWebRequest.Method = \"GET\";\n //httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n Console.WriteLine(\"Success:{0} {1}\", respCode, \"collection response\");\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"GET\"\n\tconst URL = \"https://api.lox24.eu/sms/clicks?page=1\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println((string(body)))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.sms_clicks;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GetCollection {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var url = \"https://api.lox24.eu/sms/clicks?page=1\";\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .GET()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" collection response\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n } else {\n System.out.println(\"Error: something went wrong, code(\" + httpResponse.statusCode() + \")\");\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar query = \"page=1\";\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/sms/clicks?' + query,\n method: 'GET',\n headers: {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log('Success: code = 200 - list response');\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n\n});\n\nreq.on('error', error => {\n console.error(error)\n});\n\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " 1,\n];\n\n$uri .= $filters ? '?' . http_build_query($filters) : '';\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_URL => $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: $token\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = $code, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\nurl = \"https://api.lox24.eu/sms/clicks?page=1\"\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - items collection response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n", "label": "Python" } ] } }, "/sms/{uuid}/clicks": { "get": { "operationId": "api_sms_clicks_per_message_get_collection", "deprecated": false, "responses": { "200": { "description": "sms_clicks resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.sms_clicks.jsonld-short_link_msg_read" } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.sms_clicks-short_link_msg_read" } } } }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Short-Link clicks of a SMS", "description": "Returns the number of clicks on a short link for a specific SMS. If SMS doesn't exists or doesn't contain then HTTP code 404 will response.", "parameters": [ { "$ref": "#/components/parameters/path.sms.uuid" } ], "tags": [ "click-rate" ], "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl https://api.lox24.eu/sms/clicks/sms_uuid_here \\\n -H 'Content-Type: application/json' \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var id = \"sms_uuid_here\";\n\n string url = \"https://api.lox24.eu/sms/clicks/\" + id;\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\"; //or application/ld+json\n httpWebRequest.Method = \"GET\";\n httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n Console.WriteLine(\"Success:{0} {1}\", respCode, \"item resource response\");\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.NotFound: // 404\n Console.WriteLine(\"Error:404 Resource not found\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"GET\"\n\tconst URL = \"https://api.lox24.eu/sms/clicks/sms_uuid_here\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println((string(body)))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tcase 404:\n\t\tfmt.Println(\"Error: code = 404 - Resource not found\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.sms_clicks;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GetItem {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var userId = \"1234567\";\n var id = \"sms_uuid_here\";\n\n var url = \"https://api.lox24.eu/sms/clicks/\" + id;\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .GET()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode());\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error: wrong response code \" + httpResponse.statusCode());\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_NOT_FOUND: // 404\n System.out.println(\"Error:404 Resource not found\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar id = 'sms_uuid_here';\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/sms/clicks/' + id,\n method: 'GET',\n headers: {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log('Success: code = 200');\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else if (res.statusCode == 404) {\n console.log(\"Error: code = 404 - Resource not found\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n\n})\n\nreq.on('error', error => {\n console.error(error)\n})\n\nreq.end();\n\n", "label": "JavaScript" }, { "lang": "php", "source": " $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: $token\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} elseif(404 === $code) {\n echo \"Item with id = $id not found!\";\n} else {\n echo \"Error: code = $code, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\nid = \"msg_uuid\"\n\nurl = f'https://api.lox24.eu/sms/clicks/{id}'\n\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - resource response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 404:\n print(\"Error:404 Resource not found\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n\n\n", "label": "Python" } ] } }, "/short_link_campaigns/{code}/short_links": { "get": { "operationId": "api_short_link_campaigns_short_links_get_item", "responses": { "200": { "description": "short_links collection", "content": { "application/ld+json": { "schema": { "type": "object", "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/schema.short_links.jsonld-short_link_read" } }, "hydra:totalItems": { "type": "integer", "minimum": 0 }, "hydra:view": { "$ref": "#/components/schemas/hydra.view" }, "hydra:search": { "$ref": "#/components/schemas/hydra.search" } }, "required": [ "member" ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/schema.short_links-short_link_read" } } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "List of all individual short links of a campaign", "description": "List of all short links which were used in a specific campaign.", "parameters": [ { "$ref": "#/components/parameters/path.short_link_campaigns.code" } ], "tags": [ "links" ], "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X GET https://api.lox24.eu/short_link_campaigns/{id}/short_links \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string campaign = \"campaign_code\";\n string url = \"https://api.lox24.eu/short_link_campaigns/\" + campaign + \"/short_links?page=1\";\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\"; // or \"application/ld+json\"\n httpWebRequest.Method = \"GET\";\n //httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n Console.WriteLine(\"Success:{0} {1}\", respCode, \"collection response\");\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"GET\"\n\tconst URL = \"https://api.lox24.eu/short_link_campaigns/campaign_code/short_links?page=1\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println((string(body)))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.sms_clicks;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GetCollection {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var campaign = 'campaign_id'\n var url = \"https://api.lox24.eu/short_link_campaigns/\" + campaign + \"/short_links?page=1\";\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .GET()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" collection response\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n } else {\n System.out.println(\"Error: something went wrong, code(\" + httpResponse.statusCode() + \")\");\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nconst query = \"page=1\";\nconst campaign_id = 'campaign_id';\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/short_link_campaigns/' + campaign_id + '/short_links?' + query,\n method: 'GET',\n headers: {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log('Success: code = 200 - list response');\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n\n});\n\nreq.on('error', error => {\n console.error(error)\n});\n\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " 1,\n];\n\n$uri .= $filters ? '?' . http_build_query($filters) : '';\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_URL => $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: $token\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = $code, data = \" . var_export($data, true);\n}\n\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\ncampaign = \"short_link_id\"\nurl = \"https://api.lox24.eu/short_link_campaigns/\" + campaign + \"/short_links?page=1\"\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - items collection response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n", "label": "Python" } ] } }, "/blocked_numbers": { "get": { "operationId": "api_blocked_numbers_get_collection", "tags": [ "blocked-numbers" ], "parameters": [ { "$ref": "#/components/parameters/filter.blocked_numbers.number.exact" }, { "$ref": "#/components/parameters/filter.blocked_numbers.type.exact" } ], "responses": { "200": { "description": "blocked_numbers collection", "content": { "application/ld+json": { "schema": { "type": "object", "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/schema.blocked_numbers.jsonld-blocked_number_read" } }, "hydra:totalItems": { "$ref": "#/components/schemas/hydra.totalItems" }, "hydra:view": { "$ref": "#/components/schemas/hydra.view" }, "hydra:search": { "$ref": "#/components/schemas/hydra.search" } }, "required": [ "member" ] }, "examples": { "blocked_numbers_get_ld": { "$ref": "#/components/examples/blocked_numbers_get_jsonld" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/schema.blocked_numbers-blocked_number_read" } }, "examples": { "blocked_numbers_get_json": { "$ref": "#/components/examples/blocked_numbers_get" } } } } }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Retrieves the collection of blocked phone numbers", "description": "Retrieves the collection of blocked phone numbers with optional filtering by number or type", "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X GET https://api.lox24.eu/blocked_numbers \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string url = \"https://api.lox24.eu/blocked_numbers?page=1\";\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\"; // or \"application/ld+json\"\n httpWebRequest.Method = \"GET\";\n //httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n Console.WriteLine(\"Success:{0} {1}\", respCode, \"blocked numbers collection response\");\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n}", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"GET\"\n\tconst URL = \"https://api.lox24.eu/blocked_numbers?page=1\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println((string(body)))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.blocked_number;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GetBlockedNumbersCollection {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var url = \"https://api.lox24.eu/blocked_numbers?page=1\";\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .GET()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"blocked numbers collection response\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n } else {\n System.out.println(\"Error: something went wrong, code(\" + httpResponse.statusCode() + \")\");\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar query = \"page=1\";\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/blocked_numbers?' + query,\n method: 'GET',\n headers: {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log('Success: code = 200 - blocked numbers list response');\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n\n});\n\nreq.on('error', error => {\n console.error(error)\n});\n\nreq.end();", "label": "JavaScript" }, { "lang": "php", "source": " 1,\n];\n\n$uri .= $filters ? '?' . http_build_query($filters) : '';\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_URL => $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\nurl = \"https://api.lox24.eu/blocked_numbers?page=1\"\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - blocked numbers collection response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n", "label": "Python" } ] }, "post": { "operationId": "api_blocked_numbers_post", "tags": [ "blocked-numbers" ], "responses": { "201": { "description": "blocked_number resource created", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.blocked_numbers.jsonld-blocked_number_read" }, "examples": { "blocked_number_post_ld": { "$ref": "#/components/examples/blocked_number_post_jsonld" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.blocked_numbers-blocked_number_read" }, "examples": { "blocked_number_post_json": { "$ref": "#/components/examples/blocked_number_post" } } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "409": { "$ref": "#/components/responses/409-conflict" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Creates a blocked phone number resource", "description": "Creates a new blocked phone number for the authenticated user", "requestBody": { "description": "The new blocked phone number resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.blocked_numbers-blocked_number_write" }, "examples": { "blocked_number_req_ld": { "$ref": "#/components/examples/blocked_number_request" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.blocked_numbers-blocked_number_write" }, "examples": { "blocked_number_req_json": { "$ref": "#/components/examples/blocked_number_request" } } } }, "required": true }, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X POST https://api.lox24.eu/blocked_numbers \\\n -H 'Content-Type: application/json' \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx' \\\n -d '{\n \"number\": \"+1234567890\"\n}'", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json;\nusing Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string url = \"https://api.lox24.eu/blocked_numbers\";\n\n\n var data = new {\n number = \"+1234567890\"\n };\n\n string postdata = JsonConvert.SerializeObject(data);\n\n Console.WriteLine(\"Post data: {0}\", postdata);\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.ContentType = \"application/json; charset=utf-8\";\n httpWebRequest.Accept = \"application/json\"; // or application/ld+json\n httpWebRequest.Method = \"POST\";\n httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n using (var streamWriter = new StreamWriter(httpWebRequest.GetRequestStream()))\n {\n streamWriter.Write(postdata);\n streamWriter.Flush();\n streamWriter.Close();\n }\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n\n if(resp.StatusCode == HttpStatusCode.Created) {\n Console.WriteLine(\"Success:{0} {1}\", (int)resp.StatusCode, \"blocked number resource created\");\n } else {\n Console.WriteLine(\"Error: wrong response code {0} on create blocked number\", (int)resp.StatusCode);\n }\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.BadRequest: // 400\n Console.WriteLine(\"Error:400 Invalid input\");\n break;\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.Conflict: // 409\n Console.WriteLine(\"Error:409 Conflict - resource already exists\");\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n}", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"bytes\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"POST\"\n\tconst URL = \"https://api.lox24.eu/blocked_numbers\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tpayload := map[string]interface{}{\n\t\t\"number\": \"+1234567890\",\n\t}\n\n\tjsonPayload, _ := json.Marshal(payload)\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, bytes.NewBuffer(jsonPayload))\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Content-Type\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 201:\n\t\tfmt.Println((string(body)))\n\tcase 400:\n\t\tfmt.Println(\"Error: code = 400 - Invalid input\")\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tcase 409:\n\t\tfmt.Println(\"Error: code = 409 - Conflict - resource already exists\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.blocked_number;\n\nimport org.json.JSONObject;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class PostBlockedNumberCollection {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var url = \"https://api.lox24.eu/blocked_numbers\";\n\n var json = new JSONObject();\n json.put(\"number\", \"+1234567890\");\n\n var postData = json.toString();\n\n System.out.println(\"Post data: \" + postData);\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Content-Type\", \"application/json; charset=utf-8\")\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .POST(HttpRequest.BodyPublishers.ofString(postData))\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_CREATED) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"blocked number resource created\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error: wrong response code \" + httpResponse.statusCode() + \" on create blocked number\");\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_BAD_REQUEST: // 400\n System.out.println(\"Error:400 Invalid input\");\n break;\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_CONFLICT: // 409\n System.out.println(\"Error:409 Conflict - resource already exists\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar postObj = {\n number: '+1234567890'\n};\n\nvar postdata = JSON.stringify(postObj);\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/blocked_numbers',\n method: 'POST',\n headers: {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'Content-Length': postdata.length,\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 201) {\n console.log(\"Success: code = 201 - blocked number resource created\");\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 400) {\n console.log(\"Error: code = 400 - Invalid input\");\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else if (res.statusCode == 409) {\n console.log(\"Error: code = 409 - Conflict - resource already exists\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n})\n\nreq.on('error', error => {\n console.error(error)\n})\nreq.write(postdata);\nreq.end();", "label": "JavaScript" }, { "lang": "php", "source": " \"+1234567890\",\n];\n\nif(!$body = json_encode($body)) {\n die('JSON encoding error!');\n}\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_POST => true,\n CURLOPT_URL => $uri,\n CURLOPT_POSTFIELDS => $body,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n 'Content-Type: application/json',\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(201 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\nurl = 'https://api.lox24.eu/blocked_numbers'\n\n\ndata = {\n 'number': '+1234567890'\n}\n\nheaders = {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\nprint(\"Post data : \", json.dumps(data, indent=4))\n\ntry:\n # timeout is 100 seconds, the payload is automatically converted to json format\n res = requests.post(url, headers=headers, json=data, timeout=100)\n if res.status_code != 201: # Created\n print(\"Error: Wrong response code on create blocked number\")\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - blocked number resource created')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 400:\n print(\"Error:400 Invalid input\")\n elif res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 409:\n print(\"Error:409 Conflict - resource already exists\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))", "label": "Python" } ] } }, "/blocked_numbers/{id}": { "get": { "operationId": "api_blocked_numbers_get_item", "tags": [ "blocked-numbers" ], "parameters": [ { "$ref": "#/components/parameters/path.blocked_numbers.id" } ], "responses": { "200": { "description": "blocked_number resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/schema.blocked_numbers.jsonld-blocked_number_read" }, "examples": { "blocked_number_get_ld": { "$ref": "#/components/examples/blocked_number_get_jsonld" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/schema.blocked_numbers-blocked_number_read" }, "examples": { "blocked_number_get_json": { "$ref": "#/components/examples/blocked_number_get" } } } } }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Retrieves a blocked phone number resource", "description": "Retrieves a blocked phone number resource by its identifier", "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X GET https://api.lox24.eu/blocked_numbers/12344 \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string id = \"12344\";\n string url = \"https://api.lox24.eu/blocked_numbers/\" + id;\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\"; // or \"application/ld+json\"\n httpWebRequest.Method = \"GET\";\n //httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n Console.WriteLine(\"Success:{0} {1}\", respCode, \"blocked number resource response\");\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.NotFound: // 404\n Console.WriteLine(\"Error:404 Blocked number with id = {0} not found!\", id);\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n}", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"GET\"\n\tconst URL = \"https://api.lox24.eu/blocked_numbers/12344\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println((string(body)))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tcase 404:\n\t\tfmt.Println(\"Error: code = 404 - Blocked number not found!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.blocked_number;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GetBlockedNumberItem {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var id = \"12344\";\n var url = \"https://api.lox24.eu/blocked_numbers/\" + id;\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\") // or application/ld+json\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .GET()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"blocked number resource response\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n } else {\n System.out.println(\"Error: something went wrong, code(\" + httpResponse.statusCode() + \")\");\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_NOT_FOUND: // 404\n System.out.println(\"Error:404 Blocked number with id = \" + id + \" not found!\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar id = '12344';\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/blocked_numbers/' + id,\n method: 'GET',\n headers: {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log('Success: code = 200 - blocked number resource response');\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else if (res.statusCode == 404) {\n console.log(\"Error: code = 404 - Blocked number not found\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n\n})\n\nreq.on('error', error => {\n console.error(error)\n})\n\nreq.end();", "label": "JavaScript" }, { "lang": "php", "source": " $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} elseif(404 === $code) {\n echo \"Blocked number with id = {$id} not found!\";\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\nid = \"12344\"\n\nurl = f\"https://api.lox24.eu/blocked_numbers/{id}\"\n\nheaders = {\n 'Accept': 'application/json', # or application/ld+json\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - blocked number resource response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 404:\n print(f\"Error: code = 404 - Blocked number with id = {id} not found!\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))", "label": "Python" } ] }, "delete": { "operationId": "api_blocked_numbers_delete_item", "tags": [ "blocked-numbers" ], "parameters": [ { "$ref": "#/components/parameters/path.blocked_numbers.id" } ], "responses": { "204": { "description": "blocked_number resource deleted" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "summary": "Removes the blocked phone number resource", "description": "Removes the blocked phone number resource from the user's blocked list", "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X DELETE https://api.lox24.eu/blocked_numbers/12344 \\\n -H 'Content-Type: application/json' \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json.Linq;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class client\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\n var id = \"12344\";\n string url = \"https://api.lox24.eu/blocked_numbers/\" + id;\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.Accept = \"application/json\";\n httpWebRequest.Method = \"DELETE\";\n //httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n int respCode = (int)resp.StatusCode;\n if(resp.StatusCode == HttpStatusCode.NoContent) { //204\n Console.WriteLine(\"Success: blocked number was deleted\");\n } else {\n Console.WriteLine(\"Error: something went wrong, code({0})\", respCode);\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n\n JObject parsed = JObject.Parse(responseText);\n\n foreach (var pair in parsed)\n {\n Console.WriteLine(\"{0}: {1}\", pair.Key, pair.Value);\n }\n }\n }\n\n }\n\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized: // 401\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden: // 403\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.NotFound: // 404\n Console.WriteLine(\"Error:404 Blocked number with id = {0} not found!\", id);\n break;\n case HttpStatusCode.InternalServerError: // 500\n case HttpStatusCode.BadGateway: //502\n case HttpStatusCode.ServiceUnavailable: // 503\n case HttpStatusCode.GatewayTimeout: // 504\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n}", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"DELETE\"\n\tconst URL = \"https://api.lox24.eu/blocked_numbers/12344\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 204:\n\t\tfmt.Println(\"Blocked number was deleted successfully!\")\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tcase 404:\n\t\tfmt.Println(\"Error: code = 404 - Blocked number not found!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d, response = %s\\n\", res.StatusCode, string(body))\n\t}\n}", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.blocked_number;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class DeleteBlockedNumberItem {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var id = \"12344\";\n var url = \"https://api.lox24.eu/blocked_numbers/\" + id;\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\")\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .DELETE()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_NO_CONTENT) { // 204\n System.out.println(\"Success: blocked number was deleted\");\n } else {\n System.out.println(\"Error: something went wrong, code(\" + httpResponse.statusCode() + \")\");\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_UNAUTHORIZED: // 401\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN: // 403\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_NOT_FOUND: // 404\n System.out.println(\"Error:404 Blocked number with id = \" + id + \" not found!\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500\n case HttpURLConnection.HTTP_BAD_GATEWAY: //502\n case HttpURLConnection.HTTP_UNAVAILABLE: // 503\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}", "label": "Java" }, { "lang": "javascript", "source": "const host = 'api.lox24.eu';\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar id = '12344';\n\nconst https = require('https');\nconst options = {\n hostname: host,\n path: '/blocked_numbers/' + id,\n method: 'DELETE',\n headers: {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 204) {\n console.log('Success: code = 204 - blocked number resource deleted');\n res.on('data', d => { process.stdout.write(d) })\n } else if (res.statusCode == 401) {\n console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n } else if (res.statusCode == 403) {\n console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n } else if (res.statusCode == 404) {\n console.log(\"Error: code = 404 - Blocked number not found\");\n } else {\n console.log(\"Error: code = \" + res.statusCode );\n }\n});\n\nreq.on('error', error => {\n console.error(error)\n});\n\nreq.end();", "label": "JavaScript" }, { "lang": "php", "source": " $uri,\n CURLOPT_CUSTOMREQUEST => 'DELETE',\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json', // or application/ld+json\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\nif(204 === $code) {\n echo \"Blocked number with id = {$id} was deleted!\";\n} elseif(404 === $code) {\n echo \"Blocked number with id = {$id} not found!\";\n} else {\n $data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n echo \"Blocked number: code = {$code}, data = \" . var_export($data, true);\n}\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\nid = \"12344\"\n\nurl = f\"https://api.lox24.eu/blocked_numbers/{id}\"\n\nheaders = {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n # timeout is 100 seconds\n res = requests.delete(url, headers=headers, timeout=100)\n if res.status_code != 204: # No Content\n print(\"Error: Wrong response code on delete blocked number\")\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - blocked number was deleted')\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 404:\n print(f\"Error: code = 404 - Blocked number with id = {id} not found!\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n # Only try to print JSON if response has content\n if res.content:\n print(json.dumps(res.json(), indent=4))", "label": "Python" } ] } }, "/verify_codes": { "get": { "operationId": "api_verify_codes_get_collection", "tags": [ "verify-codes" ], "summary": "Recupera a cole\u00e7\u00e3o de c\u00f3digos de verifica\u00e7\u00e3o", "description": "Recupera uma lista de c\u00f3digos de verifica\u00e7\u00e3o criados pelo usu\u00e1rio.", "responses": { "200": { "description": "Collection of verify codes", "content": { "application/ld+json": { "schema": { "type": "object", "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/verify_code_read" } }, "hydra:totalItems": { "$ref": "#/components/schemas/hydra.totalItems" }, "hydra:view": { "$ref": "#/components/schemas/hydra.view" }, "hydra:search": { "$ref": "#/components/schemas/hydra.search" } }, "required": [ "member" ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/verify_code_read" } }, "examples": { "collection": { "summary": "Verify code collection", "value": [ { "id": "d7ad7539-fb8f-4dbb-a7f7-7c40babec969", "user_id": 12345, "phone": "+491701234567", "routing_strategy": [ { "channel": "telegram", "timeout_sec": 30 }, { "channel": "voice", "sender_id": "LOX24", "template": "Your code is {{code}}" }, { "channel": "sms", "sender_id": "LOX24", "template": "Your code is {{code}}" } ], "status": 10, "delivered_channel": "sms", "cost": 120, "currency": "EUR", "code": "1234", "code_length": 4, "payload": "yours payload here", "lang": "EN", "created_at": 1779903448, "updated_at": 1779903510, "history": [ { "id": "bccaff09-59f2-11f1-a685-7c10c91d54a1", "channel": "telegram", "status": 20, "processed_at": 1779903478, "external_id": "tg_msg_001" }, { "id": "bccaff09-59f2-11f1-a685-7c10c91d54a2", "channel": "voice", "status": 20, "processed_at": 1779903490, "external_id": "voice_msg_002" }, { "id": "bccaff09-59f2-11f1-a685-7c10c91d54a3", "channel": "sms", "status": 10, "processed_at": 1779903510, "external_id": "sms_msg_003" } ], "is_code_deleted": false } ] } } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "parameters": [ { "$ref": "#/components/parameters/filter.common.page" } ], "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X GET https://api.lox24.eu/verify_codes \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class GetVerifyCodesCollection\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string url = \"https://api.lox24.eu/verify_codes\";\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.ContentType = \"application/json; charset=utf-8\";\n httpWebRequest.Accept = \"application/json\";\n httpWebRequest.Method = \"GET\";\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n if (resp.StatusCode == HttpStatusCode.OK) {\n Console.WriteLine(\"Success:{0} {1}\", (int)resp.StatusCode, \"verify code collection response\");\n } else {\n Console.WriteLine(\"Error: wrong response code {0}\", (int)resp.StatusCode);\n }\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized:\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden:\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpStatusCode.InternalServerError:\n case HttpStatusCode.BadGateway:\n case HttpStatusCode.ServiceUnavailable:\n case HttpStatusCode.GatewayTimeout:\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n}\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"GET\"\n\tconst URL = \"https://api.lox24.eu/verify_codes\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := io.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println(string(body))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.verify_codes;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GetVerifyCodesCollection {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var url = \"https://api.lox24.eu/verify_codes\";\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\")\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .GET()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1)\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"verify code collection response\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n } else {\n switch (httpResponse.statusCode()) {\n case HttpURLConnection.HTTP_UNAUTHORIZED:\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN:\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR:\n case HttpURLConnection.HTTP_BAD_GATEWAY:\n case HttpURLConnection.HTTP_UNAVAILABLE:\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT:\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n default:\n System.out.println(\"Error: wrong response code \" + httpResponse.statusCode());\n }\n }\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "/*\n * Get verify code collection\n */\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nconst https = require('https');\nconst options = {\n hostname: 'api.lox24.eu',\n path: '/verify_codes',\n method: 'GET',\n headers: {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log(\"Success: code = 200 - verify code collection response\");\n res.on('data', d => { process.stdout.write(d) })\n }\n else if (res.statusCode == 401) console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n else if (res.statusCode == 403) console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n})\n\nreq.on('error', error => {\n console.error(error)\n})\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json',\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\nurl = 'https://api.lox24.eu/verify_codes'\n\nheaders = {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - verify code collection response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n", "label": "Python" } ] }, "post": { "operationId": "api_verify_codes_post_collection", "tags": [ "verify-codes" ], "summary": "Criar um c\u00f3digo de verifica\u00e7\u00e3o", "description": "Inicia um processo de verifica\u00e7\u00e3o criando um novo c\u00f3digo de verifica\u00e7\u00e3o com uma estrat\u00e9gia de roteamento especificada.", "requestBody": { "description": "The verify code request payload", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/verify_code_write" }, "examples": { "multi_channel": { "$ref": "#/components/examples/example_verify_code_request" }, "telegram": { "$ref": "#/components/examples/example_verify_code_request_telegram" }, "voice": { "$ref": "#/components/examples/example_verify_code_request_voice" } } } } }, "responses": { "201": { "description": "Verify code created and delivery process started", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/verify_code_read" }, "examples": { "multi_channel": { "$ref": "#/components/examples/example_verify_code_response" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/verify_code_read" }, "examples": { "multi_channel": { "$ref": "#/components/examples/example_verify_code_response" } } } } }, "400": { "$ref": "#/components/responses/400-bad-request" }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "402": { "$ref": "#/components/responses/402-not-enough-funds" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "422": { "$ref": "#/components/responses/422-unprocessable-entity" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X POST https://api.lox24.eu/verify_codes \\\n -H 'Content-Type: application/json' \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx' \\\n -d '{\n \"phone\": \"+491701234567\",\n \"code\": \"1234\",\n \"is_code_deleted\": false,\n \"payload\": \"yours payload here\",\n \"lang\": \"EN\",\n \"routing_strategy\": [\n {\n \"channel\": \"telegram\",\n \"timeout_sec\": 30\n },\n {\n \"channel\": \"voice\",\n \"sender_id\": \"LOX24\",\n \"template\": \"Your code is {{code}}\"\n },\n {\n \"channel\": \"sms\",\n \"sender_id\": \"LOX24\",\n \"template\": \"Your code is {{code}}\"\n }\n ]\n }'\n", "label": "Bash" }, { "lang": "csharp", "source": "using Newtonsoft.Json;\nusing System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class VerifyCodesClient\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string url = \"https://api.lox24.eu/verify_codes\";\n\n var data = new {\n phone = \"+491701234567\",\n code = \"1234\",\n is_code_deleted = false,\n payload = \"yours payload here\",\n lang = \"EN\",\n routing_strategy = new[] {\n new { channel = \"telegram\", timeout_sec = 30 },\n new { channel = \"voice\", sender_id = \"LOX24\", template = \"Your code is {{code}}\" },\n new { channel = \"sms\", sender_id = \"LOX24\", template = \"Your code is {{code}}\" }\n }\n };\n\n string postdata = JsonConvert.SerializeObject(data);\n\n Console.WriteLine(\"Post data: {0}\", postdata);\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.ContentType = \"application/json; charset=utf-8\";\n httpWebRequest.Accept = \"application/json\";\n httpWebRequest.Method = \"POST\";\n httpWebRequest.KeepAlive = true;\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;\n\n using (var streamWriter = new StreamWriter(httpWebRequest.GetRequestStream()))\n {\n streamWriter.Write(postdata);\n streamWriter.Flush();\n streamWriter.Close();\n }\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n\n if(resp.StatusCode == HttpStatusCode.Created) {\n Console.WriteLine(\"Success:{0} {1}\", (int)resp.StatusCode, \"verify code resource created\");\n } else {\n Console.WriteLine(\"Error: wrong response code {0} on create verify code\", (int)resp.StatusCode);\n }\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.BadRequest:\n Console.WriteLine(\"Error:400 Invalid input\");\n break;\n case HttpStatusCode.Unauthorized:\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.PaymentRequired:\n Console.WriteLine(\"Error:402 There are not enough funds on your account!\");\n break;\n case HttpStatusCode.Forbidden:\n Console.WriteLine(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case (HttpStatusCode)422:\n Console.WriteLine(\"Error:422 Unprocessable entity\");\n break;\n case HttpStatusCode.InternalServerError:\n case HttpStatusCode.BadGateway:\n case HttpStatusCode.ServiceUnavailable:\n case HttpStatusCode.GatewayTimeout:\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n}\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"bytes\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"io\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"POST\"\n\tconst URL = \"https://api.lox24.eu/verify_codes\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\troutingStrategy := []map[string]interface{}{\n\t\t{\"channel\": \"telegram\", \"timeout_sec\": 30},\n\t\t{\"channel\": \"voice\", \"sender_id\": \"LOX24\", \"template\": \"Your code is {{code}}\"},\n\t\t{\"channel\": \"sms\", \"sender_id\": \"LOX24\", \"template\": \"Your code is {{code}}\"},\n\t}\n\n\tpayload := map[string]interface{}{\n\t\t\"phone\": \"+491701234567\",\n\t\t\"code\": \"1234\",\n\t\t\"is_code_deleted\": false,\n\t\t\"payload\": \"yours payload here\",\n\t\t\"lang\": \"EN\",\n\t\t\"routing_strategy\": routingStrategy,\n\t}\n\n\tjsonPayload, _ := json.Marshal(payload)\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, bytes.NewBuffer(jsonPayload))\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Content-Type\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := io.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 201:\n\t\tfmt.Println(string(body))\n\tcase 400:\n\t\tfmt.Println(\"Error: code = 400 - Invalid input\")\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 402:\n\t\tfmt.Println(\"Error: code = 402 - There are not enough funds on your account!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n\tcase 422:\n\t\tfmt.Println(\"Error: code = 422 - Unprocessable entity\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.verify_codes;\n\nimport org.json.JSONArray;\nimport org.json.JSONObject;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class PostVerifyCodesCollection {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var url = \"https://api.lox24.eu/verify_codes\";\n\n var routingStrategy = new JSONArray();\n routingStrategy.put(new JSONObject().put(\"channel\", \"telegram\").put(\"timeout_sec\", 30));\n routingStrategy.put(new JSONObject().put(\"channel\", \"voice\").put(\"sender_id\", \"LOX24\").put(\"template\", \"Your code is {{code}}\"));\n routingStrategy.put(new JSONObject().put(\"channel\", \"sms\").put(\"sender_id\", \"LOX24\").put(\"template\", \"Your code is {{code}}\"));\n\n var json = new JSONObject();\n json.put(\"phone\", \"+491701234567\");\n json.put(\"code\", \"1234\");\n json.put(\"is_code_deleted\", false);\n json.put(\"payload\", \"yours payload here\");\n json.put(\"lang\", \"EN\");\n json.put(\"routing_strategy\", routingStrategy);\n\n var postData = json.toString();\n\n System.out.println(\"Post data: \" + postData);\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Content-Type\", \"application/json; charset=utf-8\")\n .setHeader(\"Accept\", \"application/json\")\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .POST(HttpRequest.BodyPublishers.ofString(postData))\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1)\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_CREATED) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"verify code resource created\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n\n } else {\n\n System.out.println(\"Error: wrong response code \" + httpResponse.statusCode() + \" on create verify code\");\n\n switch (httpResponse.statusCode()) {\n\n case HttpURLConnection.HTTP_BAD_REQUEST:\n System.out.println(\"Error:400 Invalid input\");\n break;\n case HttpURLConnection.HTTP_UNAUTHORIZED:\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_PAYMENT_REQUIRED:\n System.out.println(\"Error:402 There are not enough funds on your account!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN:\n System.out.println(\"Error:403 Account isn't activated. Please wait or contact to support!\");\n break;\n case 422:\n System.out.println(\"Error:422 Unprocessable entity\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR:\n case HttpURLConnection.HTTP_BAD_GATEWAY:\n case HttpURLConnection.HTTP_UNAVAILABLE:\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT:\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n }\n\n }\n\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "/*\n * Post verify code\n */\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n\nvar postObj = {\n phone: '+491701234567',\n code: '1234',\n is_code_deleted: false,\n payload: 'yours payload here',\n lang: 'EN',\n routing_strategy: [\n {\n channel: 'telegram',\n timeout_sec: 30\n },\n {\n channel: 'voice',\n sender_id: 'LOX24',\n template: 'Your code is {{code}}'\n },\n {\n channel: 'sms',\n sender_id: 'LOX24',\n template: 'Your code is {{code}}'\n }\n ]\n};\n\nvar postdata = JSON.stringify(postObj);\n\nconst https = require('https');\nconst options = {\n hostname: 'api.lox24.eu',\n path: '/verify_codes',\n method: 'POST',\n headers: {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'Content-Length': postdata.length,\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 201) {\n console.log(\"Success: code = 201 - verify code resource created\");\n res.on('data', d => { process.stdout.write(d) })\n }\n else if (res.statusCode == 400) console.log(\"Error: code = 400 - Invalid input\");\n else if (res.statusCode == 401) console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n else if (res.statusCode == 402) console.log(\"Error: code = 402 - There are not enough funds on your account!\");\n else if (res.statusCode == 403) console.log(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\");\n else if (res.statusCode == 422) console.log(\"Error: code = 422 - Unprocessable entity\");\n})\n\nreq.on('error', error => {\n console.error(error)\n})\nreq.write(postdata);\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " '+491701234567',\n 'code' => '1234',\n 'is_code_deleted' => false,\n 'payload' => 'yours payload here',\n 'lang' => 'EN',\n 'routing_strategy' => [\n [\n 'channel' => 'telegram',\n 'timeout_sec' => 30,\n ],\n [\n 'channel' => 'voice',\n 'sender_id' => 'LOX24',\n 'template' => 'Your code is {{code}}',\n ],\n [\n 'channel' => 'sms',\n 'sender_id' => 'LOX24',\n 'template' => 'Your code is {{code}}',\n ],\n ],\n];\n\nif(!$body = json_encode($body)) {\n die('JSON encoding error!');\n}\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_POST => true,\n CURLOPT_URL => $uri,\n CURLOPT_POSTFIELDS => $body,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json',\n 'Content-Type: application/json',\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(201 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\nurl = 'https://api.lox24.eu/verify_codes'\n\n\ndata = {\n 'phone': \"+491701234567\",\n 'code': \"1234\",\n 'is_code_deleted': False,\n 'payload': \"yours payload here\",\n 'lang': \"EN\",\n 'routing_strategy': [\n {\n 'channel': \"telegram\",\n 'timeout_sec': 30\n },\n {\n 'channel': \"voice\",\n 'sender_id': \"LOX24\",\n 'template': \"Your code is {{code}}\"\n },\n {\n 'channel': \"sms\",\n 'sender_id': \"LOX24\",\n 'template': \"Your code is {{code}}\"\n }\n ]\n}\n\nheaders = {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\nprint(\"Post data : \", json.dumps(data, indent=4))\n\ntry:\n res = requests.post(url, headers=headers, json=data, timeout=100)\n if res.status_code != 201:\n print(\"Error: Wrong response code on create verify code\")\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - verify code resource created')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 400:\n print(\"Error:400 Invalid input\")\n elif res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 402:\n print(\"Error:402 There are not enough funds on your account!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated. Please wait or contact to support!\")\n elif res.status_code == 422:\n print(\"Error:422 Unprocessable entity\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n", "label": "Python" } ] } }, "/verify_codes/{id}": { "get": { "operationId": "api_verify_codes_get_item", "tags": [ "verify-codes" ], "summary": "Recupera a entrada do c\u00f3digo de verifica\u00e7\u00e3o", "description": "Retorna os detalhes de um c\u00f3digo de verifica\u00e7\u00e3o espec\u00edfico, incluindo seu status e hist\u00f3rico.", "parameters": [ { "$ref": "#/components/parameters/path.verify_codes.id" } ], "responses": { "200": { "description": "Verify code details", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/verify_code_read" }, "examples": { "multi_channel": { "$ref": "#/components/examples/example_verify_code_response" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/verify_code_read" }, "examples": { "multi_channel": { "$ref": "#/components/examples/example_verify_code_response" } } } } }, "401": { "$ref": "#/components/responses/401-unauthorized" }, "403": { "$ref": "#/components/responses/403-forbidden" }, "404": { "$ref": "#/components/responses/404-not-found" }, "429": { "$ref": "#/components/responses/429-too-many-requests" } }, "x-codeSamples": [ { "lang": "bash", "source": "#!/usr/bin/env bash\ncurl -X GET https://api.lox24.eu/verify_codes/d7ad7539-fb8f-4dbb-a7f7-7c40babec969 \\\n -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'\n", "label": "Bash" }, { "lang": "csharp", "source": "using System;\nusing System.IO;\nusing System.Net;\nusing System.Text;\n\nnamespace Lox24.Api\n{\n class GetVerifyCodesItem\n {\n static void Main()\n {\n string key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n string verifyCodeId = \"d7ad7539-fb8f-4dbb-a7f7-7c40babec969\";\n string url = $\"https://api.lox24.eu/verify_codes/{verifyCodeId}\";\n\n var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);\n httpWebRequest.ReadWriteTimeout = 100000;\n httpWebRequest.ContentType = \"application/json; charset=utf-8\";\n httpWebRequest.Accept = \"application/json\";\n httpWebRequest.Method = \"GET\";\n httpWebRequest.Headers.Add(\"X-LOX24-AUTH-TOKEN\", key);\n\n try\n {\n using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())\n {\n if (resp.StatusCode == HttpStatusCode.OK) {\n Console.WriteLine(\"Success:{0} {1}\", (int)resp.StatusCode, \"verify code resource response\");\n } else {\n Console.WriteLine(\"Error: wrong response code {0}\", (int)resp.StatusCode);\n }\n\n Stream respStream = resp.GetResponseStream();\n using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))\n {\n string responseText = sr.ReadToEnd();\n Console.WriteLine(\"responseText : {0}\", responseText);\n }\n }\n }\n catch (System.Net.WebException ex)\n {\n var webResponse = ex.Response as System.Net.HttpWebResponse;\n Console.WriteLine(\"Error:{0}\", webResponse.StatusCode);\n\n switch (webResponse.StatusCode)\n {\n case HttpStatusCode.Unauthorized:\n Console.WriteLine(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpStatusCode.Forbidden:\n Console.WriteLine(\"Error:403 Account isn't activated.\");\n break;\n case HttpStatusCode.NotFound:\n Console.WriteLine(\"Error:404 Resource not found\");\n break;\n case HttpStatusCode.InternalServerError:\n case HttpStatusCode.BadGateway:\n case HttpStatusCode.ServiceUnavailable:\n case HttpStatusCode.GatewayTimeout:\n Console.WriteLine(\"System error! Please contact to LOX24 support!\");\n break;\n }\n }\n }\n }\n}\n", "label": "C#" }, { "lang": "go", "source": "package main\n\nimport (\n\t\"fmt\"\n\t\"io\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tconst Method = \"GET\"\n\tconst URL = \"https://api.lox24.eu/verify_codes/d7ad7539-fb8f-4dbb-a7f7-7c40babec969\"\n\tconst Token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\n\n\tclient := &http.Client{}\n\n\treq, err := http.NewRequest(Method, URL, nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\treq.Header.Add(\"X-LOX24-AUTH-TOKEN\", Token)\n\treq.Header.Add(\"Accept\", \"application/json\")\n\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tdefer res.Body.Close()\n\n\tbody, err := io.ReadAll(res.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tswitch res.StatusCode {\n\tcase 200:\n\t\tfmt.Println(string(body))\n\tcase 401:\n\t\tfmt.Println(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n\tcase 403:\n\t\tfmt.Println(\"Error: code = 403 - Account isn't activated.\")\n\tcase 404:\n\t\tfmt.Println(\"Error: code = 404 - Resource not found\")\n\tdefault:\n\t\tfmt.Printf(\"Error: code = %d\\n\", res.StatusCode)\n\t}\n}\n", "label": "Go" }, { "lang": "java", "source": "package eu.lox24.doc.verify_codes;\n\nimport java.io.IOException;\nimport java.net.HttpURLConnection;\nimport java.net.URI;\nimport java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.time.Duration;\n\npublic class GetVerifyCodesItem {\n\n public static void main(String[] args) {\n\n var key = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\n var verifyCodeId = \"d7ad7539-fb8f-4dbb-a7f7-7c40babec969\";\n var url = \"https://api.lox24.eu/verify_codes/\" + verifyCodeId;\n\n var httpRequest = HttpRequest.newBuilder(URI.create(url))\n .timeout(Duration.ofMillis(100000))\n .setHeader(\"Accept\", \"application/json\")\n .setHeader(\"X-LOX24-AUTH-TOKEN\", key)\n .GET()\n .build();\n\n var client = HttpClient.newBuilder()\n .version(HttpClient.Version.HTTP_1_1)\n .build();\n\n try {\n var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());\n\n if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {\n System.out.println(\"Success:\" + httpResponse.statusCode() + \" \" + \"verify code resource response\");\n System.out.println(\"Response text : \\n\" + httpResponse.body());\n } else {\n switch (httpResponse.statusCode()) {\n case HttpURLConnection.HTTP_UNAUTHORIZED:\n System.out.println(\"Error:401 Client ID or API key isn't active or invalid!\");\n break;\n case HttpURLConnection.HTTP_FORBIDDEN:\n System.out.println(\"Error:403 Account isn't activated.\");\n break;\n case HttpURLConnection.HTTP_NOT_FOUND:\n System.out.println(\"Error:404 Resource not found\");\n break;\n case HttpURLConnection.HTTP_INTERNAL_ERROR:\n case HttpURLConnection.HTTP_BAD_GATEWAY:\n case HttpURLConnection.HTTP_UNAVAILABLE:\n case HttpURLConnection.HTTP_GATEWAY_TIMEOUT:\n System.out.println(\"System error! Please contact to LOX24 support!\");\n break;\n default:\n System.out.println(\"Error: wrong response code \" + httpResponse.statusCode());\n }\n }\n } catch (IOException | InterruptedException e) {\n e.printStackTrace();\n }\n }\n}\n", "label": "Java" }, { "lang": "javascript", "source": "/*\n * Get verify code by ID\n */\nconst token = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\";\nconst verifyCodeId = \"d7ad7539-fb8f-4dbb-a7f7-7c40babec969\";\n\nconst https = require('https');\nconst options = {\n hostname: 'api.lox24.eu',\n path: `/verify_codes/${verifyCodeId}`,\n method: 'GET',\n headers: {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token\n }\n}\n\nconst req = https.request(options, res => {\n if (res.statusCode == 200) {\n console.log(\"Success: code = 200 - verify code resource response\");\n res.on('data', d => { process.stdout.write(d) })\n }\n else if (res.statusCode == 401) console.log(\"Error: code = 401 - Client ID or API key isn't active or invalid!\");\n else if (res.statusCode == 403) console.log(\"Error: code = 403 - Account isn't activated.\");\n else if (res.statusCode == 404) console.log(\"Error: code = 404 - Resource not found\");\n})\n\nreq.on('error', error => {\n console.error(error)\n})\nreq.end();\n", "label": "JavaScript" }, { "lang": "php", "source": " $uri,\n CURLOPT_HTTPHEADER => [\n \"X-LOX24-AUTH-TOKEN: {$token}\",\n 'Accept: application/json',\n ],\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_TIMEOUT => 20,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n]);\n\n$response = curl_exec($curl);\n$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);\ncurl_close($curl);\n\n$data = json_decode($response, JSON_OBJECT_AS_ARRAY);\n\nif(200 === $code) {\n echo 'Success: response data = ' . var_export($data, true);\n} else {\n echo \"Error: code = {$code}, data = \" . var_export($data, true);\n}\n", "label": "PHP (cUrl)" }, { "lang": "python", "source": "import json\nimport requests\n\n\ntoken = \"1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx\"\nverify_code_id = \"d7ad7539-fb8f-4dbb-a7f7-7c40babec969\"\n\nurl = f'https://api.lox24.eu/verify_codes/{verify_code_id}'\n\nheaders = {\n 'Accept': 'application/json',\n 'X-LOX24-AUTH-TOKEN': token,\n}\n\ntry:\n res = requests.get(url, headers=headers, timeout=100)\n if res.status_code != 200:\n res.raise_for_status()\n else:\n print(f'Success: code = {res.status_code} - verify code resource response')\n print(\"Response: \", json.dumps(res.json(), indent=4))\n\nexcept requests.HTTPError:\n if res.status_code == 401:\n print(\"Error: code = 401 - Client ID or API key isn't active or invalid!\")\n elif res.status_code == 403:\n print(\"Error: code = 403 - Account isn't activated.\")\n elif res.status_code == 404:\n print(\"Error:404 Resource not found\")\n elif res.status_code in (500, 502, 503, 504):\n print(\"System error! Please contact to LOX24 support!\")\n else:\n print(f\"Error: code {res.status_code}\")\n print(json.dumps(res.json(), indent=4))\n", "label": "Python" } ] } } }, "webhooks": { "webhooks.sms-delivery": { "post": { "summary": "Relat\u00f3rio de Entrega SMS (DLR)", "description": "O evento 'sms.delivery' envia altera\u00e7\u00f5es no [`dlr_code`](/#tag/sms-delivery-report-codes-dlr). Isso permite que voc\u00ea descubra se uma mensagem SMS foi entregue com sucesso, rejeitada ou ainda est\u00e1 sendo entregue.\n\nCada SMS tem um c\u00f3digo de relat\u00f3rio de entrega [Notifica\u00e7\u00f5es de webhook](/#tag/notifications)", "tags": [ "sms" ], "operationId": "webhooks.sms-delivery-webhook", "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/webhook.event" }, { "properties": { "name": { "enum": [ "sms.delivery" ] }, "data": { "$ref": "#/components/schemas/schema.webhooks.sms-delivery-data" } } } ] }, "examples": { "delivered": { "$ref": "#/components/examples/webhooks.examples.sms-delivery-event" }, "expired": { "$ref": "#/components/examples/webhooks.examples.sms-delivery-event-expired" } } } } }, "responses": { "200": { "$ref": "#/components/responses/webhook-200" }, "400": { "$ref": "#/components/responses/webhook-400" }, "401": { "$ref": "#/components/responses/webhook-401" }, "403": { "$ref": "#/components/responses/webhook-403" }, "404": { "$ref": "#/components/responses/webhook-404" }, "500": { "$ref": "#/components/responses/webhook-500" } } } }, "webhooks.sms-delivery-dryrun": { "post": { "summary": "Teste Registo de entrega de SMS (DLR)", "description": "O evento 'sms.delivery.dryrun' \u00e9 usado para uma emula\u00e7\u00e3o de envio de SMS. Veja [Simular o envio de um SMS (para teste)](/#tag/sms/operation/api_sms_post_dryrun_collection).\n\nCada SMS tem um c\u00f3digo de relat\u00f3rio de entrega (DLR).\n\n[Notifica\u00e7\u00f5es de webhook](/#tag/notifications)", "tags": [ "sms" ], "operationId": "webhooks.sms-delivery-dryrun-webhook", "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/webhook.event" }, { "properties": { "name": { "enum": [ "sms.delivery.dryrun" ] }, "data": { "$ref": "#/components/schemas/schema.webhooks.sms-delivery-data" } } } ] } } } }, "responses": { "200": { "$ref": "#/components/responses/webhook-200" }, "400": { "$ref": "#/components/responses/webhook-400" }, "401": { "$ref": "#/components/responses/webhook-401" }, "403": { "$ref": "#/components/responses/webhook-403" }, "404": { "$ref": "#/components/responses/webhook-404" }, "500": { "$ref": "#/components/responses/webhook-500" } } } }, "webhooks.incoming-sms-received": { "post": { "summary": "SMS entrantes", "description": "O evento 'sms.incoming' \u00e9 enviado em um SMS de entrada/resposta (originado pelo celular - SMS-MO).\n\n[Notifica\u00e7\u00f5es de webhook](/#tag/notifications)", "operationId": "smsIncomingWebhook", "tags": [ "incomings" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/webhook.event" }, { "properties": { "name": { "enum": [ "sms.incoming" ] }, "data": { "$ref": "#/components/schemas/schema.webhooks.sms-incoming-data" } } } ] }, "examples": { "reply": { "$ref": "#/components/examples/webhooks.examples.sms-incoming-event" } } } } }, "responses": { "200": { "$ref": "#/components/responses/webhook-200" }, "400": { "$ref": "#/components/responses/webhook-400" }, "401": { "$ref": "#/components/responses/webhook-401" }, "403": { "$ref": "#/components/responses/webhook-403" }, "404": { "$ref": "#/components/responses/webhook-404" }, "500": { "$ref": "#/components/responses/webhook-500" } } } }, "webhooks.bulk-email-parsing-fail": { "post": { "summary": "Bulk Email Parsing Error Webhook", "description": "O evento `bulk.email.parsing.fail` \u00e9 enviado em caso de erro na an\u00e1lise do e-mail.\n\n[Notifica\u00e7\u00f5es de webhook](/#tag/notifications)", "operationId": "bulkEmailParsingFailWebhook", "tags": [ "bulks" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/webhook.event" }, { "properties": { "name": { "enum": [ "bulk.email.parsing.fail" ] }, "data": { "$ref": "#/components/schemas/schema.webhooks.bulk-email-parsing-fail-data" } } } ] }, "examples": { "invalid_number": { "$ref": "#/components/examples/webhooks.examples.bulk-email-parsing-fail-event" } } } } }, "responses": { "200": { "$ref": "#/components/responses/webhook-200" }, "400": { "$ref": "#/components/responses/webhook-400" }, "401": { "$ref": "#/components/responses/webhook-401" }, "403": { "$ref": "#/components/responses/webhook-403" }, "404": { "$ref": "#/components/responses/webhook-404" }, "500": { "$ref": "#/components/responses/webhook-500" } } } }, "webhooks.bulk-email-parsing-success": { "post": { "summary": "Bulk Email Parsing Success", "description": "O evento `bulk.email.parsing.success` \u00e9 enviado na an\u00e1lise bem-sucedida de um e-mail [Email to SMS Bulk](/#tag/email-to-sms).\n\n[Notifica\u00e7\u00f5es de webhook](/#tag/notifications)", "operationId": "bulkEmailParsingSuccessWebhook", "tags": [ "bulks" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/webhook.event" }, { "properties": { "name": { "enum": [ "bulk.email.parsing.success" ] }, "data": { "$ref": "#/components/schemas/schema.webhooks.bulk-email-parsing-success-data" } } } ] }, "examples": { "success": { "$ref": "#/components/examples/webhooks.examples.bulk-email-parsing-success-event" } } } } }, "responses": { "200": { "$ref": "#/components/responses/webhook-200" }, "400": { "$ref": "#/components/responses/webhook-400" }, "401": { "$ref": "#/components/responses/webhook-401" }, "403": { "$ref": "#/components/responses/webhook-403" }, "404": { "$ref": "#/components/responses/webhook-404" }, "500": { "$ref": "#/components/responses/webhook-500" } } } }, "webhooks.fraud-check-done": { "post": { "summary": "Fraud Check Completed", "description": "Triggered when a Fraud Detection request is completed", "operationId": "fraudCheckDoneWebhook", "tags": [ "fraud-detection" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/webhook.event" }, { "properties": { "name": { "enum": [ "fraud-check.done" ] }, "data": { "$ref": "#/components/schemas/schema.webhooks.fraud-check-done-data" } } } ] }, "examples": { "completed": { "$ref": "#/components/examples/webhooks.examples.fraud-check-done-event" } } } } }, "responses": { "200": { "$ref": "#/components/responses/webhook-200" }, "400": { "$ref": "#/components/responses/webhook-400" }, "401": { "$ref": "#/components/responses/webhook-401" }, "403": { "$ref": "#/components/responses/webhook-403" }, "404": { "$ref": "#/components/responses/webhook-404" }, "500": { "$ref": "#/components/responses/webhook-500" } } }, "description": "O evento `fraud-check.done` \u00e9 enviado quando uma solicita\u00e7\u00e3o de Detec\u00e7\u00e3o de Fraude \u00e9 conclu\u00edda. Para detalhes sobre a estrutura da resposta, veja [Fraud Detection API](/#tag/fraud-detection/operation/api_fraud-check_post_collection).\n\n[Notifica\u00e7\u00f5es de webhook](/?l=pt/#tag/notifications)" }, "webhooks.sms-email-parsing-success": { "post": { "summary": "Sucesso na an\u00e1lise de email SMS", "description": "Acionado quando o email para SMS \u00e9 analisado com sucesso", "operationId": "webhooks.sms-email-parsing-success", "tags": [ "sms" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/webhook.event" }, { "properties": { "name": { "enum": [ "sms.email.parsing.success" ] }, "data": { "$ref": "#/components/schemas/schema.webhooks.sms-email-parsing-success-data" } } } ] }, "examples": { "success": { "$ref": "#/components/examples/webhooks.examples.sms-email-parsing-success-event" } } } } }, "responses": { "200": { "$ref": "#/components/responses/webhook-200" }, "400": { "$ref": "#/components/responses/webhook-400" }, "401": { "$ref": "#/components/responses/webhook-401" }, "403": { "$ref": "#/components/responses/webhook-403" }, "404": { "$ref": "#/components/responses/webhook-404" }, "500": { "$ref": "#/components/responses/webhook-500" } } } }, "webhooks.sms-email-parsing-fail": { "post": { "summary": "Falha na an\u00e1lise de email SMS", "description": "Acionado quando a an\u00e1lise de email para SMS falha", "operationId": "webhooks.sms-email-parsing-fail", "tags": [ "sms" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/webhook.event" }, { "properties": { "name": { "enum": [ "sms.email.parsing.fail" ] }, "data": { "$ref": "#/components/schemas/schema.webhooks.sms-email-parsing-fail-data" } } } ] }, "examples": { "fail": { "$ref": "#/components/examples/webhooks.examples.sms-email-parsing-fail-event" } } } } }, "responses": { "200": { "$ref": "#/components/responses/webhook-200" }, "400": { "$ref": "#/components/responses/webhook-400" }, "401": { "$ref": "#/components/responses/webhook-401" }, "403": { "$ref": "#/components/responses/webhook-403" }, "404": { "$ref": "#/components/responses/webhook-404" }, "500": { "$ref": "#/components/responses/webhook-500" } } } }, "webhooks.phone-unsubscribe": { "post": { "summary": "Webhook de Cancelamento de Inscri\u00e7\u00e3o de Telefone", "description": "Acionado quando um n\u00famero de telefone cancela a inscri\u00e7\u00e3o atrav\u00e9s do envio de formul\u00e1rio", "tags": [ "phones" ], "operationId": "webhooks.phone-unsubscribe-webhook", "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/webhook.event" }, { "properties": { "name": { "enum": [ "phone.unsubscribe" ] }, "data": { "$ref": "#/components/schemas/schema.webhooks.phone-unsubscribe-data" } } } ] }, "examples": { "unsubscribe": { "summary": "Evento de cancelamento de inscri\u00e7\u00e3o de telefone", "value": { "id": "ef58b437-1319-4b0c-961b-17214cf1cf32", "data": { "phone": "+4911113333444", "user_id": 2, "created_at": 1757849748, "campaign_code": "3KCKb5nMD", "additional_data": { "reason": { "id": 4, "label": "Es ist unverst\u00e4ndlich" }, "additional_text": "zus\u00e4tzlicher Benutzertext mit Erkl\u00e4rung" }, "short_link_code": "baaIou", "unsubscribe_request_id": 59 }, "name": "phone.unsubscribe", "created_at": 1757849748, "api_version": "2022-05-25", "attempt_number": 1, "attempts_total": 4 } } } } } }, "responses": { "200": { "$ref": "#/components/responses/webhook-200" }, "400": { "$ref": "#/components/responses/webhook-400" }, "401": { "$ref": "#/components/responses/webhook-401" }, "403": { "$ref": "#/components/responses/webhook-403" }, "404": { "$ref": "#/components/responses/webhook-404" }, "500": { "$ref": "#/components/responses/webhook-500" } } } }, "webhooks.phone-subscribe": { "post": { "summary": "Webhook de Inscri\u00e7\u00e3o de Telefone", "description": "Acionado quando um n\u00famero de telefone se inscreve atrav\u00e9s do envio de formul\u00e1rio", "tags": [ "phones" ], "operationId": "webhooks.phone-subscribe-webhook", "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/webhook.event" }, { "properties": { "name": { "enum": [ "phone.subscribe" ] }, "data": { "$ref": "#/components/schemas/schema.webhooks.phone-subscribe-data" } } } ] }, "examples": { "subscribe": { "summary": "Evento de inscri\u00e7\u00e3o de telefone", "value": { "id": "ed18a290-766d-46cf-ab4e-6fa421405fbd", "data": { "phone": "+99559122567", "user_id": 21911, "created_at": 1757926648, "campaign_code": "1dkGdCC2xnBc", "additional_data": [], "short_link_code": "baaIoP", "group_id": 123 }, "name": "phone.subscribe", "created_at": 1757926648, "api_version": "2022-05-25", "attempt_number": 1, "attempts_total": 4 } } } } } }, "responses": { "200": { "$ref": "#/components/responses/webhook-200" }, "400": { "$ref": "#/components/responses/webhook-400" }, "401": { "$ref": "#/components/responses/webhook-401" }, "403": { "$ref": "#/components/responses/webhook-403" }, "404": { "$ref": "#/components/responses/webhook-404" }, "500": { "$ref": "#/components/responses/webhook-500" } } } }, "webhooks.verify-code-success": { "post": { "summary": "C\u00f3digo de verifica\u00e7\u00e3o bem-sucedido", "description": "O evento `verify_code.success` \u00e9 acionado quando o c\u00f3digo de verifica\u00e7\u00e3o foi entregue com sucesso e o destinat\u00e1rio foi verificado.\n\n[Notifica\u00e7\u00f5es de webhook](/#tag/notifications)", "tags": [ "verify-codes" ], "operationId": "webhooks.verify-code-success", "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/webhook.event" }, { "properties": { "name": { "enum": [ "verify_code.success" ] }, "data": { "$ref": "#/components/schemas/schema.webhooks.verify-code-data" } } } ] }, "examples": { "success": { "$ref": "#/components/examples/webhooks.examples.verify-code-success-event" } } } } }, "responses": { "200": { "$ref": "#/components/responses/webhook-200" }, "400": { "$ref": "#/components/responses/webhook-400" }, "401": { "$ref": "#/components/responses/webhook-401" }, "403": { "$ref": "#/components/responses/webhook-403" }, "404": { "$ref": "#/components/responses/webhook-404" }, "500": { "$ref": "#/components/responses/webhook-500" } } } }, "webhooks.verify-code-failed": { "post": { "summary": "C\u00f3digo de verifica\u00e7\u00e3o falhou", "description": "O evento `verify_code.failed` \u00e9 acionado quando a entrega do c\u00f3digo de verifica\u00e7\u00e3o falhou em todos os canais da estrat\u00e9gia de roteamento.\n\n[Notifica\u00e7\u00f5es de webhook](/#tag/notifications)", "tags": [ "verify-codes" ], "operationId": "webhooks.verify-code-failed", "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/webhook.event" }, { "properties": { "name": { "enum": [ "verify_code.failed" ] }, "data": { "$ref": "#/components/schemas/schema.webhooks.verify-code-data" } } } ] }, "examples": { "failed": { "$ref": "#/components/examples/webhooks.examples.verify-code-failed-event" } } } } }, "responses": { "200": { "$ref": "#/components/responses/webhook-200" }, "400": { "$ref": "#/components/responses/webhook-400" }, "401": { "$ref": "#/components/responses/webhook-401" }, "403": { "$ref": "#/components/responses/webhook-403" }, "404": { "$ref": "#/components/responses/webhook-404" }, "500": { "$ref": "#/components/responses/webhook-500" } } } }, "webhooks.verify-code-channel-updated": { "post": { "summary": "Canal do c\u00f3digo de verifica\u00e7\u00e3o atualizado", "description": "O evento `verify_code.channel.updated` \u00e9 acionado quando o status do c\u00f3digo de verifica\u00e7\u00e3o muda durante o processamento.\n\n[Notifica\u00e7\u00f5es de webhook](/#tag/notifications)", "tags": [ "verify-codes" ], "operationId": "webhooks.verify-code-channel-updated", "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/webhook.event" }, { "properties": { "name": { "enum": [ "verify_code.channel.updated" ] }, "data": { "$ref": "#/components/schemas/schema.webhooks.verify-code-data" } } } ] }, "examples": { "updated": { "$ref": "#/components/examples/webhooks.examples.verify-code-channel-updated-event" } } } } }, "responses": { "200": { "$ref": "#/components/responses/webhook-200" }, "400": { "$ref": "#/components/responses/webhook-400" }, "401": { "$ref": "#/components/responses/webhook-401" }, "403": { "$ref": "#/components/responses/webhook-403" }, "404": { "$ref": "#/components/responses/webhook-404" }, "500": { "$ref": "#/components/responses/webhook-500" } } } }, "webhooks.verify-code-channel-sent": { "post": { "summary": "Canal do c\u00f3digo de verifica\u00e7\u00e3o enviado", "description": "O evento `verify_code.channel.sent` \u00e9 acionado quando o c\u00f3digo de verifica\u00e7\u00e3o foi enviado atrav\u00e9s de um canal espec\u00edfico.\n\n[Notifica\u00e7\u00f5es de webhook](/#tag/notifications)", "tags": [ "verify-codes" ], "operationId": "webhooks.verify-code-channel-sent", "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/webhook.event" }, { "properties": { "name": { "enum": [ "verify_code.channel.sent" ] }, "data": { "$ref": "#/components/schemas/schema.webhooks.verify-code-channel-data" } } } ] }, "examples": { "sent": { "$ref": "#/components/examples/webhooks.examples.verify-code-channel-sent-event" } } } } }, "responses": { "200": { "$ref": "#/components/responses/webhook-200" }, "400": { "$ref": "#/components/responses/webhook-400" }, "401": { "$ref": "#/components/responses/webhook-401" }, "403": { "$ref": "#/components/responses/webhook-403" }, "404": { "$ref": "#/components/responses/webhook-404" }, "500": { "$ref": "#/components/responses/webhook-500" } } } }, "webhooks.verify-code-channel-success": { "post": { "summary": "Canal do c\u00f3digo de verifica\u00e7\u00e3o bem-sucedido", "description": "O evento `verify_code.channel.success` \u00e9 acionado quando um canal espec\u00edfico processou com sucesso o c\u00f3digo de verifica\u00e7\u00e3o.\n\n[Notifica\u00e7\u00f5es de webhook](/#tag/notifications)", "tags": [ "verify-codes" ], "operationId": "webhooks.verify-code-channel-success", "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/webhook.event" }, { "properties": { "name": { "enum": [ "verify_code.channel.success" ] }, "data": { "$ref": "#/components/schemas/schema.webhooks.verify-code-channel-data" } } } ] }, "examples": { "success": { "$ref": "#/components/examples/webhooks.examples.verify-code-channel-success-event" } } } } }, "responses": { "200": { "$ref": "#/components/responses/webhook-200" }, "400": { "$ref": "#/components/responses/webhook-400" }, "401": { "$ref": "#/components/responses/webhook-401" }, "403": { "$ref": "#/components/responses/webhook-403" }, "404": { "$ref": "#/components/responses/webhook-404" }, "500": { "$ref": "#/components/responses/webhook-500" } } } }, "webhooks.verify-code-channel-failed": { "post": { "summary": "Canal do c\u00f3digo de verifica\u00e7\u00e3o falhou", "description": "O evento `verify_code.channel.failed` \u00e9 acionado quando um canal espec\u00edfico falhou ao processar o c\u00f3digo de verifica\u00e7\u00e3o.\n\n[Notifica\u00e7\u00f5es de webhook](/#tag/notifications)", "tags": [ "verify-codes" ], "operationId": "webhooks.verify-code-channel-failed", "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/webhook.event" }, { "properties": { "name": { "enum": [ "verify_code.channel.failed" ] }, "data": { "$ref": "#/components/schemas/schema.webhooks.verify-code-channel-data" } } } ] }, "examples": { "failed": { "$ref": "#/components/examples/webhooks.examples.verify-code-channel-failed-event" } } } } }, "responses": { "200": { "$ref": "#/components/responses/webhook-200" }, "400": { "$ref": "#/components/responses/webhook-400" }, "401": { "$ref": "#/components/responses/webhook-401" }, "403": { "$ref": "#/components/responses/webhook-403" }, "404": { "$ref": "#/components/responses/webhook-404" }, "500": { "$ref": "#/components/responses/webhook-500" } } } } }, "components": { "securitySchemes": { "token": { "type": "apiKey", "in": "header", "name": "X-LOX24-AUTH-TOKEN", "description": "After logging in to your web account, you can create, deactivate or delete one or more API keys in the \"Settings\" under \"API Settings\" (please select a v2 Key)." } }, "parameters": { "filter.common.page": { "name": "page", "in": "query", "description": "Current page", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": 1, "minimum": 1, "maximum": 1000000 }, "style": "form", "explode": false, "allowReserved": false }, "filter.messages.uuid.array": { "name": "uuid[]", "in": "query", "description": "Find many SMS by the unique IDs", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/property.common.uuid" } }, "style": "form", "explode": true, "allowReserved": false }, "filter.messages.uuid.exact": { "name": "uuid", "in": "query", "description": "Find one SMS by the unique ID", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.common.uuid" }, "style": "form", "explode": false, "allowReserved": false }, "order.common.created_at": { "name": "_order[created_at]", "in": "query", "description": "Sort by timestamp when the entity was created", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/order.ordering" }, "style": "form", "explode": false, "allowReserved": false }, "order.messages.delivery_at": { "name": "_order[delivery_at]", "in": "query", "description": "Sort by timestamp when the message was/should transmitted to the mobile network", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/order.ordering" }, "style": "form", "explode": false, "allowReserved": false }, "order.common.processed_at": { "name": "_order[processed_at]", "in": "query", "description": "Sort by timestamp when the entity was changed last time", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/order.ordering" }, "style": "form", "explode": false, "allowReserved": false }, "order.bulks.msg_total_count": { "name": "_order[msg_total_count]", "in": "query", "description": "Sort by the total counts of the related SMS", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/order.ordering" }, "style": "form", "explode": false, "allowReserved": false }, "filter.messages.text.partial": { "name": "text", "in": "query", "description": "*Partial* case-insensitive text filter SMS by the message text", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.sms.text" }, "style": "form", "explode": false, "allowReserved": false }, "filter.messages.sender_id.partial": { "name": "sender_id", "in": "query", "description": "*Partial* text case-insensitive filter SMS by the sender number or text", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.messages.sender_id" }, "style": "form", "explode": false, "allowReserved": false }, "filter.bulks.status_code.exact": { "name": "status_code", "in": "query", "description": "*Exact* filter Bulks by the status code", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.bulks.status_code" }, "style": "form", "explode": false, "allowReserved": false }, "filter.bulks.status_code.array": { "name": "status_code[]", "in": "query", "description": "*Exact* filter Bulks by the statuses codes", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/property.bulks.status_code" } }, "style": "form", "explode": true, "allowReserved": false }, "filter.common.created_at.exact": { "name": "created_at", "in": "query", "description": "*Exact* filter entities by the creation timestamp", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.common.created_at" }, "style": "form", "explode": false, "allowReserved": false }, "filter.common.created_at.array": { "name": "created_at[]", "in": "query", "description": "*Exact* and *range* filter entities by the creation timestamps", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/property.common.created_at" } }, "style": "form", "explode": true, "allowReserved": false }, "filter.messages.delivery_at.exact": { "name": "delivery_at", "in": "query", "description": "*Exact* filter SMS by the delivery timestamp", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.messages.delivery_at" }, "style": "form", "explode": false, "allowReserved": false }, "filter.messages.delivery_at.array": { "name": "delivery_at[]", "in": "query", "description": "*Exact* and *range* filter SMS by the delivery timestamps", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/property.messages.delivery_at" } }, "style": "form", "explode": true, "allowReserved": false }, "filter.common.processed_at.exact": { "name": "processed_at", "in": "query", "description": "*Exact* filter entities by the last changes timestamp", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.messages.processed_at" }, "style": "form", "explode": false, "allowReserved": false }, "filter.common.processed_at.array": { "name": "processed_at[]", "in": "query", "description": "*Exact* and *range* filter entities by the last changes timestamps", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/property.messages.processed_at" } }, "style": "form", "explode": true, "allowReserved": false }, "filter.bulks.msg_total_count.exact": { "name": "msg_total_count", "in": "query", "description": "*Exact* filter Bulks by the total count of the SMS in the bulk", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.bulks.msg_total_count" }, "style": "form", "explode": false, "allowReserved": false }, "filter.bulks.msg_total_count.array": { "name": "msg_total_count[]", "in": "query", "description": "*Exact* and *range* filter Bulks by the total counts of the related SMS", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/property.bulks.msg_total_count" } }, "style": "form", "explode": true, "allowReserved": false }, "filter.messages.source.exact": { "name": "source", "in": "query", "description": "*Exact* filter SMS by the sources", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "integer" }, "style": "form", "explode": false, "allowReserved": false }, "filter.messages.source.array": { "name": "source[]", "in": "query", "description": "*Exact* and *range* filter SMS by the sources", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "type": "integer" } }, "style": "form", "explode": true, "allowReserved": false }, "filter.common.key_id.exact": { "name": "key_id", "in": "query", "description": "*Exact* filter entities by the used API key", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.common.key_id" }, "style": "form", "explode": false, "allowReserved": false }, "filter.common.key_id.array": { "name": "key_id[]", "in": "query", "description": "*Exact* filter entities by the used API keys", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/property.common.key_id" } }, "style": "form", "explode": true, "allowReserved": false }, "filter.messages.is_unicode.boolean": { "name": "is_unicode", "in": "query", "description": "*Boolean* filter SMS by the `is_unicode` field to distinguish between GSM and Unicode messages", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "boolean" }, "style": "form", "explode": false, "allowReserved": false }, "filter.messages.is_dryrun.boolean": { "name": "is_dryrun", "in": "query", "description": "*Boolean* filter Bulks by the `is_dryrun` field to distinguish type of the Bulk", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "boolean" }, "style": "form", "explode": false, "allowReserved": false }, "filter.messages.is_unicode.exists": { "name": "exists[is_unicode]", "in": "query", "description": "*Boolean* and *exists* filter Bulks by the `is_unicode` field to distinguish between GSM and Unicode messages", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "boolean" }, "style": "form", "explode": false, "allowReserved": false }, "path.bulks.id": { "name": "id", "in": "path", "description": "Bulk ID", "required": true, "deprecated": false, "schema": { "$ref": "#/components/schemas/property.common.uuid" }, "style": "simple", "explode": false }, "order.accounting.amount": { "name": "_order[amount]", "in": "query", "description": "Ordenar por valor do documento", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/order.ordering" }, "style": "form", "explode": false, "allowReserved": false }, "filter.accounting.status.exact": { "name": "status", "in": "query", "description": "Filtro *exato* por status do documento", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "integer", "enum": [ 0, 1, 2 ] }, "style": "form", "explode": false, "allowReserved": false }, "filter.accounting.payment_type.exact": { "name": "paymentType", "in": "query", "description": "Filtro *exato* por tipo de pagamento", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "integer", "enum": [ 1, 6, 7, 8, 91, 92 ] }, "style": "form", "explode": false, "allowReserved": false }, "filter.accounting.id.exact": { "name": "id", "in": "query", "description": "Filtro *exato* por ID do documento", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.accounting.id" }, "style": "form", "explode": false, "allowReserved": false }, "filter.accounting.id.array": { "name": "id[]", "in": "query", "description": "Filtro *exato* por m\u00faltiplos IDs de documentos", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/property.accounting.id" } }, "style": "form", "explode": true, "allowReserved": false }, "filter.accounting.created_at.exact": { "name": "created_at", "in": "query", "description": "Filtro *exato* por timestamp de cria\u00e7\u00e3o", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.accounting.created_at" }, "style": "form", "explode": false, "allowReserved": false }, "filter.accounting.created_at.array": { "name": "created_at[]", "in": "query", "description": "Filtro *exato* e por *intervalo* de timestamps de cria\u00e7\u00e3o", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/property.accounting.created_at" } }, "style": "form", "explode": true, "allowReserved": false }, "filter.accounting.amount.exact": { "name": "amount", "in": "query", "description": "Filtro por *intervalo* do valor do documento (valor real, ex. 24.63 para 24.63 EUR)", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.accounting.amount" }, "style": "form", "explode": false, "allowReserved": false }, "filter.accounting.amount.array": { "name": "amount[]", "in": "query", "description": "Filtro *exato* e por *intervalo* dos valores do documento (valores reais, ex. 24.63 para 24.63 EUR)", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/property.accounting.amount" } }, "style": "form", "explode": true, "allowReserved": false }, "filter.accounting.paid_at.exact": { "name": "paid_at", "in": "query", "description": "Filtro *exato* por timestamp de pagamento", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.accounting.paid_at" }, "style": "form", "explode": false, "allowReserved": false }, "filter.accounting.paid_at.array": { "name": "paid_at[]", "in": "query", "description": "Filtro *exato* e por *intervalo* de timestamps de pagamento", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/property.accounting.paid_at" } }, "style": "form", "explode": true, "allowReserved": false }, "filter.accounting.paid_at.exists": { "name": "exists[paid_at]", "in": "query", "description": "Filtro de *exist\u00eancia* para status de pagamento: `true` = documentos pagos, `false` = documentos n\u00e3o pagos", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "boolean" }, "style": "form", "explode": false, "allowReserved": false }, "path.accounting.invoice_id": { "name": "id", "in": "path", "description": "ID da fatura", "required": true, "deprecated": false, "schema": { "$ref": "#/components/schemas/property.accounting.id" }, "style": "simple", "explode": false }, "path.accounting.credit_note_id": { "name": "id", "in": "path", "description": "ID da nota de cr\u00e9dito", "required": true, "deprecated": false, "schema": { "$ref": "#/components/schemas/property.accounting.id" }, "style": "simple", "explode": false }, "filter.accounting.payment_status.exact": { "name": "status", "in": "query", "description": "Filtro *exato* por status do pagamento", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "integer", "enum": [ 0, 10, 20, 100, 200, 300, 400, 1000 ] }, "style": "form", "explode": false, "allowReserved": false }, "filter.accounting.payments_payment_type.exact": { "name": "type", "in": "query", "description": "Filtro *exato* por tipo de m\u00e9todo de pagamento", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "integer", "enum": [ 1, 6, 7, 8, 91, 92 ] }, "style": "form", "explode": false, "allowReserved": false }, "filter.accounting.payment_id.exact": { "name": "id", "in": "query", "description": "Filtro *exato* por ID da tentativa de pagamento", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.accounting.payment_id" }, "style": "form", "explode": false, "allowReserved": false }, "filter.accounting.payment_id.array": { "name": "id[]", "in": "query", "description": "Filtro *exato* por m\u00faltiplos IDs de tentativas de pagamento", "required": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/property.accounting.payment_id" } }, "style": "form", "explode": true, "allowReserved": false }, "filter.accounting.payment_created_at.exact": { "name": "created_at", "in": "query", "description": "Filtro *exato* por timestamp de cria\u00e7\u00e3o", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.accounting.payment_created_at" }, "style": "form", "explode": false, "allowReserved": false }, "filter.accounting.payment_created_at.array": { "name": "created_at[]", "in": "query", "description": "Filtro *exato* e por *intervalo* de timestamps de cria\u00e7\u00e3o", "required": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/property.accounting.payment_created_at" } }, "style": "form", "explode": true, "allowReserved": false }, "path.accounting.payment_id": { "name": "id", "in": "path", "description": "ID da tentativa de pagamento", "required": true, "schema": { "$ref": "#/components/schemas/property.accounting.payment_id" }, "style": "simple", "explode": false }, "filter.fraud-check.id.exact": { "name": "id", "in": "query", "description": "*Exact* filter by Fraud request ID", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.common.uuid" }, "style": "form", "explode": false, "allowReserved": false }, "filter.fraud-check.id.array": { "name": "id[]", "in": "query", "description": "*Exact* filter by Fraud request ID", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/property.common.uuid" } }, "style": "form", "explode": true, "allowReserved": false }, "filter.common.callback_data.partial": { "name": "callback_data", "in": "query", "description": "*Partitial* filter entities by the `callback_data`", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.common.callback_data" }, "style": "form", "explode": false, "allowReserved": false }, "filter.fraud-check.request_phone.phone.partial": { "name": "request_phone.phone", "in": "query", "description": "*Partial* filter by the request's phone value", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "pattern": "^\\+?[1-9]\\d{0,14}$", "minLength": 1, "maxLength": 16 }, "style": "form", "explode": false, "allowReserved": false }, "filter.fraud-check.request_email.email.partial": { "name": "request_email.email", "in": "query", "description": "*Partial* filter by the request's email value", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "minLength": 1, "maxLength": 500 }, "style": "form", "explode": false, "allowReserved": false }, "filter.fraud-check.request_ip.ip.partial": { "name": "request_ip.ip", "in": "query", "description": "*Partial* filter by the request's IP value", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "minLength": 1, "maxLength": 39 }, "style": "form", "explode": false, "allowReserved": false }, "filter.fraud-check.status_code.exact": { "name": "status_code", "in": "query", "description": "*Exact* filter Fraud requests by the status code", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.fraud-check.status_code" }, "style": "form", "explode": false, "allowReserved": false }, "filter.fraud-check.status_code.array": { "name": "status_code[]", "in": "query", "description": "*Exact* filter Fraud requests by the status codes", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/property.fraud-check.status_code" } }, "style": "form", "explode": true, "allowReserved": false }, "path.fraud-check.id": { "name": "id", "in": "path", "description": "Fraud Check request ID", "required": true, "deprecated": false, "schema": { "$ref": "#/components/schemas/property.common.uuid" }, "style": "simple", "explode": false }, "path.groups.id": { "name": "id", "in": "path", "description": "ID do grupo", "required": true, "deprecated": false, "schema": { "$ref": "#/components/schemas/property.group.id" }, "style": "simple", "explode": false }, "order.incomings.received_at": { "name": "_order[received_at]", "in": "query", "description": "Sort by timestamp when the Incoming sms was received", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/order.ordering" }, "style": "form", "explode": false, "allowReserved": false }, "filter.incomings.from": { "name": "from", "in": "query", "description": "*Partial* case-insensitive text filter by sender's phone number", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "pattern": "^\\+?[1-9]\\d{0,14}$", "minLength": 1, "maxLength": 16 }, "style": "form", "explode": false, "allowReserved": false }, "filter.incomings.to": { "name": "to", "in": "query", "description": "*Partial* case-insensitive text filter by inbound's phone number", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "pattern": "^\\+?[1-9]\\d{0,14}$", "minLength": 1, "maxLength": 16 }, "style": "form", "explode": false, "allowReserved": false }, "filter.incomings.msg_uuid": { "name": "msg_uuid", "in": "query", "description": "*Exact* filter by initial SMS ID", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.common.uuid" }, "style": "form", "explode": false, "allowReserved": false }, "filter.incomings.msg_uuid.array": { "name": "msg_uuid[]", "in": "query", "description": "*Exact* filter by initial SMS ID", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/property.common.uuid" } }, "style": "form", "explode": true, "allowReserved": false }, "path.incomings.id": { "name": "uuid", "in": "path", "required": true, "deprecated": false, "schema": { "$ref": "#/components/schemas/property.common.uuid" }, "description": "Incoming message ID" }, "path.phones.id": { "name": "id", "in": "path", "description": "Identificador do telefone", "required": true, "deprecated": false, "schema": { "$ref": "#/components/schemas/property.phone.id" }, "style": "simple", "explode": false }, "filter.short_link.name.partial": { "name": "name", "in": "query", "description": "Filtrar links curtos por nome (correspond\u00eancia parcial)", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "minLength": 1 }, "style": "form", "explode": false, "allowReserved": false }, "filter.short_link_request.url.partial": { "name": "url", "in": "query", "description": "*Partial* case-insensitive text filter by a destination URL", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "minLength": 1 }, "style": "form", "explode": false, "allowReserved": false }, "filter.short_link_request.type.exact": { "name": "type", "in": "query", "description": "*Exact* filter short links by type (exact match)", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.short_link_requests.type" }, "style": "form", "explode": false, "allowReserved": false }, "filter.short_link_request.type.array": { "name": "type[]", "in": "query", "description": "*Range* filter short links by type (array of values)", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/property.short_link_requests.type" } }, "style": "form", "explode": true, "allowReserved": false }, "path.short_link_campaigns.code": { "name": "code", "in": "path", "description": "short_link_campaigns code", "required": true, "deprecated": false, "schema": { "type": "string", "minLength": 1, "maxLength": 36 }, "style": "simple", "explode": false }, "order.short_link_request.date": { "name": "_order[date]", "in": "query", "description": "Sort a list by 'date' property", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/order.ordering" }, "style": "form", "explode": false, "allowReserved": false }, "filter.short_link_request.ip.partial": { "name": "ip", "in": "query", "description": "*Partial* case-insensitive text filter by a IP address", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "ipv4", "maxLength": 15 }, "style": "form", "explode": false, "allowReserved": false }, "filter.short_link_request.user_agent.partial": { "name": "user_agent", "in": "query", "description": "*Partial* filter short links by user agent (partial match)", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "minLength": 1 }, "style": "form", "explode": false, "allowReserved": false }, "filter.common.country.exact": { "name": "country", "in": "query", "description": "*Exact* filter entities by the country code", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.common.country_code" }, "style": "form", "explode": false, "allowReserved": false }, "filter.common.country.array": { "name": "country[]", "in": "query", "description": "*Exact* filter entities by the country codes", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/property.common.country_code" } }, "style": "form", "explode": true, "allowReserved": false }, "filter.short_link_request.referer.partial": { "name": "referer", "in": "query", "description": "*Partial* case-insensitive text filter by a referer", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "minLength": 1 }, "style": "form", "explode": false, "allowReserved": false }, "filter.short_link_request.date.exact": { "name": "date", "in": "query", "description": "*Exact* filter short link requests by exact date", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.short_link_requests.date" }, "style": "form", "explode": false, "allowReserved": false }, "filter.short_link_request.date.array": { "name": "date[]", "in": "query", "description": "*Exact* filter short link requests by date (array of values)", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/property.short_link_requests.date" } }, "style": "form", "explode": true, "allowReserved": false }, "filter.short_link_request.browser.partial": { "name": "browser", "in": "query", "description": "*Partial* case-insensitive text filter by a browser name", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "minLength": 1 }, "style": "form", "explode": false, "allowReserved": false }, "filter.short_link_request.os.partial": { "name": "os", "in": "query", "description": "*Partial* case-insensitive text filter by a operation system name", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "minLength": 1, "maxLength": 255 }, "style": "form", "explode": false, "allowReserved": false }, "filter.short_link_request.os_version.partial": { "name": "os_version", "in": "query", "description": "*Partial* case-insensitive text filter by a operation system version", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "minLength": 1, "maxLength": 255 }, "style": "form", "explode": false, "allowReserved": false }, "filter.short_link_request.software_type.partial": { "name": "software_type", "in": "query", "description": "*Partial* case-insensitive text filter by a software type", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "minLength": 1, "maxLength": 255 }, "style": "form", "explode": false, "allowReserved": false }, "filter.short_link_request.hardware_type.partial": { "name": "hardware_type", "in": "query", "description": "*Partial* case-insensitive text filter by a hardware type", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "minLength": 1, "maxLength": 255 }, "style": "form", "explode": false, "allowReserved": false }, "filter.short_link_request.date.between": { "name": "date[between]", "in": "query", "description": "*Range* filter short link requests by date range", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.short_link_requests.date" }, "style": "form", "explode": false, "allowReserved": false }, "filter.short_link_request.date.gt": { "name": "date[gt]", "in": "query", "description": "Filtrar solicita\u00e7\u00f5es de links curtos por data maior que", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.short_link_requests.date" }, "style": "form", "explode": false, "allowReserved": false }, "filter.short_link_request.date.gte": { "name": "date[gte]", "in": "query", "description": "Filtrar solicita\u00e7\u00f5es de links curtos por data maior ou igual", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.short_link_requests.date" }, "style": "form", "explode": false, "allowReserved": false }, "filter.short_link_request.date.lt": { "name": "date[lt]", "in": "query", "description": "Filtrar solicita\u00e7\u00f5es de links curtos por data menor que", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.short_link_requests.date" }, "style": "form", "explode": false, "allowReserved": false }, "filter.short_link_request.date.lte": { "name": "date[lte]", "in": "query", "description": "Filtrar solicita\u00e7\u00f5es de links curtos por data menor ou igual", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.short_link_requests.date" }, "style": "form", "explode": false, "allowReserved": false }, "filter.short_link_request.browser_version.partial": { "name": "browser_version", "in": "query", "description": "*Partial* case-insensitive text filter by a browser version", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "minLength": 1, "maxLength": 255 }, "style": "form", "explode": false, "allowReserved": false }, "path.short_link_requests.id": { "name": "id", "in": "path", "description": "ID da solicita\u00e7\u00e3o de link curto", "required": true, "deprecated": false, "schema": { "$ref": "#/components/schemas/property.short_link_requests.id" }, "style": "simple", "explode": false }, "path.short_links.shortCode": { "name": "shortCode", "in": "path", "required": true, "deprecated": false, "explode": false, "schema": { "type": "string", "minLength": 1, "maxLength": 36 }, "description": "C\u00f3digo do link curto" }, "path.sms.uuid": { "name": "uuid", "in": "path", "required": true, "deprecated": false, "schema": { "$ref": "#/components/schemas/property.common.uuid" }, "description": "SMS ID (`uuid`)" }, "order.common.updated_at": { "name": "_order[updated_at]", "in": "query", "description": "Sort a list by 'updated_at' property", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/order.ordering" }, "style": "form", "explode": false, "allowReserved": false }, "filter.common.updated_at.exact": { "name": "updated_at", "in": "query", "description": "*Exact* filter entities by the last update timestamp", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.common.updated_at" }, "style": "form", "explode": false, "allowReserved": false }, "filter.common.updated_at.array": { "name": "updated_at[]", "in": "query", "description": "*Exact* and *range* filter entities by the last update timestamps", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/property.common.updated_at" } }, "style": "form", "explode": true, "allowReserved": false }, "order.messages.gateway_sent_at": { "name": "_order[gateway_sent_at]", "in": "query", "description": "Sort by timestamp when the message was transmitted to the mobile network", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/order.ordering" }, "style": "form", "explode": false, "allowReserved": false }, "filter.messages.is_sent.boolean": { "name": "is_sent", "in": "query", "description": "*Boolean* filter SMS by the `is_sent` field to distinguish between already sent and not yet sent sms", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "boolean" }, "style": "form", "explode": false, "allowReserved": false }, "filter.messages.iso2.exact": { "name": "iso2", "in": "query", "description": "*Exact* filter SMS by the phone's country ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.common.country_code" }, "style": "form", "explode": false, "allowReserved": false }, "filter.messages.iso2.array": { "name": "iso2[]", "in": "query", "description": "*Exact* filter SMS by the phone's countries ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/property.common.country_code" } }, "style": "form", "explode": true, "allowReserved": false }, "filter.messages.dlr_code.exact": { "name": "dlr_code", "in": "query", "description": "*Exact* filter SMS by the delivery report status", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.sms.dlr_code" }, "style": "form", "explode": false, "allowReserved": false }, "filter.messages.dlr_code.array": { "name": "dlr_code[]", "in": "query", "description": "*Exact* filter SMS by the delivery report statuses", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/property.sms.dlr_code" } }, "style": "form", "explode": true, "allowReserved": false }, "filter.messages.status_code.exact": { "name": "status_code", "in": "query", "description": "*Exact* filter SMS by the status code", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.sms.status_code" }, "style": "form", "explode": false, "allowReserved": false }, "filter.messages.status_code.array": { "name": "status_code[]", "in": "query", "description": "*Exact* filter SMS by the statuses codes", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/property.sms.status_code" } }, "style": "form", "explode": true, "allowReserved": false }, "filter.messages.gateway_sent_at.exact": { "name": "gateway_sent_at", "in": "query", "description": "*Exact* filter SMS by the send to gateway timestamp", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.sms.gateway_sent_at" }, "style": "form", "explode": false, "allowReserved": false }, "filter.messages.gateway_sent_at.array": { "name": "gateway_sent_at[]", "in": "query", "description": "*Exact* and *range* filter SMS by send to gateway timestamps", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/property.sms.gateway_sent_at" } }, "style": "form", "explode": true, "allowReserved": false }, "filter.messages.chars_count.exact": { "name": "chars_count", "in": "query", "description": "*Range* filter SMS by the message chars count", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "integer", "minimum": 1 }, "style": "form", "explode": false, "allowReserved": false }, "filter.messages.chars_count.array": { "name": "chars_count[]", "in": "query", "description": "*Exact* and *range* filter SMS by the message chars count", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "type": "integer", "minimum": 1 } }, "style": "form", "explode": true, "allowReserved": false }, "filter.messages.parts_count.exact": { "name": "parts_count", "in": "query", "description": "*Exact* filter SMS by the message parts count", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.sms.parts_count" }, "style": "form", "explode": false, "allowReserved": false }, "filter.messages.parts_count.array": { "name": "parts_count[]", "in": "query", "description": "*Exact* and *range* filter SMS by the message parts count", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/property.sms.parts_count" } }, "style": "form", "explode": true, "allowReserved": false }, "filter.messages.bulk.exact": { "name": "bulk", "in": "query", "description": "*Exact* filter SMS by the Bulk", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.common.uuid" }, "style": "form", "explode": false, "allowReserved": false }, "filter.messages.bulk.array": { "name": "bulk[]", "in": "query", "description": "*Exact* and *range* filter SMS by the Bulk", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/property.common.uuid" } }, "style": "form", "explode": true, "allowReserved": false }, "filter.messages.phone.partial": { "name": "phone", "in": "query", "description": "*Partial* text filter SMS by the phone number", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "pattern": "^\\+?[0-9]{1,15}$", "minLength": 1, "maxLength": 16 }, "style": "form", "explode": false, "allowReserved": false }, "filter.messages.ip.partial": { "name": "ip", "in": "query", "description": "*Partial* text filter SMS by the IP which created the message", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.common.ip_read" }, "style": "form", "explode": false, "allowReserved": false }, "filter.messages.callback_data.exact": { "name": "callback_data", "in": "query", "description": "*Exact* filter SMS by `callback_data` property", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/property.common.callback_data" }, "style": "form", "explode": false, "allowReserved": false }, "filter.messages.callback_data.array": { "name": "callback_data[]", "in": "query", "description": "*Exact* filter SMS by `callback_data` property", "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/property.common.callback_data" } }, "style": "form", "explode": true, "allowReserved": false }, "filter.blocked_numbers.number.exact": { "name": "number", "in": "query", "description": "Filtrar por n\u00famero de telefone exato", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "$ref": "#/components/schemas/property.blocked_numbers.number" }, "style": "form", "explode": false, "allowReserved": false }, "filter.blocked_numbers.type.exact": { "name": "type", "in": "query", "description": "Filtrar por tipo exato de n\u00famero bloqueado", "required": false, "deprecated": false, "allowEmptyValue": true, "schema": { "$ref": "#/components/schemas/property.blocked_numbers.type" }, "style": "form", "explode": false, "allowReserved": false }, "path.blocked_numbers.id": { "name": "id", "in": "path", "description": "ID do n\u00famero bloqueado", "required": true, "deprecated": false, "schema": { "$ref": "#/components/schemas/property.blocked_numbers.id" }, "style": "simple", "explode": false }, "path.verify_codes.id": { "name": "id", "in": "path", "description": "UUID do pedido de c\u00f3digo de verifica\u00e7\u00e3o", "required": true, "deprecated": false, "schema": { "$ref": "#/components/schemas/property.common.uuid" }, "style": "simple", "explode": false } }, "schemas": { "property.common.uuid": { "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "type": "string", "description": "Unique entity UUID" }, "order.ordering": { "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "description": "Sort order direction (ascending or descending)" }, "property.sms.text": { "type": "string", "description": "The message text can have a length of up to 1530 characters. With a Unicode SMS, the maximum character length is reduced to 670 characters. Internal encoding is UTF-8." }, "property.messages.sender_id": { "type": "string", "pattern": "^(\\+?[1-9]\\d{0,14}|[a-zA-Z0-9 ]{1,11})$", "description": "Sender-ID of the message. Can be a number (up to 15 digits) or a text (up to 11 character).\nIn case of a number please use preferentially E.164 phone number format. A sender of text may contain spaces but no\nother special characters. Please note that some countries do not support own sender IDs or do require pre-registration. Our system automatically tries to detect whether a sender ID is a text or a phone number. Avoid special characters in a number and enter it the same way as it would be dialed on a phone.\n\nPara mensagens de voz (text2speech, text2speech_ssml): se sender_id n\u00e3o estiver em conformidade com o formato E.164 (por exemplo, sem o prefixo +, contendo caracteres n\u00e3o num\u00e9ricos), a mensagem ser\u00e1 enviada a partir do n\u00famero padr\u00e3o do sistema +493075435114. Alguns provedores de telefonia downstream podem substituir ou n\u00e3o respeitar o n\u00famero de remetente definido pelo usu\u00e1rio \u2014 o identificador de chamada real apresentado ao destinat\u00e1rio depende das capacidades do provedor.", "examples": [ "+491701234567", "491701234567", "MyCompany", "SMS Service" ] }, "property.bulks.status_code": { "type": "integer", "enum": [ 0, 5, 10, 15, 20, 201 ], "description": "Bulk's status:\n- `0` - new and not processed\n- `5` - bulks in progress\n- `10` - bulks was successfully processed\n- `15` - bulk's processing was canceled by the user\n- `20` - system error\n- `201` - error: no recipients found" }, "property.common.created_at": { "type": "integer", "minimum": 0, "description": "Timestamp when the entity was added to the system by the user" }, "property.messages.delivery_at": { "type": "integer", "minimum": 0, "description": "Timestamp de entrega programada" }, "property.messages.processed_at": { "type": [ "integer", "null" ], "minimum": 0, "description": "Timestamp of last changes" }, "property.bulks.msg_total_count": { "type": "integer", "minimum": 0, "description": "Count of the messages created by the bulk" }, "property.common.key_id": { "type": "integer", "minimum": 1, "description": "Identificador da chave API" }, "property._jsonld_context": { "readOnly": true, "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ], "description": "JSON-LD context" }, "property._jsonld_id": { "readOnly": true, "type": "string", "description": "JSON-LD ID" }, "property._jsonld_type": { "readOnly": true, "type": "string", "description": "JSON-LD type" }, "hydra.totalItems": { "type": "integer", "minimum": 0, "description": "Total number of items in the collection" }, "property.common.ip_read": { "type": "string", "format": "ipv4", "description": "IP address of the host which sent request", "example": "192.168.1.1" }, "property.messages.is_unicode": { "type": [ "boolean", "null" ], "description": "True se a mensagem cont\u00e9m caracteres Unicode, False caso contr\u00e1rio" }, "property.messages.is_dryrun": { "type": "boolean", "description": "Type of the bulk 'dryrun' or not" }, "property.common.callback_data": { "maxLength": 36, "type": [ "string", "null" ], "description": "String which will be send back to your endpoint. E.g. it can be usable to pass your system message id." }, "property.messages.service_code": { "enum": [ "direct", "text2speech", "text2speech_ssml" ], "description": "C\u00f3digo de servi\u00e7o ou gateway" }, "property.messages.source": { "type": [ "integer", "null" ], "description": "Fonte ou origem da mensagem" }, "property.messages.voice_lang": { "enum": [ "EN", "DE", "FR", "IT", "ES", "PL", "NL", "RO", "PT", "CS", "HU", "SV", "DA", "FI", "SK", "HR", "TR", "RU", "BG", "UK", null ], "type": [ "string", "null" ], "description": "Idioma da mensagem de voz. Valores poss\u00edveis: `null` ([detec\u00e7\u00e3o autom\u00e1tica](/info/ssml-language-detection/)) ou um dos seguintes: EN (ingl\u00eas), DE (alem\u00e3o), FR (franc\u00eas), IT (italiano), ES (espanhol), PL (polaco), NL (neerland\u00eas), RO (romeno), PT (portugu\u00eas), CS (checo), HU (h\u00fangaro), SV (sueco), DA (dinamarqu\u00eas), FI (finland\u00eas), SK (eslovaco), HR (croata), TR (turco), RU (russo), BG (b\u00falgaro), UK (ucraniano)." }, "property.messages.is_text_deleted": { "type": "boolean", "description": "True se o texto da mensagem foi exclu\u00eddo, False caso contr\u00e1rio" }, "property.bulks.msg_total_cost": { "type": "number", "minimum": 0, "description": "Cost of the messages created by the bulk" }, "schema.bulks.jsonld-bulk_read_status": { "type": "object", "description": "Bulk SMS status summary (JSON-LD)", "deprecated": false, "readOnly": true, "properties": { "@id": { "$ref": "#/components/schemas/property._jsonld_id" }, "@type": { "$ref": "#/components/schemas/property._jsonld_type" }, "uuid": { "$ref": "#/components/schemas/property.common.uuid" }, "delivery_at": { "$ref": "#/components/schemas/property.messages.delivery_at" }, "sender_id": { "$ref": "#/components/schemas/property.messages.sender_id" }, "status_code": { "$ref": "#/components/schemas/property.bulks.status_code" }, "msg_total_count": { "$ref": "#/components/schemas/property.bulks.msg_total_count" }, "created_at": { "$ref": "#/components/schemas/property.common.created_at" }, "processed_at": { "$ref": "#/components/schemas/property.messages.processed_at" }, "ip": { "$ref": "#/components/schemas/property.common.ip_read" }, "is_unicode": { "$ref": "#/components/schemas/property.messages.is_unicode" }, "is_dryrun": { "$ref": "#/components/schemas/property.messages.is_dryrun" }, "callback_data": { "$ref": "#/components/schemas/property.common.callback_data" }, "service_code": { "$ref": "#/components/schemas/property.messages.service_code" }, "key_id": { "oneOf": [ { "$ref": "#/components/schemas/property.common.key_id" }, { "type": "null" } ] }, "source": { "$ref": "#/components/schemas/property.messages.source" }, "voice_lang": { "$ref": "#/components/schemas/property.messages.voice_lang" }, "is_text_deleted": { "$ref": "#/components/schemas/property.messages.is_text_deleted" }, "msg_total_cost": { "$ref": "#/components/schemas/property.bulks.msg_total_cost" }, "requests": { "type": "string", "format": "iri-reference", "description": "URL to get the list of the bulk's messages requests" } } }, "schema.bulks-bulk_read_status": { "type": "object", "description": "Bulk SMS status summary", "deprecated": false, "readOnly": true, "properties": { "uuid": { "$ref": "#/components/schemas/property.common.uuid" }, "delivery_at": { "$ref": "#/components/schemas/property.messages.delivery_at" }, "sender_id": { "$ref": "#/components/schemas/property.messages.sender_id" }, "status_code": { "$ref": "#/components/schemas/property.bulks.status_code" }, "msg_total_count": { "$ref": "#/components/schemas/property.bulks.msg_total_count" }, "created_at": { "$ref": "#/components/schemas/property.common.created_at" }, "processed_at": { "$ref": "#/components/schemas/property.messages.processed_at" }, "ip": { "$ref": "#/components/schemas/property.common.ip_read" }, "is_unicode": { "$ref": "#/components/schemas/property.messages.is_unicode" }, "is_dryrun": { "$ref": "#/components/schemas/property.messages.is_dryrun" }, "callback_data": { "$ref": "#/components/schemas/property.common.callback_data" }, "service_code": { "$ref": "#/components/schemas/property.messages.service_code" }, "key_id": { "oneOf": [ { "$ref": "#/components/schemas/property.common.key_id" }, { "type": "null" } ] }, "source": { "$ref": "#/components/schemas/property.messages.source" }, "voice_lang": { "$ref": "#/components/schemas/property.messages.voice_lang" }, "is_text_deleted": { "$ref": "#/components/schemas/property.messages.is_text_deleted" }, "msg_total_cost": { "$ref": "#/components/schemas/property.bulks.msg_total_cost" }, "requests": { "type": "string", "format": "iri-reference", "description": "URL to get the list of the bulk's messages requests" } } }, "property.bulks.text": { "maxLength": 1785, "type": "string", "description": "Max text length is 1785 character. But don't forget that the final message text can have a length of up to 1530 characters. With a Unicode SMS, the maximum character length is reduced to 670 characters. Internal encoding is UTF-8." }, "property.common.phone_number": { "type": "string", "pattern": "^\\+[1-9]\\d{1,14}$", "minLength": 7, "maxLength": 16, "description": "Recipient (international) number:\n- +491701234567 (E.164)\n- 00491701234567\n- 491701234567\n- 01701234567 (if the account is registered in Germany) will be convert to +491701234567\n\nIf the number is not in an E.164 format then the service will convert it based on user's address.\nTo avoid problems with the converting please use E.164 preferentially.", "example": "+14155552671" }, "property.bulks.phones": { "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/property.common.phone_number" }, "description": "List of the recipients (international) numbers:\n- +491701234567 (E.164)\n- 00491701234567\n- 491701234567\n- 01701234567 (if the account is registered in Germany) will be convert to +491701234567\n\nIf the number is not in an E.164 format then the service will convert it based on user's address.\nTo avoid problems with the converting please use E.164 preferentially." }, "property.bulks.msg_groups": { "type": [ "array", "null" ], "items": { "type": "integer" }, "description": "List of the recipients groups" }, "schema.bulks-bulk_write": { "type": "object", "description": "Bulk SMS creation request payload", "deprecated": false, "additionalProperties": false, "properties": { "delivery_at": { "oneOf": [ { "$ref": "#/components/schemas/property.messages.delivery_at" }, { "type": "null" } ] }, "sender_id": { "$ref": "#/components/schemas/property.messages.sender_id" }, "text": { "$ref": "#/components/schemas/property.bulks.text" }, "phones": { "$ref": "#/components/schemas/property.bulks.phones" }, "msg_groups": { "$ref": "#/components/schemas/property.bulks.msg_groups" }, "is_unicode": { "$ref": "#/components/schemas/property.messages.is_unicode" }, "service_code": { "oneOf": [ { "$ref": "#/components/schemas/property.messages.service_code" }, { "type": "null" } ] }, "source": { "$ref": "#/components/schemas/property.messages.source" }, "voice_lang": { "$ref": "#/components/schemas/property.messages.voice_lang" }, "is_text_deleted": { "oneOf": [ { "$ref": "#/components/schemas/property.messages.is_text_deleted" }, { "type": "null" } ] } }, "required": [ "sender_id", "text" ], "anyOf": [ { "required": [ "phones" ] }, { "required": [ "msg_groups" ] } ] }, "schema.bulks.jsonld-bulk_read": { "type": "object", "description": "Bulk SMS details (JSON-LD)", "deprecated": false, "readOnly": true, "properties": { "@id": { "$ref": "#/components/schemas/property._jsonld_id" }, "@type": { "$ref": "#/components/schemas/property._jsonld_type" }, "@context": { "$ref": "#/components/schemas/property._jsonld_context" }, "uuid": { "$ref": "#/components/schemas/property.common.uuid" }, "delivery_at": { "$ref": "#/components/schemas/property.messages.delivery_at" }, "sender_id": { "$ref": "#/components/schemas/property.messages.sender_id" }, "text": { "$ref": "#/components/schemas/property.bulks.text" }, "phones": { "$ref": "#/components/schemas/property.bulks.phones" }, "msg_groups": { "$ref": "#/components/schemas/property.bulks.msg_groups" }, "status_code": { "$ref": "#/components/schemas/property.bulks.status_code" }, "msg_total_count": { "$ref": "#/components/schemas/property.bulks.msg_total_count" }, "created_at": { "$ref": "#/components/schemas/property.common.created_at" }, "processed_at": { "$ref": "#/components/schemas/property.messages.processed_at" }, "ip": { "$ref": "#/components/schemas/property.common.ip_read" }, "is_unicode": { "$ref": "#/components/schemas/property.messages.is_unicode" }, "is_dryrun": { "$ref": "#/components/schemas/property.messages.is_dryrun" }, "service_code": { "$ref": "#/components/schemas/property.messages.service_code" }, "key_id": { "$ref": "#/components/schemas/property.common.key_id" }, "source": { "$ref": "#/components/schemas/property.messages.source" }, "voice_lang": { "$ref": "#/components/schemas/property.messages.voice_lang" }, "is_text_deleted": { "$ref": "#/components/schemas/property.messages.is_text_deleted" }, "msg_total_cost": { "$ref": "#/components/schemas/property.bulks.msg_total_cost" } } }, "schema.bulks-bulk_read": { "type": "object", "description": "Bulk SMS details", "deprecated": false, "readOnly": true, "properties": { "uuid": { "$ref": "#/components/schemas/property.common.uuid" }, "delivery_at": { "$ref": "#/components/schemas/property.messages.delivery_at" }, "sender_id": { "$ref": "#/components/schemas/property.messages.sender_id" }, "text": { "$ref": "#/components/schemas/property.bulks.text" }, "phones": { "$ref": "#/components/schemas/property.bulks.phones" }, "msg_groups": { "$ref": "#/components/schemas/property.bulks.msg_groups" }, "status_code": { "$ref": "#/components/schemas/property.bulks.status_code" }, "msg_total_count": { "$ref": "#/components/schemas/property.bulks.msg_total_count" }, "created_at": { "$ref": "#/components/schemas/property.common.created_at" }, "processed_at": { "$ref": "#/components/schemas/property.messages.processed_at" }, "ip": { "$ref": "#/components/schemas/property.common.ip_read" }, "is_unicode": { "$ref": "#/components/schemas/property.messages.is_unicode" }, "is_dryrun": { "$ref": "#/components/schemas/property.messages.is_dryrun" }, "service_code": { "$ref": "#/components/schemas/property.messages.service_code" }, "key_id": { "$ref": "#/components/schemas/property.common.key_id" }, "source": { "$ref": "#/components/schemas/property.messages.source" }, "voice_lang": { "$ref": "#/components/schemas/property.messages.voice_lang" }, "is_text_deleted": { "$ref": "#/components/schemas/property.messages.is_text_deleted" }, "msg_total_cost": { "$ref": "#/components/schemas/property.bulks.msg_total_cost" } } }, "property.user_info.id": { "type": "integer", "minimum": 1, "description": "ID do usu\u00e1rio atual" }, "property.common.currency": { "type": "string", "enum": [ "EUR", "CHF" ], "default": "EUR", "description": "Currency" }, "property.user_info.balance_changed_at": { "type": "integer", "minimum": 0, "description": "Timestamp de quando o saldo foi alterado" }, "property.user_info.is_text_deleted": { "type": "boolean", "description": "Par\u00e2metro global para deletar textos de mensagens ap\u00f3s o envio" }, "property.user_info.balance_amount": { "type": "number", "description": "Valor do saldo" }, "property.user_info.services": { "type": "array", "items": { "type": "string", "enum": [ "direct", "economy", "pro", "telegram_codes", "text2speech", "text2speech_ssml" ] }, "description": "Lista dos c\u00f3digos de servi\u00e7os dispon\u00edveis" }, "property.user_info.groups": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^/groups/[0-9]+$", "example": "/groups/24512" }, "example": { "24512": "/groups/24512", "24513": "/groups/24513", "24519": "/groups/24519" }, "description": "Objeto com IDs de grupo como chaves e seus URIs de endpoint correspondentes como valores" }, "schema.client.jsonld-get": { "type": "object", "description": "Info about your user's account", "deprecated": false, "readOnly": true, "properties": { "@id": { "$ref": "#/components/schemas/property._jsonld_id" }, "@type": { "$ref": "#/components/schemas/property._jsonld_type" }, "@context": { "$ref": "#/components/schemas/property._jsonld_context" }, "id": { "$ref": "#/components/schemas/property.user_info.id" }, "currency": { "$ref": "#/components/schemas/property.common.currency" }, "balance_changed_at": { "$ref": "#/components/schemas/property.user_info.balance_changed_at" }, "is_text_deleted": { "$ref": "#/components/schemas/property.user_info.is_text_deleted" }, "balance_amount": { "$ref": "#/components/schemas/property.user_info.balance_amount" }, "services": { "$ref": "#/components/schemas/property.user_info.services" }, "groups": { "$ref": "#/components/schemas/property.user_info.groups" } } }, "schema.client-get": { "type": "object", "description": "Info about your user's account", "deprecated": false, "readOnly": true, "properties": { "id": { "$ref": "#/components/schemas/property.user_info.id" }, "currency": { "$ref": "#/components/schemas/property.common.currency" }, "balance_changed_at": { "$ref": "#/components/schemas/property.user_info.balance_changed_at" }, "is_text_deleted": { "$ref": "#/components/schemas/property.user_info.is_text_deleted" }, "balance_amount": { "$ref": "#/components/schemas/property.user_info.balance_amount" }, "services": { "$ref": "#/components/schemas/property.user_info.services" }, "groups": { "$ref": "#/components/schemas/property.user_info.groups" } } }, "schema.user_pricelist": { "oneOf": [ { "type": "object", "description": "Single country response", "properties": { "country": { "type": "string", "description": "C\u00f3digo de pa\u00eds ISO-2" }, "name": { "type": "string", "description": "Nome do pa\u00eds" }, "currency": { "type": "string", "enum": [ "EUR", "CHF" ], "description": "Moeda" }, "requirements": { "type": [ "string", "null" ], "description": "Requisitos espec\u00edficos do pa\u00eds para envio de SMS" }, "rates": { "type": "object", "description": "Pre\u00e7o \u00fanico por c\u00f3digo de servi\u00e7o com base no seu n\u00edvel de pre\u00e7o", "additionalProperties": { "type": "number", "description": "Price per SMS in the selected currency" } } } }, { "type": "array", "description": "All countries response", "items": { "type": "object", "properties": { "country": { "type": "string", "description": "C\u00f3digo de pa\u00eds ISO-2" }, "name": { "type": "string", "description": "Nome do pa\u00eds" }, "currency": { "type": "string", "description": "Moeda" }, "requirements": { "type": [ "string", "null" ], "description": "Requisitos espec\u00edficos do pa\u00eds para envio de SMS" }, "rates": { "type": "object", "additionalProperties": { "type": "number" }, "description": "Pre\u00e7o \u00fanico por c\u00f3digo de servi\u00e7o com base no seu n\u00edvel de pre\u00e7o" } } } } ], "description": "User-specific pricelist for a country", "properties": { "country": { "description": "C\u00f3digo de pa\u00eds ISO-2" }, "name": { "description": "Nome do pa\u00eds" }, "currency": { "description": "Moeda" }, "requirements": { "description": "Requisitos espec\u00edficos do pa\u00eds para envio de SMS" }, "rates": { "description": "Pre\u00e7o \u00fanico por c\u00f3digo de servi\u00e7o com base no seu n\u00edvel de pre\u00e7o" } } }, "schema.pricelist": { "oneOf": [ { "type": "object", "description": "Single country response", "properties": { "country": { "type": "string", "description": "ISO-2 country code" }, "name": { "type": "string", "description": "Human-readable country name in the requested language" }, "currency": { "type": "string", "enum": [ "EUR", "CHF" ], "description": "Price currency" }, "requirements": { "type": [ "string", "null" ], "description": "Country-specific requirements for sending SMS" }, "rates": { "type": "object", "description": "Price rates keyed by service code", "additionalProperties": { "type": "array", "items": { "type": "number" }, "description": "S, M, L, XL rate tiers" } } } }, { "type": "array", "description": "All countries response", "items": { "type": "object", "properties": { "country": { "type": "string" }, "name": { "type": "string" }, "currency": { "type": "string" }, "requirements": { "type": [ "object", "null" ] }, "rates": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "number" } } } } } } ], "description": "Public pricelist for a country", "properties": { "country": { "description": "C\u00f3digo de pa\u00eds ISO-2" }, "name": { "description": "Nome do pa\u00eds no idioma solicitado" }, "currency": { "description": "Moeda do pre\u00e7o (EUR ou CHF)" }, "requirements": { "description": "Requisitos espec\u00edficos do pa\u00eds para enviar SMS" }, "rates": { "description": "Tarifas por c\u00f3digo de servi\u00e7o" } } }, "property.accounting.id": { "type": "integer", "minimum": 1, "description": "Document ID" }, "property.accounting.created_at": { "type": "integer", "minimum": 0, "description": "Creation timestamp" }, "property.accounting.amount": { "type": "number", "minimum": 0, "description": "Document amount" }, "property.accounting.paid_at": { "type": "integer", "minimum": 0, "description": "Payment timestamp" }, "schema.invoice.jsonld-invoice_read_item": { "type": "object", "additionalProperties": true, "properties": { "@id": { "$ref": "#/components/schemas/property._jsonld_id" }, "@type": { "$ref": "#/components/schemas/property._jsonld_type" }, "@context": { "$ref": "#/components/schemas/property._jsonld_context" }, "id": { "type": "string", "description": "Invoice ID" }, "created_at": { "type": "integer", "description": "Creation date (unix timestamp)" }, "amount": { "type": "number", "description": "Invoice amount" }, "currency": { "$ref": "#/components/schemas/property.common.currency" }, "status": { "type": "integer", "enum": [ 0, 1, 2 ], "description": "Invoice status: 0 = New (unpaid), 1 = Success (paid), 2 = Failed" }, "payment_type": { "type": "integer", "enum": [ 1, 6, 7, 8, 91, 92 ], "description": "Payment method: 1 = SEPA, 6 = Bank Transfer, 7 = PayPal, 8 = Sofort, 91 = Stored Card, 92 = New Card" }, "paid_at": { "type": "integer", "description": "Payment date (unix timestamp), 0 if not paid" }, "client_name": { "type": "string", "description": "Client company name" }, "client_address": { "type": "string", "description": "Client address" }, "client_info": { "type": "string", "description": "Client info line" }, "vat": { "type": "number", "description": "VAT percentage" }, "vat_id": { "type": "string", "description": "VAT identification number" }, "vat_val": { "type": "number", "description": "VAT value" }, "fee": { "type": "number", "description": "Fee percentage" }, "fee_val": { "type": "number", "description": "Fee value" }, "net_val": { "type": "number", "description": "Net cost value" }, "iso2": { "type": "string", "description": "ISO-2 country code" }, "custom_text": { "type": "string", "description": "Custom text on the invoice" }, "pdf": { "type": "string", "description": "URI to download invoice PDF" }, "credit_note": { "type": [ "string", "null" ], "description": "URI to related credit note, null if none" } }, "description": "Invoice details (JSON-LD)" }, "hydra.view": { "type": "object", "properties": { "@id": { "type": "string", "format": "iri-reference" }, "@type": { "type": "string" }, "hydra:first": { "type": "string", "format": "iri-reference" }, "hydra:last": { "type": "string", "format": "iri-reference" }, "hydra:previous": { "type": "string", "format": "iri-reference" }, "hydra:next": { "type": "string", "format": "iri-reference" } }, "example": { "@id": "string", "@type": "string", "hydra:first": "string", "hydra:last": "string", "hydra:previous": "string", "hydra:next": "string" }, "description": "Pagination links for navigating the collection" }, "hydra.search": { "type": "object", "properties": { "@type": { "type": "string" }, "hydra:template": { "type": "string" }, "hydra:variableRepresentation": { "type": "string" }, "hydra:mapping": { "type": "array", "items": { "type": "object", "properties": { "@type": { "type": "string" }, "variable": { "type": "string" }, "property": { "type": [ "string", "null" ] }, "required": { "type": "boolean" } } } } }, "description": "Search and filtering template for the collection" }, "schema.invoice-invoice_read_item": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string", "description": "ID da fatura" }, "created_at": { "type": "integer", "description": "Data de cria\u00e7\u00e3o (timestamp Unix)" }, "amount": { "type": "number", "description": "Valor da fatura" }, "currency": { "$ref": "#/components/schemas/property.common.currency", "description": "C\u00f3digo da moeda" }, "status": { "type": "integer", "enum": [ 0, 1, 2 ], "description": "Status da fatura: 0 = Nova (n\u00e3o paga), 1 = Sucesso (paga), 2 = Falha" }, "payment_type": { "type": "integer", "enum": [ 1, 6, 7, 8, 91, 92 ], "description": "M\u00e9todo de pagamento: 1 = SEPA, 6 = Transfer\u00eancia, 7 = PayPal, 8 = Sofort, 91 = Cart\u00e3o salvo, 92 = Novo cart\u00e3o" }, "paid_at": { "type": "integer", "description": "Data de pagamento (timestamp Unix), 0 se n\u00e3o pago" }, "client_name": { "type": "string", "description": "Nome da empresa do cliente" }, "client_address": { "type": "string", "description": "Endere\u00e7o do cliente" }, "client_info": { "type": "string", "description": "Linha de informa\u00e7\u00e3o do cliente" }, "vat": { "type": "number", "description": "Percentagem de IVA" }, "vat_id": { "type": "string", "description": "N\u00famero de identifica\u00e7\u00e3o fiscal" }, "vat_val": { "type": "number", "description": "Valor do IVA" }, "fee": { "type": "number", "description": "Percentagem de taxa" }, "fee_val": { "type": "number", "description": "Valor da taxa" }, "net_val": { "type": "number", "description": "Valor do custo l\u00edquido" }, "iso2": { "type": "string", "description": "C\u00f3digo de pa\u00eds ISO-2" }, "custom_text": { "type": "string", "description": "Texto personalizado na fatura" }, "pdf": { "type": "string", "description": "URI para baixar o PDF da fatura" }, "credit_note": { "type": [ "string", "null" ], "description": "URI para a nota de cr\u00e9dito relacionada, null se n\u00e3o houver" } }, "description": "Invoice details" }, "schema.credit_note.jsonld-credit_note_read_item": { "type": "object", "additionalProperties": true, "properties": { "@id": { "$ref": "#/components/schemas/property._jsonld_id" }, "@type": { "$ref": "#/components/schemas/property._jsonld_type" }, "@context": { "$ref": "#/components/schemas/property._jsonld_context" }, "id": { "type": "string", "description": "Credit Note ID" }, "created_at": { "type": "integer", "description": "Creation date (unix timestamp)" }, "amount": { "type": "number", "description": "Credit note amount" }, "currency": { "$ref": "#/components/schemas/property.common.currency" }, "status": { "type": "integer", "enum": [ 0, 1, 2 ], "description": "Credit note status: 0 = New, 1 = Success, 2 = Failed" }, "payment_type": { "type": "integer", "enum": [ 1, 6, 7, 8, 91, 92 ], "description": "Payment method: 1 = SEPA, 6 = Bank Transfer, 7 = PayPal, 8 = Sofort, 91 = Stored Card, 92 = New Card" }, "paid_at": { "type": "integer", "description": "Payment date (unix timestamp), 0 if not paid" }, "client_name": { "type": "string", "description": "Client company name" }, "client_address": { "type": "string", "description": "Client address" }, "client_info": { "type": "string", "description": "Client info line" }, "vat": { "type": "number", "description": "VAT percentage" }, "vat_id": { "type": "string", "description": "VAT identification number" }, "vat_val": { "type": "number", "description": "VAT value" }, "fee": { "type": "number", "description": "Fee percentage" }, "fee_val": { "type": "number", "description": "Fee value" }, "net_val": { "type": "number", "description": "Net cost value" }, "iso2": { "type": "string", "description": "ISO-2 country code" }, "custom_text": { "type": "string", "description": "Custom text on the credit note" }, "pdf": { "type": "string", "description": "URI to download credit note PDF" }, "invoice": { "type": "string", "description": "URI to the related invoice" } }, "description": "Credit note details (JSON-LD)" }, "schema.credit_note-credit_note_read_item": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string", "description": "ID da nota de cr\u00e9dito" }, "created_at": { "type": "integer", "description": "Data de cria\u00e7\u00e3o (timestamp Unix)" }, "amount": { "type": "number", "description": "Valor da nota de cr\u00e9dito" }, "currency": { "$ref": "#/components/schemas/property.common.currency", "description": "C\u00f3digo da moeda" }, "status": { "type": "integer", "enum": [ 0, 1, 2 ], "description": "Status da nota de cr\u00e9dito: 0 = Nova, 1 = Sucesso, 2 = Falha" }, "payment_type": { "type": "integer", "enum": [ 1, 6, 7, 8, 91, 92 ], "description": "M\u00e9todo de pagamento: 1 = SEPA, 6 = Transfer\u00eancia, 7 = PayPal, 8 = Sofort, 91 = Cart\u00e3o salvo, 92 = Novo cart\u00e3o" }, "paid_at": { "type": "integer", "description": "Data de pagamento (timestamp Unix), 0 se n\u00e3o pago" }, "client_name": { "type": "string", "description": "Nome da empresa do cliente" }, "client_address": { "type": "string", "description": "Endere\u00e7o do cliente" }, "client_info": { "type": "string", "description": "Linha de informa\u00e7\u00e3o do cliente" }, "vat": { "type": "number", "description": "Percentagem de IVA" }, "vat_id": { "type": "string", "description": "N\u00famero de identifica\u00e7\u00e3o fiscal" }, "vat_val": { "type": "number", "description": "Valor do IVA" }, "fee": { "type": "number", "description": "Percentagem de taxa" }, "fee_val": { "type": "number", "description": "Valor da taxa" }, "net_val": { "type": "number", "description": "Valor do custo l\u00edquido" }, "iso2": { "type": "string", "description": "C\u00f3digo de pa\u00eds ISO-2" }, "custom_text": { "type": "string", "description": "Texto personalizado na nota de cr\u00e9dito" }, "pdf": { "type": "string", "description": "URI para baixar o PDF da nota de cr\u00e9dito" }, "invoice": { "type": "string", "description": "URI para a fatura relacionada" } }, "description": "Credit note details" }, "property.accounting.payment_id": { "type": "integer", "minimum": 1, "description": "Payment attempt ID" }, "property.accounting.payment_created_at": { "type": "integer", "minimum": 0, "description": "Payment creation timestamp" }, "schema.payment.jsonld-payment_read": { "type": "object", "properties": { "@id": { "$ref": "#/components/schemas/property._jsonld_id" }, "@type": { "$ref": "#/components/schemas/property._jsonld_type" }, "@context": { "$ref": "#/components/schemas/property._jsonld_context" }, "id": { "type": "integer", "description": "Payment Attempt ID" }, "created_at": { "type": "integer", "description": "Creation date (unix timestamp)" }, "completed_at": { "type": [ "integer", "null" ], "description": "Completion date (unix timestamp), null if not completed" }, "status": { "type": "integer", "enum": [ 0, 10, 20, 100, 200, 300, 400, 1000 ], "description": "Payment status: 0 = New, 10 = In Progress (before request), 20 = In Progress (after request), 100 = Done, 200 = Canceled by user, 300 = Canceled by timeout, 400 = Canceled by admin, 1000 = Error" }, "amount": { "type": "number", "description": "Total payment amount" }, "net_val": { "type": "number", "description": "Net cost value" }, "vat_val": { "type": "number", "description": "VAT value" }, "fee_val": { "type": "number", "description": "Fee value" }, "currency": { "$ref": "#/components/schemas/property.common.currency" }, "type": { "type": "integer", "enum": [ 1, 6, 7, 8, 91, 92 ], "description": "Payment method: 1 = SEPA, 6 = Bank Transfer, 7 = PayPal, 8 = Sofort, 91 = Stored Card, 92 = New Card" }, "invoice": { "type": [ "string", "null" ], "description": "URI to related invoice, null if not yet created" }, "error": { "type": [ "string", "null" ], "description": "Error message if payment failed, null otherwise" } }, "description": "Payment attempt details (JSON-LD)" }, "schema.payment-payment_read": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID da tentativa de pagamento" }, "created_at": { "type": "integer", "description": "Data de cria\u00e7\u00e3o (timestamp Unix)" }, "completed_at": { "type": [ "integer", "null" ], "description": "Data de conclus\u00e3o (timestamp Unix), null se n\u00e3o conclu\u00eddo" }, "status": { "type": "integer", "enum": [ 0, 10, 20, 100, 200, 300, 400, 1000 ], "description": "Status do pagamento: 0 = Novo, 10 = Em andamento (antes da solicita\u00e7\u00e3o), 20 = Em andamento (ap\u00f3s a solicita\u00e7\u00e3o), 100 = Conclu\u00eddo, 200 = Cancelado pelo usu\u00e1rio, 300 = Cancelado por timeout, 400 = Cancelado pelo administrador, 1000 = Erro" }, "amount": { "type": "number", "description": "Valor total do pagamento" }, "net_val": { "type": "number", "description": "Valor do custo l\u00edquido" }, "vat_val": { "type": "number", "description": "Valor do IVA" }, "fee_val": { "type": "number", "description": "Valor da taxa" }, "currency": { "$ref": "#/components/schemas/property.common.currency", "description": "C\u00f3digo da moeda" }, "type": { "type": "integer", "enum": [ 1, 6, 7, 8, 91, 92 ], "description": "M\u00e9todo de pagamento: 1 = SEPA, 6 = Transfer\u00eancia, 7 = PayPal, 8 = Sofort, 91 = Cart\u00e3o salvo, 92 = Novo cart\u00e3o" }, "invoice": { "type": [ "string", "null" ], "description": "URI para a fatura relacionada, null se ainda n\u00e3o criada" }, "error": { "type": [ "string", "null" ], "description": "Mensagem de erro se o pagamento falhou, null caso contr\u00e1rio" }, "paid_with_id": { "description": "ID do m\u00e9todo de pagamento utilizado (ID do cart\u00e3o salvo ou mandato SEPA), null se n\u00e3o aplic\u00e1vel" } }, "description": "Payment attempt details" }, "schema.payment_request": { "type": "object", "properties": { "net_val": { "type": "number", "description": "Valor l\u00edquido do pagamento (valor real, ex. 50.00 para 50.00 EUR). O total incluindo taxas e IVA \u00e9 calculado automaticamente." }, "type": { "type": "string", "enum": [ "sepa", "stored_card" ], "description": "Tipo de pagamento: \"sepa\" = d\u00e9bito direto SEPA, \"stored_card\" = cart\u00e3o salvo" }, "method_id": { "type": "integer", "description": "ID do m\u00e9todo de pagamento de GET /payment_methods (ID do cart\u00e3o salvo ou mandato SEPA)" } }, "required": [ "net_val", "type", "method_id" ], "description": "Payment creation request payload" }, "schema.payment_methods": { "type": "object", "properties": { "sepa_mandate": { "description": "Mandato de d\u00e9bito direto SEPA, se existir", "type": [ "object", "null" ], "properties": { "id": { "type": "integer", "description": "ID do mandato SEPA" }, "iban_masked": { "type": "string", "description": "IBAN mascarado" }, "last4": { "type": "string", "description": "\u00daltimos 4 d\u00edgitos do IBAN" }, "bank": { "type": "string", "description": "Nome do banco" }, "bic": { "type": "string", "description": "C\u00f3digo BIC/SWIFT" }, "account_holder": { "type": "string", "description": "Nome do titular da conta" }, "street": { "type": "string", "description": "Endere\u00e7o" }, "postcode": { "type": "integer", "description": "C\u00f3digo postal" }, "city": { "type": "string", "description": "Cidade" }, "created_at": { "type": "integer", "description": "Data de cria\u00e7\u00e3o (timestamp Unix)" } } }, "stored_cards": { "description": "Cart\u00f5es de cr\u00e9dito/d\u00e9bito salvos", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID do cart\u00e3o" }, "last4": { "type": "string", "description": "\u00daltimos 4 d\u00edgitos do cart\u00e3o" }, "exp_month": { "type": "integer", "description": "M\u00eas de expira\u00e7\u00e3o" }, "exp_year": { "type": "integer", "description": "Ano de expira\u00e7\u00e3o" }, "brand": { "type": "string", "description": "Bandeira do cart\u00e3o (ex. visa, mastercard)" }, "country": { "type": "string", "description": "C\u00f3digo do pa\u00eds emissor" }, "created_at": { "type": "integer", "description": "Data de cria\u00e7\u00e3o (timestamp Unix)" } } } } }, "description": "Available payment methods" }, "property.fraud-check.status_code": { "type": "integer", "enum": [ 0, 5, 10, 20, 21, 1000 ], "description": "Request processing status codes:\n- 0 \u2013 new request and not processed yet\n- 5 \u2013 request's processing in progress\n- 10 \u2013 request's processing completed successfully\n- 20 - request's processing completed with error: not enough credits\n- 21 - request's processing completed with error: invalid data\n- 1000 - request's processing completed with error: unexpected error" }, "property.fraud-check.risk_score": { "type": "number", "minimum": 0, "maximum": 100, "description": "Fraud risk score from 0 (good) to 100 (bad)" }, "property.fraud-check.service_code": { "type": "string", "enum": [ "economy", "pro", "direct" ], "description": "Service code defines the type of fraud query you make. Economy contains only a risk value, while Pro and Direct contain more details about the results, so you can make your own decision. Direct queries are also processed with priority. (see [/me](/info/user/))" }, "property.common.updated_at": { "readOnly": true, "type": "integer", "minimum": 0, "description": "Timestamp when the entity was changed" }, "property.fraud-check-phone.is_possible": { "type": "boolean", "description": "Is phone number possible" }, "property.fraud-check-phone.is_valid": { "type": "boolean", "description": "Is phone number valid" }, "property.common.country_code": { "type": "string", "pattern": "^[A-Z]{2}$", "minLength": 2, "maxLength": 2, "description": "C\u00f3digo do pa\u00eds", "examples": [ "US", "CA", "GB", "DE", "FR" ] }, "property.fraud-check-phone.number_type": { "type": "string", "description": "Phone number type" }, "schema.fraud-check-phone.jsonld-fraud_request_read": { "type": "object", "description": "Fraud check request phone number", "deprecated": false, "readOnly": true, "properties": { "@id": { "$ref": "#/components/schemas/property._jsonld_id" }, "@type": { "$ref": "#/components/schemas/property._jsonld_type" }, "@context": { "$ref": "#/components/schemas/property._jsonld_context" }, "status_code": { "$ref": "#/components/schemas/property.fraud-check.status_code" }, "phone": { "$ref": "#/components/schemas/property.common.phone_number" }, "created_at": { "$ref": "#/components/schemas/property.common.created_at" }, "updated_at": { "$ref": "#/components/schemas/property.common.updated_at" }, "is_possible": { "$ref": "#/components/schemas/property.fraud-check-phone.is_possible" }, "is_valid": { "$ref": "#/components/schemas/property.fraud-check-phone.is_valid" }, "region": { "$ref": "#/components/schemas/property.common.country_code" }, "number_type": { "$ref": "#/components/schemas/property.fraud-check-phone.number_type" } }, "required": [ "phone" ] }, "property.fraud-check-email.email": { "format": "email", "minLength": 6, "maxLength": 500, "externalDocs": { "url": "https://schema.org/email" }, "type": "string", "description": "An email address sent to check" }, "property.fraud-check-email.is_possible": { "type": "boolean", "description": "Is this email possible or not" }, "property.fraud-check-email.is_anonymous": { "type": "boolean", "description": "Is the service used to anonymize the sender of the email" }, "schema.fraud-check-email.jsonld-fraud_request_read": { "type": "object", "description": "Fraud check request email", "deprecated": false, "readOnly": true, "properties": { "@id": { "$ref": "#/components/schemas/property._jsonld_id" }, "@type": { "$ref": "#/components/schemas/property._jsonld_type" }, "@context": { "$ref": "#/components/schemas/property._jsonld_context" }, "status_code": { "$ref": "#/components/schemas/property.fraud-check.status_code" }, "email": { "$ref": "#/components/schemas/property.fraud-check-email.email" }, "created_at": { "$ref": "#/components/schemas/property.common.created_at" }, "updated_at": { "$ref": "#/components/schemas/property.common.updated_at" }, "is_possible": { "$ref": "#/components/schemas/property.fraud-check-email.is_possible" }, "is_anonymous": { "$ref": "#/components/schemas/property.fraud-check-email.is_anonymous" } }, "required": [ "email" ] }, "property.fraud-check.ip": { "type": "string", "minLength": 7, "maxLength": 39, "description": "IP address (IP v4/v6)" }, "property.fraud-check-ip.state": { "type": "string", "description": "The state or province of the IP address" }, "property.fraud-check-ip.city": { "type": "string", "description": "The city name of the IP address" }, "property.fraud-check-ip.postcode": { "type": "string", "description": "The zip or post code of the IP address" }, "property.fraud-check-ip.geolocation": { "type": "array", "items": { "type": "number" }, "description": "The latitude,longitude of the IP address (array)" }, "property.fraud-check-ip.isp_name": { "type": "string", "description": "The name of the ISP" }, "property.fraud-check-ip.isp_risk_score": { "type": "number", "minimum": 0, "maximum": 100, "description": "Risk score for the ISP" }, "property.fraud-check-ip.proxy_type": { "type": "string", "enum": [ "VPN", "TOR", "DCH", "PUB", "WEB", "SES" ], "description": "If host is proxy:\n- VPN \u2013 Anonymizing VPN services. These services offer users a publicly accessible VPN for the purpose of hiding their IP address.\n- TOR \u2013 Tor Exit Nodes. The Tor Project is an open network used by those who wish to maintain anonymity.\n- DCH \u2013 Hosting Provider, Data Centre or Content Delivery Network. Since hosting providers and data centres can serve to provide anonymity, the Anonymous IP database flags IP addresses associated with them.\n- PUB \u2013 Public Proxies. These are services which make connection requests on a user's behalf. Proxy server software can be configured by the administrator to listen on some specified port. These differ from VPNs in that the proxies usually have limited functions compare to VPNs.\n- WEB \u2013 Web Proxies. These are web services which make web requests on a user's behalf. These differ from VPNs or Public Proxies in that they are simple web-based proxies rather than operating at the IP address and other ports level.\n- SES \u2013 Search Engine Robots. These are services which perform crawling or scraping to a website, such as, the search engine spider or bots engine." }, "property.fraud-check-ip.connection_type": { "type": [ "string", "null" ], "enum": [ "dialup", "isdn", "cable", "dsl", "fttx", "wireless", null ], "description": "The values can be one of either: \"dialup\", \"isdn\", \"cable\", \"dsl\", \"fttx\", \"wireless\" or null" }, "property.fraud-check-ip.is_ok": { "type": "boolean", "description": "Was the request handled correctly?" }, "schema.fraud-check-ip.jsonld-fraud_request_read": { "type": "object", "description": "Fraud check request IP address", "deprecated": false, "readOnly": true, "properties": { "@id": { "$ref": "#/components/schemas/property._jsonld_id" }, "@type": { "$ref": "#/components/schemas/property._jsonld_type" }, "@context": { "$ref": "#/components/schemas/property._jsonld_context" }, "status_code": { "$ref": "#/components/schemas/property.fraud-check.status_code" }, "ip": { "$ref": "#/components/schemas/property.fraud-check.ip" }, "created_at": { "$ref": "#/components/schemas/property.common.created_at" }, "updated_at": { "$ref": "#/components/schemas/property.common.updated_at" }, "iso2": { "$ref": "#/components/schemas/property.common.country_code" }, "state": { "$ref": "#/components/schemas/property.fraud-check-ip.state" }, "city": { "$ref": "#/components/schemas/property.fraud-check-ip.city" }, "postcode": { "$ref": "#/components/schemas/property.fraud-check-ip.postcode" }, "geolocation": { "$ref": "#/components/schemas/property.fraud-check-ip.geolocation" }, "isp_name": { "$ref": "#/components/schemas/property.fraud-check-ip.isp_name" }, "isp_risk_score": { "$ref": "#/components/schemas/property.fraud-check-ip.isp_risk_score" }, "proxy_type": { "$ref": "#/components/schemas/property.fraud-check-ip.proxy_type" }, "connection_type": { "$ref": "#/components/schemas/property.fraud-check-ip.connection_type" }, "is_ok": { "$ref": "#/components/schemas/property.fraud-check-ip.is_ok" } }, "required": [ "ip" ] }, "property.fraud-check-address.status_code": { "type": [ "integer", "null" ], "description": "The request status" }, "property.fraud-check-address.city": { "minLength": 2, "maxLength": 100, "type": [ "string", "null" ], "description": "The city name of the address" }, "property.fraud-check-address.postcode": { "minLength": 3, "maxLength": 20, "type": [ "string", "null" ], "description": "The zip or post code of the address" }, "property.fraud-check-address.street_number": { "minLength": 1, "maxLength": 30, "type": [ "string", "null" ], "description": "The number of house" }, "property.fraud-check-address.street_name": { "minLength": 2, "maxLength": 255, "type": [ "string", "null" ], "description": "The street name" }, "schema.fraud-check-address.jsonld-fraud_request_read": { "type": "object", "description": "Fraud check request address", "deprecated": false, "readOnly": true, "properties": { "@id": { "$ref": "#/components/schemas/property._jsonld_id" }, "@type": { "$ref": "#/components/schemas/property._jsonld_type" }, "@context": { "$ref": "#/components/schemas/property._jsonld_context" }, "status_code": { "$ref": "#/components/schemas/property.fraud-check-address.status_code" }, "iso2": { "$ref": "#/components/schemas/property.common.country_code" }, "city": { "$ref": "#/components/schemas/property.fraud-check-address.city" }, "postcode": { "$ref": "#/components/schemas/property.fraud-check-address.postcode" }, "street_number": { "$ref": "#/components/schemas/property.fraud-check-address.street_number" }, "street_name": { "$ref": "#/components/schemas/property.fraud-check-address.street_name" }, "created_at": { "$ref": "#/components/schemas/property.common.created_at" }, "updated_at": { "$ref": "#/components/schemas/property.common.updated_at" } }, "required": [ "iso2", "city", "street_name" ] }, "property.common.price": { "type": "number", "minimum": 0, "description": "Price" }, "schema.fraud-check.jsonld-fraud_request_read": { "type": "object", "description": "Fraud check request", "deprecated": false, "readOnly": true, "properties": { "@id": { "$ref": "#/components/schemas/property._jsonld_id" }, "@type": { "$ref": "#/components/schemas/property._jsonld_type" }, "@context": { "$ref": "#/components/schemas/property._jsonld_context" }, "id": { "$ref": "#/components/schemas/property.common.uuid" }, "status_code": { "$ref": "#/components/schemas/property.fraud-check.status_code" }, "risk_score": { "$ref": "#/components/schemas/property.fraud-check.risk_score" }, "service_code": { "$ref": "#/components/schemas/property.fraud-check.service_code" }, "created_at": { "$ref": "#/components/schemas/property.common.created_at" }, "updated_at": { "$ref": "#/components/schemas/property.common.updated_at" }, "callback_data": { "anyOf": [ { "$ref": "#/components/schemas/property.common.callback_data" }, { "type": "null" } ] }, "request_phone": { "anyOf": [ { "$ref": "#/components/schemas/schema.fraud-check-phone.jsonld-fraud_request_read" }, { "type": "null" } ] }, "request_email": { "anyOf": [ { "$ref": "#/components/schemas/schema.fraud-check-email.jsonld-fraud_request_read" }, { "type": "null" } ] }, "request_ip": { "anyOf": [ { "$ref": "#/components/schemas/schema.fraud-check-ip.jsonld-fraud_request_read" }, { "type": "null" } ] }, "request_address": { "anyOf": [ { "$ref": "#/components/schemas/schema.fraud-check-address.jsonld-fraud_request_read" }, { "type": "null" } ] }, "price": { "$ref": "#/components/schemas/property.common.price" } }, "required": [ "service_code" ] }, "schema.fraud-check-phone-fraud_request_read": { "type": "object", "description": "Fraud check request phone number", "deprecated": false, "readOnly": true, "properties": { "status_code": { "$ref": "#/components/schemas/property.fraud-check.status_code" }, "phone": { "$ref": "#/components/schemas/property.common.phone_number" }, "created_at": { "$ref": "#/components/schemas/property.common.created_at" }, "updated_at": { "$ref": "#/components/schemas/property.common.updated_at" }, "is_possible": { "$ref": "#/components/schemas/property.fraud-check-phone.is_possible" }, "is_valid": { "$ref": "#/components/schemas/property.fraud-check-phone.is_valid" }, "region": { "$ref": "#/components/schemas/property.common.country_code" }, "number_type": { "$ref": "#/components/schemas/property.fraud-check-phone.number_type" } }, "required": [ "phone" ] }, "schema.fraud-check-email-fraud_request_read": { "type": "object", "description": "Fraud check request email", "deprecated": false, "readOnly": true, "properties": { "status_code": { "$ref": "#/components/schemas/property.fraud-check.status_code" }, "email": { "$ref": "#/components/schemas/property.fraud-check-email.email" }, "created_at": { "$ref": "#/components/schemas/property.common.created_at" }, "updated_at": { "$ref": "#/components/schemas/property.common.updated_at" }, "is_possible": { "$ref": "#/components/schemas/property.fraud-check-email.is_possible" }, "is_anonymous": { "$ref": "#/components/schemas/property.fraud-check-email.is_anonymous" } }, "required": [ "email" ] }, "schema.fraud-check-ip-fraud_request_read": { "type": "object", "description": "Fraud check request IP address", "deprecated": false, "readOnly": true, "properties": { "status_code": { "$ref": "#/components/schemas/property.fraud-check.status_code" }, "ip": { "$ref": "#/components/schemas/property.fraud-check.ip" }, "created_at": { "$ref": "#/components/schemas/property.common.created_at" }, "updated_at": { "$ref": "#/components/schemas/property.common.updated_at" }, "iso2": { "$ref": "#/components/schemas/property.common.country_code" }, "state": { "$ref": "#/components/schemas/property.fraud-check-ip.state" }, "city": { "$ref": "#/components/schemas/property.fraud-check-ip.city" }, "postcode": { "$ref": "#/components/schemas/property.fraud-check-ip.postcode" }, "geolocation": { "$ref": "#/components/schemas/property.fraud-check-ip.geolocation" }, "isp_name": { "$ref": "#/components/schemas/property.fraud-check-ip.isp_name" }, "isp_risk_score": { "$ref": "#/components/schemas/property.fraud-check-ip.isp_risk_score" }, "proxy_type": { "$ref": "#/components/schemas/property.fraud-check-ip.proxy_type" }, "connection_type": { "$ref": "#/components/schemas/property.fraud-check-ip.connection_type" }, "is_ok": { "$ref": "#/components/schemas/property.fraud-check-ip.is_ok" } }, "required": [ "ip" ] }, "schema.fraud-check-address-fraud_request_read": { "type": "object", "description": "Fraud check request address", "deprecated": false, "readOnly": true, "properties": { "status_code": { "$ref": "#/components/schemas/property.fraud-check-address.status_code" }, "iso2": { "$ref": "#/components/schemas/property.common.country_code" }, "city": { "$ref": "#/components/schemas/property.fraud-check-address.city" }, "postcode": { "$ref": "#/components/schemas/property.fraud-check-address.postcode" }, "street_number": { "$ref": "#/components/schemas/property.fraud-check-address.street_number" }, "street_name": { "$ref": "#/components/schemas/property.fraud-check-address.street_name" }, "created_at": { "$ref": "#/components/schemas/property.common.created_at" }, "updated_at": { "$ref": "#/components/schemas/property.common.updated_at" } }, "required": [ "iso2", "city", "street_name" ] }, "schema.fraud-check-fraud_request_read": { "type": "object", "description": "Fraud check request", "deprecated": false, "readOnly": true, "properties": { "id": { "$ref": "#/components/schemas/property.common.uuid" }, "status_code": { "$ref": "#/components/schemas/property.fraud-check.status_code" }, "risk_score": { "$ref": "#/components/schemas/property.fraud-check.risk_score" }, "service_code": { "$ref": "#/components/schemas/property.fraud-check.service_code" }, "created_at": { "$ref": "#/components/schemas/property.common.created_at" }, "updated_at": { "$ref": "#/components/schemas/property.common.updated_at" }, "callback_data": { "anyOf": [ { "$ref": "#/components/schemas/property.common.callback_data" }, { "type": "null" } ] }, "request_phone": { "description": "ORM\\Column(name=\"email\", type=\"text\", length=50, nullable=false)", "anyOf": [ { "$ref": "#/components/schemas/schema.fraud-check-phone-fraud_request_read" }, { "type": "null" } ] }, "request_email": { "anyOf": [ { "$ref": "#/components/schemas/schema.fraud-check-email-fraud_request_read" }, { "type": "null" } ] }, "request_ip": { "anyOf": [ { "$ref": "#/components/schemas/schema.fraud-check-ip-fraud_request_read" }, { "type": "null" } ] }, "request_address": { "anyOf": [ { "$ref": "#/components/schemas/schema.fraud-check-address-fraud_request_read" }, { "type": "null" } ] }, "price": { "$ref": "#/components/schemas/property.common.price" } }, "required": [ "service_code" ] }, "property.fraud-check.email": { "type": "string", "minLength": 6, "maxLength": 500, "description": "Email address" }, "schema.fraud-check-address-fraud_request_write": { "type": "object", "description": "Fraud check request address", "deprecated": false, "required": [ "iso2", "city", "street_name" ], "properties": { "iso2": { "$ref": "#/components/schemas/property.common.country_code" }, "city": { "$ref": "#/components/schemas/property.fraud-check-address.city" }, "postcode": { "$ref": "#/components/schemas/property.fraud-check-address.postcode" }, "street_number": { "$ref": "#/components/schemas/property.fraud-check-address.street_number" }, "street_name": { "$ref": "#/components/schemas/property.fraud-check-address.street_name" } } }, "schema.fraud-check-fraud_request_write": { "type": "object", "description": "Fraud check request", "deprecated": false, "required": [ "service_code" ], "properties": { "service_code": { "$ref": "#/components/schemas/property.fraud-check.service_code" }, "callback_data": { "anyOf": [ { "$ref": "#/components/schemas/property.common.callback_data" }, { "type": "null" } ] }, "phone": { "anyOf": [ { "$ref": "#/components/schemas/property.common.phone_number" }, { "type": "null" } ] }, "email": { "anyOf": [ { "$ref": "#/components/schemas/property.fraud-check.email" }, { "type": "null" } ] }, "ip": { "anyOf": [ { "$ref": "#/components/schemas/property.fraud-check.ip" }, { "type": "null" } ] }, "address": { "anyOf": [ { "$ref": "#/components/schemas/schema.fraud-check-address-fraud_request_write" }, { "type": "null" } ] } } }, "property.group.id": { "type": "integer", "minimum": 1, "description": "ID do grupo" }, "property.group.name": { "minLength": 1, "maxLength": 50, "type": "string", "description": "Nome do grupo" }, "property.group.description": { "maxLength": 255, "type": [ "string", "null" ], "description": "Descri\u00e7\u00e3o do grupo" }, "property.group.column_name": { "maxLength": 50, "type": [ "string", "null" ], "description": "Nome da coluna" }, "property.group.count_items": { "type": "integer", "minimum": 0, "description": "Contagem de itens no grupo", "readOnly": true }, "property.group.deleted_at": { "type": [ "string", "null" ], "format": "date-time", "description": "Data e hora em que o grupo ser\u00e1 exclu\u00eddo" }, "schema.groups.jsonld-group_read": { "type": "object", "description": "Phone's group", "deprecated": false, "readOnly": true, "properties": { "@context": { "$ref": "#/components/schemas/property._jsonld_context" }, "@id": { "$ref": "#/components/schemas/property._jsonld_id" }, "@type": { "$ref": "#/components/schemas/property._jsonld_type" }, "id": { "$ref": "#/components/schemas/property.group.id" }, "name": { "$ref": "#/components/schemas/property.group.name" }, "description": { "$ref": "#/components/schemas/property.group.description" }, "name_a": { "$ref": "#/components/schemas/property.group.column_name" }, "name_b": { "$ref": "#/components/schemas/property.group.column_name" }, "name_c": { "$ref": "#/components/schemas/property.group.column_name" }, "name_d": { "$ref": "#/components/schemas/property.group.column_name" }, "name_e": { "$ref": "#/components/schemas/property.group.column_name" }, "count_items": { "$ref": "#/components/schemas/property.group.count_items" }, "deleted_at": { "$ref": "#/components/schemas/property.group.deleted_at" } }, "required": [ "name" ] }, "schema.groups-group_read": { "type": "object", "description": "Phone's group", "deprecated": false, "readOnly": true, "properties": { "id": { "$ref": "#/components/schemas/property.group.id" }, "name": { "$ref": "#/components/schemas/property.group.name" }, "description": { "$ref": "#/components/schemas/property.group.description" }, "name_a": { "$ref": "#/components/schemas/property.group.column_name" }, "name_b": { "$ref": "#/components/schemas/property.group.column_name" }, "name_c": { "$ref": "#/components/schemas/property.group.column_name" }, "name_d": { "$ref": "#/components/schemas/property.group.column_name" }, "name_e": { "$ref": "#/components/schemas/property.group.column_name" }, "count_items": { "$ref": "#/components/schemas/property.group.count_items" }, "deleted_at": { "$ref": "#/components/schemas/property.group.deleted_at" } }, "required": [ "name" ] }, "property.phone.phone": { "maxLength": 30, "type": "string", "description": "N\u00famero de telefone" }, "property.phone.column": { "maxLength": 1530, "type": [ "string", "null" ], "description": "Dados da coluna do telefone" }, "schema.phones-write": { "type": "object", "description": "Phones list by group", "deprecated": false, "required": [ "phone" ], "properties": { "phone": { "$ref": "#/components/schemas/property.phone.phone" }, "a": { "$ref": "#/components/schemas/property.phone.column" }, "b": { "$ref": "#/components/schemas/property.phone.column" }, "c": { "$ref": "#/components/schemas/property.phone.column" }, "d": { "$ref": "#/components/schemas/property.phone.column" }, "e": { "$ref": "#/components/schemas/property.phone.column" }, "callback_data": { "$ref": "#/components/schemas/property.common.callback_data" } } }, "schema.groups-write": { "type": "object", "description": "Phone's group", "deprecated": false, "required": [ "name" ], "properties": { "name": { "$ref": "#/components/schemas/property.group.name" }, "description": { "$ref": "#/components/schemas/property.group.description" }, "name_a": { "$ref": "#/components/schemas/property.group.column_name" }, "name_b": { "$ref": "#/components/schemas/property.group.column_name" }, "name_c": { "$ref": "#/components/schemas/property.group.column_name" }, "name_d": { "$ref": "#/components/schemas/property.group.column_name" }, "name_e": { "$ref": "#/components/schemas/property.group.column_name" }, "phones": { "type": "array", "items": { "$ref": "#/components/schemas/schema.phones-write" } } } }, "property.phone.id": { "type": "integer", "minimum": 1, "description": "ID do telefone" }, "property.phone.subscribed_at": { "type": [ "integer", "null" ], "description": "Timestamp de quando o usu\u00e1rio se inscreveu [link](/pt/api/operations/post_subscribe/)" }, "property.phone.unsubscribed_at": { "type": [ "integer", "null" ], "description": "Timestamp when user was unsubscribed by a [link](/pt/api/operations/post_unsubscribe/)" }, "property.phone.unsubscribe_reason": { "type": [ "integer", "null" ], "description": "Unsubscribe reasons:\n- 1 - I never subscribed\n- 2 - Too many messages\n- 3 - I am not interested\n- 4 - Content is incomprehensible\n- 5 - I don't like your company\n- 6 - Other" }, "schema.phones.jsonld-phone_read": { "type": "object", "description": "Phones list by group", "deprecated": false, "readOnly": true, "properties": { "@context": { "$ref": "#/components/schemas/property._jsonld_context" }, "@id": { "$ref": "#/components/schemas/property._jsonld_id" }, "@type": { "$ref": "#/components/schemas/property._jsonld_type" }, "id": { "$ref": "#/components/schemas/property.phone.id" }, "phone": { "$ref": "#/components/schemas/property.phone.phone" }, "a": { "$ref": "#/components/schemas/property.phone.column" }, "b": { "$ref": "#/components/schemas/property.phone.column" }, "c": { "$ref": "#/components/schemas/property.phone.column" }, "d": { "$ref": "#/components/schemas/property.phone.column" }, "e": { "$ref": "#/components/schemas/property.phone.column" }, "callback_data": { "$ref": "#/components/schemas/property.common.callback_data" }, "subscribed_at": { "$ref": "#/components/schemas/property.phone.subscribed_at" }, "unsubscribed_at": { "$ref": "#/components/schemas/property.phone.unsubscribed_at" }, "unsubscribe_reason": { "$ref": "#/components/schemas/property.phone.unsubscribe_reason" } }, "required": [ "phone" ] }, "schema.phones-phone_read": { "type": "object", "description": "Phones list by group", "deprecated": false, "readOnly": true, "properties": { "id": { "$ref": "#/components/schemas/property.phone.id" }, "phone": { "$ref": "#/components/schemas/property.phone.phone" }, "a": { "$ref": "#/components/schemas/property.phone.column" }, "b": { "$ref": "#/components/schemas/property.phone.column" }, "c": { "$ref": "#/components/schemas/property.phone.column" }, "d": { "$ref": "#/components/schemas/property.phone.column" }, "e": { "$ref": "#/components/schemas/property.phone.column" }, "callback_data": { "$ref": "#/components/schemas/property.common.callback_data" }, "subscribed_at": { "$ref": "#/components/schemas/property.phone.subscribed_at" }, "unsubscribed_at": { "$ref": "#/components/schemas/property.phone.unsubscribed_at" }, "unsubscribe_reason": { "$ref": "#/components/schemas/property.phone.unsubscribe_reason" } }, "required": [ "phone" ] }, "schema.phones-phone_write": { "type": "object", "description": "Phones list by group", "deprecated": false, "required": [ "phone" ], "properties": { "phone": { "$ref": "#/components/schemas/property.phone.phone" }, "a": { "$ref": "#/components/schemas/property.phone.column" }, "b": { "$ref": "#/components/schemas/property.phone.column" }, "c": { "$ref": "#/components/schemas/property.phone.column" }, "d": { "$ref": "#/components/schemas/property.phone.column" }, "e": { "$ref": "#/components/schemas/property.phone.column" }, "callback_data": { "$ref": "#/components/schemas/property.common.callback_data" } } }, "schema.phones-batch-write": { "type": "array", "items": { "$ref": "#/components/schemas/schema.phones-phone_write" }, "description": "Batch phone creation request payload" }, "property.batch.status": { "readOnly": true, "type": "integer", "description": "C\u00f3digo de status HTTP de resposta" }, "schema.response.jsonld-bad-request": { "type": "object", "readOnly": true, "properties": { "@context": { "type": "string", "readOnly": true }, "@type": { "type": "string", "readOnly": true }, "hydra:title": { "type": "string", "readOnly": true }, "hydra:description": { "type": "string", "readOnly": true } }, "description": "Bad request error response (JSON-LD)" }, "schema.phones.jsonld-batch-item": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/property.batch.status" }, "body": { "anyOf": [ { "$ref": "#/components/schemas/schema.phones.jsonld-phone_read" }, { "$ref": "#/components/schemas/schema.response.jsonld-bad-request" } ] } }, "description": "Batch operation result item (JSON-LD)" }, "schema.phones.jsonld-batch-read": { "type": "object", "readOnly": true, "properties": { "@context": { "$ref": "#/components/schemas/property._jsonld_context" }, "@id": { "$ref": "#/components/schemas/property._jsonld_id" }, "@type": { "$ref": "#/components/schemas/property._jsonld_type" }, "hydra:totalItems": { "type": "integer", "minimum": 0 }, "member": { "$ref": "#/components/schemas/schema.phones.jsonld-batch-item" } }, "description": "Batch operation results (JSON-LD)" }, "schema.response-bad-request": { "type": "object", "readOnly": true, "properties": { "type": { "type": "string", "readOnly": true }, "title": { "type": "string", "readOnly": true }, "detail": { "type": "string", "readOnly": true } }, "description": "Bad request error response" }, "schema.phones-batch-item": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/property.batch.status" }, "body": { "oneOf": [ { "$ref": "#/components/schemas/schema.phones-phone_read" }, { "$ref": "#/components/schemas/schema.response-bad-request" } ] } }, "description": "Batch operation result item" }, "schema.phones-batch-read": { "type": "array", "readOnly": true, "items": { "$ref": "#/components/schemas/schema.phones-batch-item" }, "description": "Batch operation results" }, "property.incomings.received_at": { "type": "integer", "description": "Timestamp when SMS was received by the service" }, "property.incomings.text": { "type": [ "string", "null" ], "description": "SMS text" }, "property.incomings.msg_uuid": { "type": [ "string", "null" ], "description": "ID of SMS that get reply" }, "schema.incomings.jsonld-incoming_read": { "type": "object", "description": "Incoming SMS", "deprecated": false, "readOnly": true, "properties": { "@id": { "$ref": "#/components/schemas/property._jsonld_id" }, "@type": { "$ref": "#/components/schemas/property._jsonld_type" }, "@context": { "$ref": "#/components/schemas/property._jsonld_context" }, "uuid": { "$ref": "#/components/schemas/property.common.uuid" }, "to": { "$ref": "#/components/schemas/property.common.phone_number" }, "from": { "$ref": "#/components/schemas/property.common.phone_number" }, "received_at": { "$ref": "#/components/schemas/property.incomings.received_at" }, "text": { "$ref": "#/components/schemas/property.incomings.text" }, "msg_uuid": { "$ref": "#/components/schemas/property.incomings.msg_uuid" } } }, "schema.incomings-incoming_read": { "type": "object", "description": "Incoming SMS", "deprecated": false, "readOnly": true, "properties": { "uuid": { "$ref": "#/components/schemas/property.common.uuid" }, "to": { "$ref": "#/components/schemas/property.common.phone_number" }, "from": { "$ref": "#/components/schemas/property.common.phone_number" }, "received_at": { "$ref": "#/components/schemas/property.incomings.received_at" }, "text": { "$ref": "#/components/schemas/property.incomings.text" }, "msg_uuid": { "$ref": "#/components/schemas/property.incomings.msg_uuid" } } }, "property.short_link_requests.type": { "type": "integer", "enum": [ 0, 1 ], "description": "Tipo da solicita\u00e7\u00e3o de link curto" }, "property.short_link_campaigns.type": { "enum": [ 1, 2 ], "type": "integer", "description": "Tipo da campanha de links curtos" }, "property.short_link_campaigns.id": { "type": [ "string", "null" ], "description": "Identificador \u00fanico da campanha de links curtos" }, "property.short_link_campaigns.name": { "maxLength": 100, "minLength": 1, "type": "string", "description": "Nome da campanha de links curtos" }, "property.short_link_campaigns.url": { "minLength": 1, "type": "string", "description": "URL da campanha de links curtos" }, "property.short_link_campaigns.group_id": { "type": [ "integer", "null" ], "minimum": 1, "description": "ID do grupo da campanha de links curtos" }, "schema.short_link_campaigns.jsonld-short_link_campaign_read": { "type": "object", "description": "Short link campaigns", "readOnly": true, "deprecated": false, "properties": { "@id": { "$ref": "#/components/schemas/property._jsonld_id" }, "@type": { "$ref": "#/components/schemas/property._jsonld_type" }, "@context": { "$ref": "#/components/schemas/property._jsonld_context" }, "type": { "$ref": "#/components/schemas/property.short_link_campaigns.type" }, "id": { "$ref": "#/components/schemas/property.short_link_campaigns.id" }, "name": { "$ref": "#/components/schemas/property.short_link_campaigns.name" }, "url": { "$ref": "#/components/schemas/property.short_link_campaigns.url" }, "created_at": { "$ref": "#/components/schemas/property.common.created_at" }, "group_id": { "$ref": "#/components/schemas/property.short_link_campaigns.group_id" } } }, "schema.short_link_campaigns-short_link_campaign_read": { "type": "object", "description": "Short link campaigns", "deprecated": false, "readOnly": true, "properties": { "type": { "$ref": "#/components/schemas/property.short_link_campaigns.type" }, "id": { "$ref": "#/components/schemas/property.short_link_campaigns.id" }, "name": { "$ref": "#/components/schemas/property.short_link_campaigns.name" }, "url": { "$ref": "#/components/schemas/property.short_link_campaigns.url" }, "created_at": { "$ref": "#/components/schemas/property.common.created_at" }, "group_id": { "$ref": "#/components/schemas/property.short_link_campaigns.group_id" } } }, "schema.short_link_campaigns-short_link_campaign_write": { "type": "object", "description": "Short link campaigns", "deprecated": false, "required": [ "type", "name", "url" ], "properties": { "type": { "$ref": "#/components/schemas/property.short_link_campaigns.type" }, "name": { "$ref": "#/components/schemas/property.short_link_campaigns.name" }, "url": { "$ref": "#/components/schemas/property.short_link_campaigns.url" }, "group_id": { "$ref": "#/components/schemas/property.short_link_campaigns.group_id" } } }, "schema.short_link_campaigns-short_link_campaign_subscribe_write": { "type": "object", "description": "Short link campaigns", "deprecated": false, "required": [ "name", "group_id" ], "properties": { "name": { "$ref": "#/components/schemas/property.short_link_campaigns.name" }, "group_id": { "$ref": "#/components/schemas/property.short_link_campaigns.group_id" } } }, "schema.short_link_campaigns.jsonld-short_link_campaign_subscribe_read": { "type": "object", "description": "Short link campaigns", "readOnly": true, "deprecated": false, "properties": { "@id": { "$ref": "#/components/schemas/property._jsonld_id" }, "@type": { "$ref": "#/components/schemas/property._jsonld_type" }, "@context": { "$ref": "#/components/schemas/property._jsonld_context" }, "type": { "$ref": "#/components/schemas/property.short_link_campaigns.type" }, "id": { "$ref": "#/components/schemas/property.short_link_campaigns.id" }, "name": { "$ref": "#/components/schemas/property.short_link_campaigns.name" }, "url": { "$ref": "#/components/schemas/property.short_link_campaigns.url" }, "created_at": { "$ref": "#/components/schemas/property.common.created_at" }, "group_id": { "$ref": "#/components/schemas/property.short_link_campaigns.group_id" } } }, "schema.short_link_campaigns-short_link_campaign_subscribe_read": { "type": "object", "description": "Short link campaigns", "deprecated": false, "readOnly": true, "properties": { "type": { "$ref": "#/components/schemas/property.short_link_campaigns.type" }, "id": { "$ref": "#/components/schemas/property.short_link_campaigns.id" }, "name": { "$ref": "#/components/schemas/property.short_link_campaigns.name" }, "url": { "$ref": "#/components/schemas/property.short_link_campaigns.url" }, "created_at": { "$ref": "#/components/schemas/property.common.created_at" }, "group_id": { "$ref": "#/components/schemas/property.short_link_campaigns.group_id" } } }, "property.short_link_requests.date": { "type": "integer", "minimum": 0, "description": "Data da solicita\u00e7\u00e3o de link curto" }, "property.short_link_requests.id": { "type": "integer", "minimum": 0, "description": "Identificador \u00fanico da solicita\u00e7\u00e3o de link curto" }, "property.short_link_requests.ip": { "type": [ "string", "null" ], "format": "ipv4", "example": "192.168.1.1", "maxLength": 15, "description": "Endere\u00e7o IP da solicita\u00e7\u00e3o de link curto" }, "property.short_link_requests.user_agent": { "type": [ "string", "null" ], "description": "Agente do usu\u00e1rio da solicita\u00e7\u00e3o de link curto" }, "property.short_link_requests.url": { "type": "string", "description": "URL da solicita\u00e7\u00e3o de link curto" }, "property.short_link_requests.referer": { "type": [ "string", "null" ], "description": "Referenciador da solicita\u00e7\u00e3o de link curto" }, "property.short_link_requests.short_link": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/", "description": "Link curto associado \u00e0 solicita\u00e7\u00e3o" }, "property.short_link_requests.browser": { "type": [ "string", "null" ], "description": "Navegador usado para a solicita\u00e7\u00e3o de link curto" }, "property.short_link_requests.browser_version": { "type": [ "string", "null" ], "maxLength": 255, "description": "Vers\u00e3o do navegador usada para a solicita\u00e7\u00e3o de link curto" }, "property.short_link_requests.os": { "type": [ "string", "null" ], "maxLength": 255, "description": "Sistema operacional usado para a solicita\u00e7\u00e3o de link curto" }, "property.short_link_requests.os_version": { "type": [ "string", "null" ], "maxLength": 255, "description": "Vers\u00e3o do sistema operacional usada para a solicita\u00e7\u00e3o de link curto" }, "property.short_link_requests.software_type": { "type": [ "string", "null" ], "maxLength": 255, "description": "Tipo de software usado para a solicita\u00e7\u00e3o de link curto" }, "property.short_link_requests.hardware_type": { "type": [ "string", "null" ], "maxLength": 255, "description": "Tipo de hardware usado para a solicita\u00e7\u00e3o de link curto" }, "schema.short_link_requests.jsonld-short_link_request_read": { "type": "object", "description": "Short link campaigns", "readOnly": true, "deprecated": false, "properties": { "@id": { "$ref": "#/components/schemas/property._jsonld_id" }, "@type": { "$ref": "#/components/schemas/property._jsonld_type" }, "@context": { "$ref": "#/components/schemas/property._jsonld_context" }, "id": { "$ref": "#/components/schemas/property.short_link_requests.id" }, "ip": { "$ref": "#/components/schemas/property.short_link_requests.ip" }, "user_agent": { "$ref": "#/components/schemas/property.short_link_requests.user_agent" }, "url": { "$ref": "#/components/schemas/property.short_link_requests.url" }, "date": { "$ref": "#/components/schemas/property.short_link_requests.date" }, "country": { "$ref": "#/components/schemas/property.common.country_code" }, "referer": { "$ref": "#/components/schemas/property.short_link_requests.referer" }, "short_link": { "$ref": "#/components/schemas/property.short_link_requests.short_link" }, "type": { "$ref": "#/components/schemas/property.short_link_requests.type" }, "browser": { "$ref": "#/components/schemas/property.short_link_requests.browser" }, "browser_version": { "$ref": "#/components/schemas/property.short_link_requests.browser_version" }, "os": { "$ref": "#/components/schemas/property.short_link_requests.os" }, "os_version": { "$ref": "#/components/schemas/property.short_link_requests.os_version" }, "software_type": { "$ref": "#/components/schemas/property.short_link_requests.software_type" }, "hardware_type": { "$ref": "#/components/schemas/property.short_link_requests.hardware_type" } } }, "schema.short_link_requests-short_link_request_read": { "type": "object", "description": "Short link campaigns", "readOnly": true, "deprecated": false, "properties": { "id": { "$ref": "#/components/schemas/property.short_link_requests.id" }, "ip": { "$ref": "#/components/schemas/property.short_link_requests.ip" }, "user_agent": { "$ref": "#/components/schemas/property.short_link_requests.user_agent" }, "url": { "$ref": "#/components/schemas/property.short_link_requests.url" }, "date": { "$ref": "#/components/schemas/property.short_link_requests.date" }, "country": { "$ref": "#/components/schemas/property.common.country_code" }, "referer": { "$ref": "#/components/schemas/property.short_link_requests.referer" }, "short_link": { "$ref": "#/components/schemas/property.short_link_requests.short_link" }, "type": { "$ref": "#/components/schemas/property.short_link_requests.type" }, "browser": { "$ref": "#/components/schemas/property.short_link_requests.browser" }, "browser_version": { "$ref": "#/components/schemas/property.short_link_requests.browser_version" }, "os": { "$ref": "#/components/schemas/property.short_link_requests.os" }, "os_version": { "$ref": "#/components/schemas/property.short_link_requests.os_version" }, "software_type": { "$ref": "#/components/schemas/property.short_link_requests.software_type" }, "hardware_type": { "$ref": "#/components/schemas/property.short_link_requests.hardware_type" } } }, "property.short_links.short_code": { "type": [ "string", "null" ], "description": "C\u00f3digo curto do link" }, "property.short_links.url": { "type": [ "string", "null" ], "description": "URL do link curto" }, "property.short_links.campaign": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/", "description": "Campanha associada ao link curto" }, "property.short_links.requests": { "type": "string", "description": "Solicita\u00e7\u00f5es associadas ao link curto" }, "schema.short_links.jsonld-short_link_read": { "type": "object", "description": "Short links", "readOnly": true, "deprecated": false, "properties": { "@id": { "$ref": "#/components/schemas/property._jsonld_id" }, "@type": { "$ref": "#/components/schemas/property._jsonld_type" }, "@context": { "$ref": "#/components/schemas/property._jsonld_context" }, "short_code": { "$ref": "#/components/schemas/property.short_links.short_code" }, "url": { "$ref": "#/components/schemas/property.short_links.url" }, "updated_at": { "$ref": "#/components/schemas/property.common.updated_at" }, "campaign": { "$ref": "#/components/schemas/property.short_links.campaign" }, "requests": { "$ref": "#/components/schemas/property.short_links.requests" } } }, "schema.short_links-short_link_read": { "type": "object", "description": "Short links", "readOnly": true, "deprecated": false, "properties": { "short_code": { "$ref": "#/components/schemas/property.short_links.short_code" }, "url": { "$ref": "#/components/schemas/property.short_links.url" }, "updated_at": { "$ref": "#/components/schemas/property.common.updated_at" }, "campaign": { "$ref": "#/components/schemas/property.short_links.campaign" }, "requests": { "$ref": "#/components/schemas/property.short_links.requests" } } }, "property.sms.dlr_code": { "type": "integer", "description": "[Status of the SMS delivery](/info/sms-delivery-report-codes-dlr/) from gateway", "enum": [ 0, 1, 2, 4, 8, 16 ], "example": 1, "x-enum-descriptions": { "0": "NONE: No delivery report available", "1": "DELIVERY_OK: Message successfully delivered", "2": "DELIVERY_QUEUE: Message scheduled for later delivery", "4": "DELIVERY_SUBMIT_ACK: Message is enroute", "8": "DELIVERY_EXPIRED: Message expired (e.g., phone turned off)", "16": "DELIVERY_REJECTED: Message rejected (blocked number or invalid)" } }, "property.sms.status_code": { "type": "integer", "minimum": 0, "enum": [ 0, 100, 208, 400, 410, 2000, 3000, 5000, 6000 ], "description": "Status of the sms. For more info see [SMS status codes](/info/sms-status-codes/)" }, "property.sms.gateway_sent_at": { "type": "integer", "description": "Timestamp when message was sent to the mobile network provider" }, "property.sms.parts_count": { "type": "integer", "minimum": 1, "description": "Count of the SMS parts (concatenated messages)" }, "property.sms.chars_count": { "type": [ "integer", "null" ], "description": "Count of chars in the message text" }, "property.sms.bulk_id": { "type": [ "null", "string" ], "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "description": "Bulk ID" }, "property.sms.is_sent": { "type": "boolean", "description": "True - SMS was sent, False - SMS wasn't sent yet" }, "property.sms.requests": { "type": [ "string", "null" ], "description": "[Link](/pt/api/operations/get_sms_requests/) to all requests by a SMS list" }, "property.sms.clicks": { "type": [ "string", "null" ], "description": "[Link](/pt/api/operations/api_sms_clicks_per_message_get_collection/) to count of request by a short link" }, "property.sms.attempts_count_max": { "type": [ "integer", "null" ], "description": "N\u00famero m\u00e1ximo de tentativas de entrega para servi\u00e7os de voz (`text2speech`, `text2speech_ssml`). Valores permitidos: `null`, `1`, `2` ou `3` para os servi\u00e7os `text2speech`/`text2speech_ssml`; deve ser nulo para os restantes servi\u00e7os.", "example": null, "enum": [ null, 1, 2, 3 ] }, "schema.sms.jsonld-sms_read": { "type": "object", "description": "SMS", "deprecated": false, "readOnly": true, "properties": { "@id": { "$ref": "#/components/schemas/property._jsonld_id" }, "@type": { "$ref": "#/components/schemas/property._jsonld_type" }, "@context": { "$ref": "#/components/schemas/property._jsonld_context" }, "text": { "$ref": "#/components/schemas/property.sms.text" }, "sender_id": { "$ref": "#/components/schemas/property.messages.sender_id" }, "phone": { "$ref": "#/components/schemas/property.common.phone_number" }, "delivery_at": { "$ref": "#/components/schemas/property.messages.delivery_at" }, "status_code": { "$ref": "#/components/schemas/property.sms.status_code" }, "gateway_sent_at": { "$ref": "#/components/schemas/property.sms.gateway_sent_at" }, "source": { "$ref": "#/components/schemas/property.messages.source" }, "dlr_code": { "$ref": "#/components/schemas/property.sms.dlr_code" }, "ip": { "$ref": "#/components/schemas/property.common.ip_read" }, "created_at": { "$ref": "#/components/schemas/property.common.created_at" }, "is_unicode": { "$ref": "#/components/schemas/property.messages.is_unicode" }, "uuid": { "$ref": "#/components/schemas/property.common.uuid" }, "iso2": { "$ref": "#/components/schemas/property.common.country_code" }, "voice_lang": { "$ref": "#/components/schemas/property.messages.voice_lang" }, "parts_count": { "$ref": "#/components/schemas/property.sms.parts_count" }, "chars_count": { "$ref": "#/components/schemas/property.sms.chars_count" }, "callback_data": { "$ref": "#/components/schemas/property.common.callback_data" }, "bulk_id": { "$ref": "#/components/schemas/property.sms.bulk_id" }, "key_id": { "$ref": "#/components/schemas/property.common.key_id" }, "service_code": { "$ref": "#/components/schemas/property.messages.service_code" }, "is_text_deleted": { "$ref": "#/components/schemas/property.messages.is_text_deleted" }, "price": { "$ref": "#/components/schemas/property.common.price" }, "is_sent": { "$ref": "#/components/schemas/property.sms.is_sent" }, "requests": { "$ref": "#/components/schemas/property.sms.requests" }, "clicks": { "$ref": "#/components/schemas/property.sms.clicks" }, "attempts_count_max": { "$ref": "#/components/schemas/property.sms.attempts_count_max" } } }, "schema.sms-sms_read": { "type": "object", "description": "SMS", "deprecated": false, "readOnly": true, "properties": { "text": { "$ref": "#/components/schemas/property.sms.text" }, "sender_id": { "$ref": "#/components/schemas/property.messages.sender_id" }, "phone": { "$ref": "#/components/schemas/property.common.phone_number" }, "delivery_at": { "$ref": "#/components/schemas/property.messages.delivery_at" }, "status_code": { "$ref": "#/components/schemas/property.sms.status_code" }, "gateway_sent_at": { "$ref": "#/components/schemas/property.sms.gateway_sent_at" }, "source": { "$ref": "#/components/schemas/property.messages.source" }, "dlr_code": { "$ref": "#/components/schemas/property.sms.dlr_code" }, "ip": { "$ref": "#/components/schemas/property.common.ip_read" }, "created_at": { "$ref": "#/components/schemas/property.common.created_at" }, "is_unicode": { "$ref": "#/components/schemas/property.messages.is_unicode" }, "uuid": { "$ref": "#/components/schemas/property.common.uuid" }, "iso2": { "$ref": "#/components/schemas/property.common.country_code" }, "voice_lang": { "$ref": "#/components/schemas/property.messages.voice_lang" }, "parts_count": { "$ref": "#/components/schemas/property.sms.parts_count" }, "chars_count": { "$ref": "#/components/schemas/property.sms.chars_count" }, "callback_data": { "$ref": "#/components/schemas/property.common.callback_data" }, "bulk_id": { "$ref": "#/components/schemas/property.sms.bulk_id" }, "key_id": { "$ref": "#/components/schemas/property.common.key_id" }, "service_code": { "$ref": "#/components/schemas/property.messages.service_code" }, "is_text_deleted": { "$ref": "#/components/schemas/property.messages.is_text_deleted" }, "price": { "$ref": "#/components/schemas/property.common.price" }, "is_sent": { "$ref": "#/components/schemas/property.sms.is_sent" }, "requests": { "$ref": "#/components/schemas/property.sms.requests" }, "clicks": { "$ref": "#/components/schemas/property.sms.clicks" }, "attempts_count_max": { "$ref": "#/components/schemas/property.sms.attempts_count_max" } } }, "schema.sms-write": { "type": "object", "description": "SMS", "deprecated": false, "required": [ "sender_id", "text", "phone" ], "if": { "properties": { "service_code": { "enum": [ "text2speech", "text2speech_ssml" ] } }, "required": [ "service_code" ] }, "then": { "unevaluatedProperties": true }, "else": { "properties": { "attempts_count_max": { "enum": [ null ] } }, "unevaluatedProperties": true }, "properties": { "text": { "$ref": "#/components/schemas/property.sms.text", "minLength": 1 }, "sender_id": { "$ref": "#/components/schemas/property.messages.sender_id" }, "phone": { "$ref": "#/components/schemas/property.common.phone_number" }, "delivery_at": { "oneOf": [ { "$ref": "#/components/schemas/property.messages.delivery_at" }, { "type": "null" } ] }, "source": { "$ref": "#/components/schemas/property.messages.source" }, "is_unicode": { "$ref": "#/components/schemas/property.messages.is_unicode" }, "voice_lang": { "$ref": "#/components/schemas/property.messages.voice_lang" }, "callback_data": { "$ref": "#/components/schemas/property.common.callback_data" }, "service_code": { "oneOf": [ { "$ref": "#/components/schemas/property.messages.service_code" }, { "type": "null" } ] }, "is_text_deleted": { "oneOf": [ { "$ref": "#/components/schemas/property.messages.is_text_deleted" }, { "type": "null" } ] }, "attempts_count_max": { "$ref": "#/components/schemas/property.sms.attempts_count_max" } } }, "property.sms.deleted_sms_count_cancel": { "description": "Count of the SMS which was canceled", "type": "integer", "minimum": 0 }, "schema.sms-batch-cancel-response": { "type": "object", "readOnly": true, "properties": { "deleted_sms_count": { "$ref": "#/components/schemas/property.sms.deleted_sms_count_cancel" } }, "description": "Batch cancel operation response" }, "property.sms.deleted_sms_count_delete": { "description": "Count of the SMS which was deleted", "type": "integer", "minimum": 0 }, "schema.sms-batch-delete-response": { "type": "object", "readOnly": true, "properties": { "deleted_sms_count": { "$ref": "#/components/schemas/property.sms.deleted_sms_count_delete" } }, "description": "Batch delete operation response" }, "property.sms_clicks.requests_count": { "type": "integer", "description": "N\u00famero de solicita\u00e7\u00f5es para cliques de SMS" }, "schema.sms_clicks.jsonld-short_link_msg_read": { "type": "object", "description": "Clicks by sms", "readOnly": true, "deprecated": false, "properties": { "@id": { "$ref": "#/components/schemas/property._jsonld_id" }, "@type": { "$ref": "#/components/schemas/property._jsonld_type" }, "@context": { "$ref": "#/components/schemas/property._jsonld_context" }, "uuid": { "$ref": "#/components/schemas/property.common.uuid" }, "created_at": { "$ref": "#/components/schemas/property.common.created_at" }, "requests_count": { "$ref": "#/components/schemas/property.sms_clicks.requests_count" } } }, "schema.sms_clicks-short_link_msg_read": { "type": "object", "description": "Clicks by sms", "deprecated": false, "readOnly": true, "properties": { "uuid": { "$ref": "#/components/schemas/property.common.uuid" }, "created_at": { "$ref": "#/components/schemas/property.common.created_at" }, "requests_count": { "$ref": "#/components/schemas/property.sms_clicks.requests_count" } } }, "property.blocked_numbers.number": { "type": "string", "description": "Phone number in international format", "pattern": "^\\+[0-9]{4,20}$", "example": "+1234567890" }, "property.blocked_numbers.type": { "type": "integer", "enum": [ 1, 2 ], "description": "Blocked number's type:\n- `1` - blocked by customer\n- `2` - unsubscribed by user" }, "property.blocked_numbers.id": { "type": "integer", "minimum": 1, "description": "Unique identifier" }, "schema.blocked_numbers.jsonld-blocked_number_read": { "type": "object", "description": "Blocked phone number - JSON-LD read representation", "deprecated": false, "readOnly": true, "properties": { "@id": { "$ref": "#/components/schemas/property._jsonld_id" }, "@type": { "$ref": "#/components/schemas/property._jsonld_type" }, "@context": { "$ref": "#/components/schemas/property._jsonld_context" }, "id": { "$ref": "#/components/schemas/property.blocked_numbers.id" }, "number": { "$ref": "#/components/schemas/property.blocked_numbers.number" }, "type": { "$ref": "#/components/schemas/property.blocked_numbers.type" }, "added_at": { "type": "string", "format": "date-time", "description": "Date and time when the number was added to the blocked list (ISO 8601)", "readOnly": true, "example": "2025-08-22T08:06:56+00:00" } }, "required": [ "id", "number", "type", "added_at" ] }, "schema.blocked_numbers-blocked_number_read": { "type": "object", "description": "Blocked phone number - read representation", "deprecated": false, "readOnly": true, "properties": { "id": { "$ref": "#/components/schemas/property.blocked_numbers.id" }, "number": { "$ref": "#/components/schemas/property.blocked_numbers.number" }, "type": { "$ref": "#/components/schemas/property.blocked_numbers.type" }, "added_at": { "type": "string", "format": "date-time", "description": "Date and time when the number was added to the blocked list (ISO 8601)", "readOnly": true, "example": "2025-08-22T08:06:56+00:00" } }, "required": [ "id", "number", "type", "added_at" ] }, "schema.blocked_numbers-blocked_number_write": { "type": "object", "description": "Blocked phone number - write representation", "deprecated": false, "writeOnly": true, "properties": { "number": { "$ref": "#/components/schemas/property.blocked_numbers.number" } }, "required": [ "number" ] }, "routing_step_telegram": { "type": "object", "description": "Etapa de roteamento do Telegram. Entrega o c\u00f3digo de verifica\u00e7\u00e3o atrav\u00e9s de uma mensagem do bot do Telegram.", "required": [ "channel" ], "properties": { "channel": { "type": "string", "description": "Canal de entrega: Telegram.", "enum": [ "telegram" ] }, "timeout_sec": { "type": [ "integer", "null" ], "description": "Tempo em segundos para aguardar uma resposta do Telegram antes de recuar para a pr\u00f3xima etapa. Se n\u00e3o definido, \u00e9 usado um padr\u00e3o do sistema.", "minimum": 30, "maximum": 3600, "default": 30, "example": 30 } } }, "routing_step_voice": { "type": "object", "description": "Etapa de roteamento por voz. Entrega o c\u00f3digo de verifica\u00e7\u00e3o atrav\u00e9s de uma chamada de voz automatizada.", "required": [ "channel", "sender_id" ], "properties": { "channel": { "type": "string", "description": "Canal de entrega: Chamada de voz.", "enum": [ "voice" ] }, "sender_id": { "type": "string", "description": "N\u00famero de telefone do remetente no formato E.164. Se sender_id n\u00e3o estiver em conformidade com o formato E.164 (por exemplo, sem o prefixo +, contendo caracteres n\u00e3o num\u00e9ricos), a chamada ser\u00e1 feita a partir do n\u00famero padr\u00e3o do sistema +493075435114. Alguns provedores de telefonia downstream podem substituir o n\u00famero de remetente definido pelo utilizador.", "minLength": 1, "example": "+493075435114" }, "template": { "type": [ "string", "null" ], "description": "Modelo de mensagem personalizado. O texto \u00e9 automaticamente envolvido em tags SSML ``. Use `{{code}}` como espa\u00e7o reservado para o c\u00f3digo de verifica\u00e7\u00e3o. Se n\u00e3o fornecido, \u00e9 usado um modelo padr\u00e3o traduzido com base no campo `lang`.", "maxLength": 70, "example": "Your code is {{code}}" } } }, "routing_step_sms": { "type": "object", "description": "Etapa de roteamento SMS. Entrega o c\u00f3digo de verifica\u00e7\u00e3o por SMS.", "required": [ "channel", "sender_id" ], "properties": { "channel": { "type": "string", "description": "Canal de entrega: SMS.", "enum": [ "sms" ] }, "sender_id": { "type": "string", "description": "N\u00famero de telefone ou ID alfanum\u00e9rico do remetente exibido no dispositivo do destinat\u00e1rio. Validado com os IDs de remetente permitidos da sua conta.", "minLength": 1, "example": "LOX24" }, "template": { "type": [ "string", "null" ], "description": "Modelo de mensagem personalizado. Use `{{code}}` como espa\u00e7o reservado para o c\u00f3digo de verifica\u00e7\u00e3o. Se n\u00e3o fornecido, \u00e9 usado um modelo padr\u00e3o traduzido com base no campo `lang`.", "maxLength": 70, "example": "Your code is {{code}}" } } }, "verify_code_read": { "type": "object", "description": "Resposta de leitura do c\u00f3digo de verifica\u00e7\u00e3o. Cont\u00e9m os detalhes completos do pedido de c\u00f3digo de verifica\u00e7\u00e3o, incluindo o estado atual, hist\u00f3rico de entrega e informa\u00e7\u00f5es de custo.", "properties": { "id": { "type": "string", "description": "Identificador \u00fanico (UUID) do pedido de c\u00f3digo de verifica\u00e7\u00e3o.", "readOnly": true, "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, "user_id": { "type": "integer", "description": "ID do utilizador que criou o pedido de c\u00f3digo de verifica\u00e7\u00e3o.", "readOnly": true, "example": 12345 }, "phone": { "type": "string", "description": "N\u00famero de telefone do destinat\u00e1rio em formato internacional.", "example": "+491701234567" }, "code": { "type": [ "string", "null" ], "description": "O valor do c\u00f3digo de verifica\u00e7\u00e3o. Se `is_code_deleted` foi definido e a tarefa conclu\u00edda, o c\u00f3digo estar\u00e1 ausente.", "example": "1234" }, "code_length": { "type": [ "integer", "null" ], "description": "Comprimento do c\u00f3digo de verifica\u00e7\u00e3o.", "example": 4 }, "lang": { "type": "string", "description": "Idioma usado para o modelo de mensagem.", "enum": [ "EN", "DE", "FR", "IT", "ES", "PL", "NL", "RO", "PT", "CS", "HU", "SV", "DA", "FI", "SK", "HR", "TR", "RU", "BG", "UK" ], "example": "DE" }, "routing_strategy": { "type": "array", "description": "Lista ordenada de canais de entrega que foram configurados para este pedido.", "items": { "discriminator": { "propertyName": "channel" }, "oneOf": [ { "$ref": "#/components/schemas/routing_step_telegram" }, { "$ref": "#/components/schemas/routing_step_voice" }, { "$ref": "#/components/schemas/routing_step_sms" } ] } }, "status": { "type": "integer", "description": "Estado atual do c\u00f3digo de verifica\u00e7\u00e3o: 0 = Novo, 5 = Em andamento, 10 = Sucesso, 20 = Falhado, 100 = Erro.", "readOnly": true, "enum": [ 0, 5, 10, 20, 100 ] }, "delivered_channel": { "type": [ "string", "null" ], "description": "O canal que entregou com sucesso o c\u00f3digo de verifica\u00e7\u00e3o. Null se ainda n\u00e3o foi entregue ou se a entrega falhou.", "readOnly": true, "enum": [ "telegram", "voice", "sms", null ] }, "cost": { "type": [ "integer", "null" ], "description": "Custo total do pedido de verifica\u00e7\u00e3o em c\u00eantimos de euro. Null at\u00e9 que o processamento seja conclu\u00eddo.", "readOnly": true, "example": 5 }, "currency": { "type": [ "string", "null" ], "description": "C\u00f3digo da moeda para o custo.", "readOnly": true, "example": "EUR" }, "payload": { "type": [ "string", "null" ], "description": "Dados de payload personalizados do pedido original." }, "created_at": { "type": "integer", "description": "Timestamp Unix de quando o c\u00f3digo de verifica\u00e7\u00e3o foi criado.", "readOnly": true, "example": 1735689600 }, "updated_at": { "type": "integer", "description": "Timestamp Unix da \u00faltima atualiza\u00e7\u00e3o.", "readOnly": true, "example": 1735689660 }, "history": { "type": "array", "description": "Hist\u00f3rico de processamento para cada tentativa de canal. Uma entrada por etapa de roteamento.", "readOnly": true, "items": { "type": "object", "properties": { "id": { "type": "string", "description": "UUID da entrada do hist\u00f3rico." }, "channel": { "type": "string", "description": "Tipo de canal para esta tentativa.", "enum": [ "telegram", "voice", "sms" ] }, "status": { "type": "integer", "description": "Estado desta tentativa de canal: 0 = Novo, 5 = Em andamento, 10 = Sucesso, 20 = Falhado, 100 = Erro." }, "processed_at": { "type": "integer", "description": "Timestamp Unix de quando esta etapa foi processada." }, "external_id": { "type": [ "string", "null" ], "description": "ID da mensagem do provedor externo." } } } }, "is_code_deleted": { "type": [ "boolean", "null" ], "description": "Se o c\u00f3digo de verifica\u00e7\u00e3o foi eliminado do armazenamento ap\u00f3s ser enviado ao destinat\u00e1rio." } } }, "verify_code_write": { "type": "object", "description": "Payload de escrita do c\u00f3digo de verifica\u00e7\u00e3o. Cria um novo pedido de c\u00f3digo de verifica\u00e7\u00e3o com uma estrat\u00e9gia de roteamento em v\u00e1rias etapas.", "required": [ "phone", "routing_strategy" ], "properties": { "phone": { "type": "string", "description": "N\u00famero de telefone do destinat\u00e1rio em formato internacional (ex. +491701234567).", "minLength": 5, "maxLength": 30, "example": "+491701234567" }, "code": { "type": [ "string", "null" ], "description": "C\u00f3digo de verifica\u00e7\u00e3o personalizado. Se n\u00e3o for fornecido, um c\u00f3digo num\u00e9rico aleat\u00f3rio \u00e9 gerado automaticamente com base em `code_length`.", "minLength": 4, "maxLength": 8, "example": "1234" }, "code_length": { "type": [ "integer", "null" ], "description": "Comprimento do c\u00f3digo de verifica\u00e7\u00e3o gerado automaticamente. Usado apenas quando `code` n\u00e3o \u00e9 fornecido. Padr\u00e3o: 4.", "minimum": 4, "maximum": 8, "default": 4, "example": 6 }, "lang": { "type": "string", "description": "Idioma para o modelo de mensagem padr\u00e3o. Determina o idioma do texto SMS/Voz gerado automaticamente quando nenhum `template` personalizado \u00e9 fornecido. N\u00e3o se aplica ao canal `telegram` \u2014 o Telegram sempre envia uma mensagem do sistema no idioma da aplica\u00e7\u00e3o Telegram do utilizador.", "default": "DE", "enum": [ "EN", "DE", "FR", "IT", "ES", "PL", "NL", "RO", "PT", "CS", "HU", "SV", "DA", "FI", "SK", "HR", "TR", "RU", "BG", "UK" ], "example": "EN" }, "payload": { "type": [ "string", "null" ], "description": "Dados personalizados que ser\u00e3o armazenados com o c\u00f3digo de verifica\u00e7\u00e3o e retornados nos eventos de webhook. \u00datil para correlacionar pedidos de verifica\u00e7\u00e3o com os seus sistemas internos.", "maxLength": 128, "example": "session_abc123" }, "is_code_deleted": { "type": [ "boolean", "null" ], "description": "Se verdadeiro, o c\u00f3digo de verifica\u00e7\u00e3o ser\u00e1 eliminado do armazenamento ap\u00f3s ser enviado ao destinat\u00e1rio. Padr\u00e3o: false.", "default": false }, "routing_strategy": { "type": "array", "description": "Lista ordenada de canais de entrega. Cada etapa define um canal a tentar. Se um canal falhar ou expirar, a pr\u00f3xima etapa \u00e9 tentada. Pelo menos uma etapa \u00e9 necess\u00e1ria. O canal `sms` s\u00f3 pode ser a \u00faltima etapa. Canais duplicados n\u00e3o s\u00e3o permitidos.", "minItems": 1, "items": { "discriminator": { "propertyName": "channel" }, "oneOf": [ { "$ref": "#/components/schemas/routing_step_telegram" }, { "$ref": "#/components/schemas/routing_step_voice" }, { "$ref": "#/components/schemas/routing_step_sms" } ] } } } }, "property.common.api_version": { "type": "string", "description": "Vers\u00e3o da estrutura de dados do webhook de notifica\u00e7\u00e3o", "example": "2022-05-25" }, "property.common.event_name": { "type": "string", "description": "Nome do evento do Webhook" }, "property.common.attempt_total": { "type": "integer", "description": "N\u00famero total de tentativas de entrega de webhooks de notifica\u00e7\u00e3o", "minimum": 1, "maximum": 4, "example": 4 }, "property.common.attempt_number": { "type": "integer", "description": "N\u00famero atual da tentativa de notifica\u00e7\u00e3o do webhook", "minimum": 1, "example": 1 }, "webhook.event": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/property.common.uuid" }, "api_version": { "$ref": "#/components/schemas/property.common.api_version" }, "name": { "$ref": "#/components/schemas/property.common.event_name" }, "created_at": { "$ref": "#/components/schemas/property.common.created_at" }, "attempt_total": { "$ref": "#/components/schemas/property.common.attempt_total" }, "attempt_number": { "$ref": "#/components/schemas/property.common.attempt_number" }, "notification_task_id": { "type": "string", "format": "uuid", "description": "Notification task identifier (request identifier)", "example": "3378de83-de66-4de8-9d29-2b10d41bb641" } }, "description": "Base webhook event envelope with metadata" }, "schema.webhooks.sms-delivery-data": { "type": "object", "description": "Data for sms.delivery and sms.delivery.dryrun events", "properties": { "id": { "$ref": "#/components/schemas/property.common.uuid" }, "key_id": { "$ref": "#/components/schemas/property.common.key_id" }, "dlr_code": { "$ref": "#/components/schemas/property.sms.dlr_code" }, "status_code": { "$ref": "#/components/schemas/property.sms.status_code" }, "callback_data": { "$ref": "#/components/schemas/property.common.callback_data" } } }, "schema.webhooks.sms-incoming-data": { "type": "object", "description": "Data for sms.incoming events", "properties": { "id": { "$ref": "#/components/schemas/property.common.uuid" }, "to": { "$ref": "#/components/schemas/property.common.phone_number" }, "from": { "$ref": "#/components/schemas/property.common.phone_number" }, "received_at": { "$ref": "#/components/schemas/property.incomings.received_at" }, "text": { "$ref": "#/components/schemas/property.incomings.text" }, "msg_uuid": { "$ref": "#/components/schemas/property.incomings.msg_uuid" } } }, "schema.email2bulk": { "type": "object", "description": "Email object for bulk email events", "properties": { "id": { "type": "string", "description": "Email identifier" }, "from": { "type": "string", "format": "email", "description": "Sender email address" }, "to": { "type": "string", "format": "email", "description": "Destination email address" }, "subject": { "type": "string", "description": "Email subject line" }, "body": { "type": "string", "description": "Email body content" } } }, "schema.webhooks.bulk-email-parsing-fail-data": { "type": "object", "description": "Data for bulk.email.parsing.fail events", "properties": { "field": { "type": "string", "description": "Field related to the error", "example": "recipient" }, "description": { "type": "string", "description": "Error description", "example": "Invalid phone number format" }, "email": { "$ref": "#/components/schemas/schema.email2bulk" } } }, "schema.webhooks.bulk-email-parsing-success-data": { "type": "object", "description": "Data for bulk.email.parsing.success events", "properties": { "bulk": { "type": "object", "description": "SMS Bulk response object", "properties": { "id": { "$ref": "#/components/schemas/property.common.uuid" }, "status": { "$ref": "#/components/schemas/property.bulks.status_code" }, "created_at": { "$ref": "#/components/schemas/property.common.created_at" } } }, "email": { "$ref": "#/components/schemas/schema.email2bulk" } } }, "schema.webhooks.fraud-check-done-data": { "type": "object", "description": "Data for fraud-check.done events", "additionalProperties": true }, "schema.webhooks.sms-email-parsing-success-data": { "type": "object", "description": "Data for sms.email.parsing.success events", "properties": { "sms": { "type": "array", "description": "Array of SMS data from parsed email", "items": { "type": "object", "properties": { "uuid": { "$ref": "#/components/schemas/property.common.uuid" }, "to": { "$ref": "#/components/schemas/property.common.phone_number" }, "text": { "$ref": "#/components/schemas/property.sms.text" } } } }, "email": { "$ref": "#/components/schemas/schema.email2bulk" } } }, "schema.webhooks.sms-email-parsing-fail-data": { "type": "object", "description": "Data for sms.email.parsing.fail events", "properties": { "field": { "type": "string", "description": "Field related to the error", "example": "recipient" }, "description": { "type": "string", "description": "Error description", "example": "Invalid phone number format" }, "email": { "$ref": "#/components/schemas/schema.email2bulk" } } }, "schema.webhooks.phone-unsubscribe-data": { "type": "object", "properties": { "phone": { "type": "string", "description": "N\u00famero de telefone que cancelou a inscri\u00e7\u00e3o", "example": "+436766304011" }, "user_id": { "type": "integer", "description": "ID do usu\u00e1rio associado ao n\u00famero de telefone", "example": 2 }, "created_at": { "type": "integer", "description": "Unix timestamp when the unsubscribe occurred", "example": 1757849748 }, "campaign_code": { "type": "string", "description": "C\u00f3digo da campanha associado ao cancelamento", "example": "3KCKb5nMD" }, "additional_data": { "type": "object", "properties": { "reason": { "type": "object", "properties": { "id": { "type": "integer", "enum": [ 1, 2, 3, 4, 5, 6 ], "description": "ID do motivo para o cancelamento. Valores poss\u00edveis:\n- 1: Nunca me inscrevi\n- 2: Muitas mensagens\n- 3: N\u00e3o me interessa\n- 4: O conte\u00fado \u00e9 incompreens\u00edvel\n- 5: N\u00e3o gosto da sua empresa\n- 6: Outro", "example": 4 }, "label": { "type": "string", "description": "Motivo leg\u00edvel para o cancelamento", "example": "Content is incomprehensible" } }, "required": [ "id", "label" ] }, "additional_text": { "type": "string", "description": "Texto adicional fornecido pelo usu\u00e1rio", "example": "Additional text from user input" } }, "required": [ "reason", "additional_text" ] }, "short_link_code": { "type": "string", "description": "C\u00f3digo do link curto associado ao cancelamento", "example": "baaIou" }, "unsubscribe_request_id": { "type": "integer", "description": "ID da solicita\u00e7\u00e3o de cancelamento", "example": 59 }, "group_id": { "type": "integer", "description": "ID do grupo associado ao cancelamento do telefone", "example": 123 }, "timestamp": { "description": "Timestamp Unix quando o cancelamento ocorreu" } }, "required": [ "phone", "user_id", "created_at", "campaign_code", "additional_data", "short_link_code", "unsubscribe_request_id" ], "description": "Phone unsubscribe webhook data payload" }, "schema.webhooks.phone-subscribe-data": { "type": "object", "properties": { "phone": { "type": "string", "description": "N\u00famero de telefone que se inscreveu", "example": "+99559122567" }, "user_id": { "type": "integer", "description": "ID do usu\u00e1rio associado ao n\u00famero de telefone", "example": 21911 }, "created_at": { "type": "integer", "description": "Unix timestamp when the subscribe occurred", "example": 1757926648 }, "campaign_code": { "type": "string", "description": "C\u00f3digo da campanha associado \u00e0 inscri\u00e7\u00e3o", "example": "1dkGdCC2xnBc" }, "additional_data": { "type": "array", "description": "Dados adicionais relacionados ao evento de inscri\u00e7\u00e3o", "items": { "type": "object" }, "example": [] }, "short_link_code": { "type": "string", "description": "C\u00f3digo do link curto associado \u00e0 inscri\u00e7\u00e3o", "example": "baaIoP" }, "group_id": { "type": "integer", "description": "ID do grupo associado \u00e0 inscri\u00e7\u00e3o do telefone", "example": 123 }, "timestamp": { "description": "Timestamp Unix quando a inscri\u00e7\u00e3o ocorreu" } }, "required": [ "phone", "user_id", "created_at", "campaign_code", "additional_data", "short_link_code", "group_id" ], "description": "Phone subscribe webhook data payload" }, "schema.webhooks.verify-code-data": { "type": "object", "description": "Data for verify_code.success, verify_code.failed and verify_code.channel.updated events", "properties": { "id": { "type": "string", "description": "Verify code ID (UUID)", "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, "user_id": { "type": "integer", "description": "User ID", "example": 12345 }, "phone": { "type": "string", "description": "Phone number", "example": "+4915112345678" }, "routing_strategy": { "type": "array", "description": "Routing strategy configuration", "items": { "type": "object", "properties": { "channel": { "type": "string", "enum": [ "telegram", "sms" ] }, "timeout_sec": { "type": "integer", "description": "Timeout in seconds. Only applicable for the telegram channel." }, "sender_id": { "type": "string" } } } }, "status": { "type": "integer", "description": "Verify code status" }, "delivered_channel": { "type": [ "string", "null" ], "description": "Channel that delivered the code" }, "cost": { "type": [ "integer", "null" ], "description": "Cost in cents" }, "currency": { "type": [ "string", "null" ], "description": "Currency code" }, "code": { "type": [ "string", "null" ], "description": "Verification code" }, "code_length": { "type": [ "integer", "null" ], "description": "Code length" }, "payload": { "type": [ "string", "null" ], "description": "Custom payload" }, "created_at": { "type": "integer", "description": "Creation timestamp" }, "updated_at": { "type": "integer", "description": "Last update timestamp" }, "history": { "type": "array", "description": "Processing history", "items": { "type": "object", "properties": { "id": { "type": "string" }, "channel": { "type": "string" }, "status": { "type": "integer" }, "processed_at": { "type": "integer" }, "external_id": { "type": "string" } } } }, "is_code_deleted": { "type": "boolean", "description": "Whether the verification code has been deleted from storage after being sent." } } }, "schema.webhooks.verify-code-channel-data": { "type": "object", "description": "Data for verify_code.channel.sent, verify_code.channel.success and verify_code.channel.failed events", "properties": { "id": { "type": "string", "description": "Verify code ID (UUID)", "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, "user_id": { "type": "integer", "description": "User ID", "example": 12345 }, "phone": { "type": "string", "description": "Phone number", "example": "+4915112345678" }, "routing_strategy": { "type": "array", "description": "Routing strategy configuration", "items": { "type": "object", "properties": { "channel": { "type": "string", "enum": [ "telegram", "sms" ] }, "timeout_sec": { "type": "integer", "description": "Timeout in seconds. Only applicable for the telegram channel." }, "sender_id": { "type": "string" } } } }, "status": { "type": "integer", "description": "Verify code status" }, "delivered_channel": { "type": [ "string", "null" ], "description": "Channel that delivered the code" }, "cost": { "type": [ "integer", "null" ], "description": "Cost in cents" }, "currency": { "type": [ "string", "null" ], "description": "Currency code" }, "code": { "type": [ "string", "null" ], "description": "Verification code" }, "code_length": { "type": [ "integer", "null" ], "description": "Code length" }, "payload": { "type": [ "string", "null" ], "description": "Custom payload" }, "created_at": { "type": "integer", "description": "Creation timestamp" }, "updated_at": { "type": "integer", "description": "Last update timestamp" }, "history": { "type": "array", "description": "Processing history", "items": { "type": "object", "properties": { "id": { "type": "string" }, "channel": { "type": "string" }, "status": { "type": "integer" }, "processed_at": { "type": "integer" }, "external_id": { "type": "string" } } } }, "is_code_deleted": { "type": "boolean", "description": "Whether the verification code has been deleted from storage after being sent." }, "channel": { "type": "object", "description": "Channel-specific processing details", "properties": { "id": { "type": "string", "description": "History entry ID" }, "channel": { "type": "string", "description": "Channel type", "enum": [ "telegram", "sms" ] }, "status": { "type": "integer", "description": "Channel processing status" }, "processed_at": { "type": "integer", "description": "Processing timestamp" }, "external_id": { "type": [ "string", "null" ], "description": "External provider ID" }, "error": { "type": [ "string", "null" ], "description": "Error message if failed" }, "cost": { "type": [ "integer", "null" ], "description": "Cost for this channel in cents" } } } } } }, "examples": { "example_bulks_response_get_jsonld": { "summary": "Bulks list (JSON-LD)", "description": "Example response for GET /bulks with Accept: application/ld+json", "value": { "@context": "/contexts/Bulk", "@id": "/bulks", "@type": "Collection", "totalItems": 2, "member": [ { "@id": "/bulks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", "@type": "Bulk", "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "delivery_at": 0, "sender_id": "testbulk", "status_code": 10, "msg_total_count": 1000, "created_at": 1755868416, "processed_at": 1755868500, "ip": "10.1.1.1", "is_unicode": false, "is_dryrun": false, "callback_data": null, "service_code": "direct", "key_id": 8291, "source": 0, "voice_lang": null, "is_text_deleted": false, "msg_total_cost": 56, "requests": "/bulks/a1b2c3d4-e5f6-7890-abcd-ef1234567890/requests" }, { "@id": "/bulks/b2c3d4e5-f6a7-8901-bcde-f12345678901", "@type": "Bulk", "uuid": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "delivery_at": 1755954816, "sender_id": "testbulk", "status_code": 5, "msg_total_count": 50, "created_at": 1755868500, "processed_at": 1755868600, "ip": "10.1.1.1", "is_unicode": null, "is_dryrun": false, "callback_data": null, "service_code": "direct", "key_id": null, "source": 0, "voice_lang": null, "is_text_deleted": false, "msg_total_cost": 3.5, "requests": "/bulks/b2c3d4e5-f6a7-8901-bcde-f12345678901/requests" } ], "search": { "@type": "IriTemplate", "template": "/bulks{?page,uuid,uuid[],_order[created_at],_order[delivery_at],_order[processed_at],_order[msg_total_count],text,sender_id,status_code,status_code[],created_at,created_at[],delivery_at,delivery_at[],processed_at,processed_at[],msg_total_count,msg_total_count[],source,source[],key_id,key_id[],is_unicode,is_dryrun,exists[is_unicode]}", "variableRepresentation": "BasicRepresentation", "mapping": [] } } }, "example_bulks_response_get": { "summary": "Bulks list", "description": "Example response for GET /bulks with Accept: application/json", "value": [ { "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "delivery_at": 0, "sender_id": "testbulk", "status_code": 10, "msg_total_count": 1000, "created_at": 1755868416, "processed_at": 1755868500, "ip": "10.1.1.1", "is_unicode": false, "is_dryrun": false, "callback_data": null, "service_code": "direct", "key_id": 8291, "source": 0, "voice_lang": null, "is_text_deleted": false, "msg_total_cost": 56, "requests": "/bulks/a1b2c3d4-e5f6-7890-abcd-ef1234567890/requests" }, { "uuid": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "delivery_at": 1755954816, "sender_id": "testbulk", "status_code": 5, "msg_total_count": 50, "created_at": 1755868500, "processed_at": 1755868600, "ip": "10.1.1.1", "is_unicode": null, "is_dryrun": false, "callback_data": null, "service_code": "direct", "key_id": null, "source": 0, "voice_lang": null, "is_text_deleted": false, "msg_total_cost": 3.5, "requests": "/bulks/b2c3d4e5-f6a7-8901-bcde-f12345678901/requests" } ] }, "example_bulks_request": { "summary": "Create bulk with static text and phones", "description": "Example of creating a bulk with static text to multiple phone numbers", "value": { "sender_id": "testbulk", "text": "Hello! This is a test bulk message.", "phones": [ "+49751234567", "+49751234568", "+49751234569" ], "service_code": "direct" } }, "example_bulks_response_post_jsonld": { "summary": "Bulk created (JSON-LD)", "description": "Example response for POST /bulks with Accept: application/ld+json", "value": { "@context": "/contexts/Bulk", "@id": "/bulks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", "@type": "Bulk", "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "delivery_at": 0, "sender_id": "testbulk", "text": "Hello! This is a test bulk message.", "phones": [ "+49751234567", "+49751234568", "+49751234569" ], "msg_groups": [ 7116, 7117 ], "status_code": 10, "msg_total_count": 1000, "created_at": 1755868416, "processed_at": 1755868500, "ip": "10.1.1.1", "is_unicode": false, "is_dryrun": false, "service_code": "direct", "key_id": 8291, "source": 0, "voice_lang": null, "is_text_deleted": false, "msg_total_cost": 56 } }, "example_bulks_response_post": { "summary": "Bulk created", "description": "Example response for POST /bulks with Accept: application/json", "value": { "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "delivery_at": 0, "sender_id": "testbulk", "text": "Hello! This is a test bulk message.", "phones": [ "+49751234567", "+49751234568", "+49751234569" ], "msg_groups": [ 7116, 7117 ], "status_code": 10, "msg_total_count": 1000, "created_at": 1755868416, "processed_at": 1755868500, "ip": "10.1.1.1", "is_unicode": false, "is_dryrun": false, "service_code": "direct", "key_id": 8291, "source": 0, "voice_lang": null, "is_text_deleted": false, "msg_total_cost": 56 } }, "user_pricelist": { "summary": "User price list for Germany in EUR", "description": "Example response for /me/pricelist/de?currency=eur with authentication. Shows single prices per service based on user's price level.", "value": { "country": "DE", "name": "Germany", "currency": "EUR", "requirements": null, "rates": { "pro": 0.06, "economy": 0.044, "direct": 0.062, "text2speech": 0.032 } } }, "pricelist": { "summary": "Price list for Italy in CHF", "description": "Example response for /pricelist/it?currency=chf", "value": { "country": "IT", "name": "Italy", "currency": "CHF", "requirements": "Text Sender-ID needs to be registered. Only for companies with VAT and PEC in ITALY. Numeric sender-ID possible.", "rates": { "pro": [ 0.06, 0.05, 0.049, 0.048 ], "economy": [ 0.05, 0.044, 0.043, 0.042 ], "direct": [ 0.072, 0.062, 0.061, 0.06 ], "text2speech": [ 0.038, 0.032, 0.031, 0.03 ] } } }, "invoices.jsonld": { "summary": "Invoice list example (JSON-LD)", "description": "Example response for GET /invoices with Accept: application/ld+json", "value": { "@context": "/contexts/Invoice", "@id": "/invoices", "@type": "Collection", "totalItems": 1, "member": [ { "@id": "/invoices/44969", "@type": "Invoice", "id": "44969", "created_at": 1626123015, "amount": 24.63, "currency": "EUR", "status": 1, "payment_type": 7, "paid_at": 1626123015, "client_name": "Example Customer Ltd.", "client_address": "Main Street 42\n12345 Example City", "client_info": "John Doe", "vat": 19, "vat_id": "DE123456789", "vat_val": 3.93, "fee": 3.5, "fee_val": 0.72, "net_val": 19.98, "iso2": "DE", "custom_text": "PO-2024-001", "pdf": "/invoices/44969/pdf", "credit_note": null } ], "view": { "@id": "/invoices?page=1", "@type": "PartialCollectionView" }, "search": { "@type": "IriTemplate", "template": "/invoices{?_order[created_at],_order[amount],status,status[],payment_type,payment_type[],id,id[],createdAt[between],createdAt[gt],createdAt[gte],createdAt[lt],createdAt[lte],amount[between],amount[gt],amount[gte],amount[lt],amount[lte],paidAt[between],paidAt[gt],paidAt[gte],paidAt[lt],paidAt[lte]}", "variableRepresentation": "BasicRepresentation", "mapping": [ { "@type": "IriTemplateMapping", "variable": "_order[created_at]", "property": "created_at", "required": false }, { "@type": "IriTemplateMapping", "variable": "_order[amount]", "property": "amount", "required": false }, { "@type": "IriTemplateMapping", "variable": "status", "property": "status", "required": false }, { "@type": "IriTemplateMapping", "variable": "status[]", "property": "status", "required": false }, { "@type": "IriTemplateMapping", "variable": "payment_type", "property": "payment_type", "required": false }, { "@type": "IriTemplateMapping", "variable": "payment_type[]", "property": "payment_type", "required": false }, { "@type": "IriTemplateMapping", "variable": "id", "property": "id", "required": false }, { "@type": "IriTemplateMapping", "variable": "id[]", "property": "id", "required": false }, { "@type": "IriTemplateMapping", "variable": "createdAt[between]", "property": "createdAt", "required": false }, { "@type": "IriTemplateMapping", "variable": "createdAt[gt]", "property": "createdAt", "required": false }, { "@type": "IriTemplateMapping", "variable": "createdAt[gte]", "property": "createdAt", "required": false }, { "@type": "IriTemplateMapping", "variable": "createdAt[lt]", "property": "createdAt", "required": false }, { "@type": "IriTemplateMapping", "variable": "createdAt[lte]", "property": "createdAt", "required": false }, { "@type": "IriTemplateMapping", "variable": "amount[between]", "property": "amount", "required": false }, { "@type": "IriTemplateMapping", "variable": "amount[gt]", "property": "amount", "required": false }, { "@type": "IriTemplateMapping", "variable": "amount[gte]", "property": "amount", "required": false }, { "@type": "IriTemplateMapping", "variable": "amount[lt]", "property": "amount", "required": false }, { "@type": "IriTemplateMapping", "variable": "amount[lte]", "property": "amount", "required": false }, { "@type": "IriTemplateMapping", "variable": "paidAt[between]", "property": "paidAt", "required": false }, { "@type": "IriTemplateMapping", "variable": "paidAt[gt]", "property": "paidAt", "required": false }, { "@type": "IriTemplateMapping", "variable": "paidAt[gte]", "property": "paidAt", "required": false }, { "@type": "IriTemplateMapping", "variable": "paidAt[lt]", "property": "paidAt", "required": false }, { "@type": "IriTemplateMapping", "variable": "paidAt[lte]", "property": "paidAt", "required": false } ] } } }, "invoices": { "summary": "Invoice list example (JSON)", "description": "Example response for GET /invoices with Accept: application/json", "value": [ { "id": "44969", "created_at": 1626123015, "amount": 24.63, "currency": "EUR", "status": 1, "payment_type": 7, "paid_at": 1626123015, "client_name": "Example Customer Ltd.", "client_address": "Main Street 42\n12345 Example City", "client_info": "John Doe", "vat": 19, "vat_id": "DE123456789", "vat_val": 3.93, "fee": 3.5, "fee_val": 0.72, "net_val": 19.98, "iso2": "DE", "custom_text": "PO-2024-001", "pdf": "/invoices/44969/pdf", "credit_note": null } ] }, "invoice.jsonld": { "summary": "Invoice detail example (JSON-LD)", "description": "Example response for GET /invoices/{id} with Accept: application/ld+json", "value": { "@context": "/contexts/Invoice", "@id": "/invoices/44969", "@type": "Invoice", "id": "44969", "created_at": 1626123015, "amount": 24.63, "currency": "EUR", "status": 1, "payment_type": 7, "paid_at": 1626123015, "client_name": "Example Customer Ltd.", "client_address": "Main Street 42\n12345 Example City", "client_info": "John Doe", "vat": 19, "vat_id": "DE123456789", "vat_val": 3.93, "fee": 3.5, "fee_val": 0.72, "net_val": 19.98, "iso2": "DE", "custom_text": "PO-2024-001", "pdf": "/invoices/44969/pdf", "credit_note": "/credit_notes/240" } }, "invoice": { "summary": "Invoice detail example", "description": "Example response for GET /invoices/{id}", "value": { "id": "44969", "created_at": 1626123015, "amount": 24.63, "currency": "EUR", "status": 1, "payment_type": 7, "paid_at": 1626123015, "client_name": "Example Customer Ltd.", "client_address": "Main Street 42\n12345 Example City", "client_info": "John Doe", "vat": 19, "vat_id": "DE123456789", "vat_val": 3.93, "fee": 3.5, "fee_val": 0.72, "net_val": 19.98, "iso2": "DE", "custom_text": "PO-2024-001", "pdf": "/invoices/44969/pdf", "credit_note": "/credit_notes/240" } }, "credit_notes.jsonld": { "summary": "Credit note list example (JSON-LD)", "description": "Example response for GET /credit_notes with Accept: application/ld+json", "value": { "@context": "/contexts/CreditNote", "@id": "/credit_notes", "@type": "Collection", "totalItems": 1, "member": [ { "@id": "/credit_notes/240", "@type": "CreditNote", "id": "240", "created_at": 1770140830, "amount": 0.01, "currency": "EUR", "status": 1, "payment_type": 6, "paid_at": 0, "client_name": "Example Customer Ltd.", "client_address": "Main Street 42\n12345 Example City", "client_info": "John Doe", "type": 0, "vat": 19, "vat_id": "DE123456789", "vat_val": 0, "fee": 0, "fee_val": 0, "net_val": 0.01, "iso2": "DE", "custom_text": "CN-2024-001", "pdf": "/credit_notes/240/pdf", "invoice": "/invoices/79484" } ], "view": { "@id": "/credit_notes?page=1", "@type": "PartialCollectionView" }, "search": { "@type": "IriTemplate", "template": "/credit_notes{?_order[created_at],_order[amount],status,status[],payment_type,payment_type[],id,id[],createdAt[between],createdAt[gt],createdAt[gte],createdAt[lt],createdAt[lte],amount[between],amount[gt],amount[gte],amount[lt],amount[lte],paidAt[between],paidAt[gt],paidAt[gte],paidAt[lt],paidAt[lte]}", "variableRepresentation": "BasicRepresentation", "mapping": [ { "@type": "IriTemplateMapping", "variable": "_order[created_at]", "property": "created_at", "required": false }, { "@type": "IriTemplateMapping", "variable": "_order[amount]", "property": "amount", "required": false }, { "@type": "IriTemplateMapping", "variable": "status", "property": "status", "required": false }, { "@type": "IriTemplateMapping", "variable": "status[]", "property": "status", "required": false }, { "@type": "IriTemplateMapping", "variable": "payment_type", "property": "payment_type", "required": false }, { "@type": "IriTemplateMapping", "variable": "payment_type[]", "property": "payment_type", "required": false }, { "@type": "IriTemplateMapping", "variable": "id", "property": "id", "required": false }, { "@type": "IriTemplateMapping", "variable": "id[]", "property": "id", "required": false }, { "@type": "IriTemplateMapping", "variable": "createdAt[between]", "property": "createdAt", "required": false }, { "@type": "IriTemplateMapping", "variable": "createdAt[gt]", "property": "createdAt", "required": false }, { "@type": "IriTemplateMapping", "variable": "createdAt[gte]", "property": "createdAt", "required": false }, { "@type": "IriTemplateMapping", "variable": "createdAt[lt]", "property": "createdAt", "required": false }, { "@type": "IriTemplateMapping", "variable": "createdAt[lte]", "property": "createdAt", "required": false }, { "@type": "IriTemplateMapping", "variable": "amount[between]", "property": "amount", "required": false }, { "@type": "IriTemplateMapping", "variable": "amount[gt]", "property": "amount", "required": false }, { "@type": "IriTemplateMapping", "variable": "amount[gte]", "property": "amount", "required": false }, { "@type": "IriTemplateMapping", "variable": "amount[lt]", "property": "amount", "required": false }, { "@type": "IriTemplateMapping", "variable": "amount[lte]", "property": "amount", "required": false }, { "@type": "IriTemplateMapping", "variable": "paidAt[between]", "property": "paidAt", "required": false }, { "@type": "IriTemplateMapping", "variable": "paidAt[gt]", "property": "paidAt", "required": false }, { "@type": "IriTemplateMapping", "variable": "paidAt[gte]", "property": "paidAt", "required": false }, { "@type": "IriTemplateMapping", "variable": "paidAt[lt]", "property": "paidAt", "required": false }, { "@type": "IriTemplateMapping", "variable": "paidAt[lte]", "property": "paidAt", "required": false } ] } } }, "credit_notes": { "summary": "Credit note list example (JSON)", "description": "Example response for GET /credit_notes with Accept: application/json", "value": [ { "id": "240", "created_at": 1770140830, "amount": 0.01, "currency": "EUR", "status": 1, "payment_type": 6, "paid_at": 0, "client_name": "Example Customer Ltd.", "client_address": "Main Street 42\n12345 Example City", "client_info": "John Doe", "vat": 19, "vat_id": "DE123456789", "vat_val": 0, "fee": 0, "fee_val": 0, "net_val": 0.01, "iso2": "DE", "custom_text": "CN-2024-001", "pdf": "/credit_notes/240/pdf", "invoice": "/invoices/79484" } ] }, "credit_note.jsonld": { "summary": "Credit note detail example (JSON-LD)", "description": "Example response for GET /credit_notes/{id} with Accept: application/ld+json", "value": { "@context": "/contexts/CreditNote", "@id": "/credit_notes/240", "@type": "CreditNote", "id": "240", "created_at": 1770140830, "amount": 0.01, "currency": "EUR", "status": 1, "payment_type": 6, "paid_at": 0, "client_name": "Example Customer Ltd.", "client_address": "Main Street 42\n12345 Example City", "client_info": "John Doe", "vat": 19, "vat_id": "DE123456789", "vat_val": 0, "fee": 0, "fee_val": 0, "net_val": 0.01, "iso2": "DE", "custom_text": "CN-2024-001", "pdf": "/credit_notes/240/pdf", "invoice": "/invoices/79484" } }, "credit_note": { "summary": "Credit note detail example", "description": "Example response for GET /credit_notes/{id}", "value": { "id": "240", "created_at": 1770140830, "amount": 0.01, "currency": "EUR", "status": 1, "payment_type": 6, "paid_at": 0, "client_name": "Example Customer Ltd.", "client_address": "Main Street 42\n12345 Example City", "client_info": "John Doe", "vat": 19, "vat_id": "DE123456789", "vat_val": 0, "fee": 0, "fee_val": 0, "net_val": 0.01, "iso2": "DE", "custom_text": "CN-2024-001", "pdf": "/credit_notes/240/pdf", "invoice": "/invoices/79484" } }, "payments.jsonld": { "summary": "Payment list (JSON-LD)", "description": "Example response for GET /payments with Accept: application/ld+json", "value": { "@context": "/contexts/PaymentAttempt", "@id": "/payments", "@type": "Collection", "totalItems": 2, "member": [ { "@id": "/payments/123", "@type": "PaymentAttempt", "id": 123, "created_at": 1750152600, "completed_at": null, "status": 20, "amount": 121.38, "net_val": 100, "vat_val": 19.38, "fee_val": 2, "currency": "EUR", "type": 7, "invoice": null, "error": null }, { "@id": "/payments/120", "@type": "PaymentAttempt", "id": 120, "created_at": 1750066200, "completed_at": 1750066200, "status": 100, "amount": 100, "net_val": 100, "vat_val": 0, "fee_val": 0, "currency": "EUR", "type": 6, "invoice": "/invoices/456", "error": null } ], "view": { "@id": "/payments?page=1", "@type": "PartialCollectionView" }, "search": { "@type": "IriTemplate", "template": "/payments{?page,_order[created_at],status,type,id,id[],created_at,created_at[]}", "variableRepresentation": "BasicRepresentation", "mapping": [ { "@type": "IriTemplateMapping", "variable": "page", "property": "page", "required": false }, { "@type": "IriTemplateMapping", "variable": "_order[created_at]", "property": "created_at", "required": false }, { "@type": "IriTemplateMapping", "variable": "status", "property": "status", "required": false }, { "@type": "IriTemplateMapping", "variable": "type", "property": "type", "required": false }, { "@type": "IriTemplateMapping", "variable": "id", "property": "id", "required": false }, { "@type": "IriTemplateMapping", "variable": "id[]", "property": "id", "required": false }, { "@type": "IriTemplateMapping", "variable": "created_at", "property": "created_at", "required": false }, { "@type": "IriTemplateMapping", "variable": "created_at[]", "property": "created_at", "required": false } ] } } }, "payments": { "summary": "Payment list", "description": "Example response for GET /payments with Accept: application/json", "value": [ { "id": 123, "created_at": 1750152600, "completed_at": null, "status": 20, "amount": 121.38, "net_val": 100, "vat_val": 19.38, "fee_val": 2, "currency": "EUR", "type": 7, "invoice": null, "error": null }, { "id": 120, "created_at": 1750066200, "completed_at": 1750066200, "status": 100, "amount": 100, "net_val": 100, "vat_val": 0, "fee_val": 0, "currency": "EUR", "type": 6, "invoice": "/invoices/456", "error": null } ] }, "payment_stored_card": { "summary": "Stored card payment", "description": "Example request for creating a payment with a previously saved credit/debit card", "value": { "net_val": 100, "type": "stored_card", "method_id": 94 } }, "payment_sepa": { "summary": "SEPA direct debit payment", "description": "Example request for creating a payment via SEPA direct debit using an existing mandate", "value": { "net_val": 50, "type": "sepa", "method_id": 747 } }, "payment_created_bank_transfer": { "summary": "Bank transfer payment created", "description": "Example response for a bank transfer payment (no redirect, invoice created immediately)", "value": { "id": 120, "created_at": 1750066200, "completed_at": 1750066200, "status": 100, "amount": 100, "net_val": 100, "vat_val": 0, "fee_val": 0, "currency": "EUR", "type": 6, "invoice": "/invoices/456", "error": null } }, "payment.jsonld": { "summary": "Payment attempt detail (JSON-LD)", "description": "Example response for GET /payments/{id} with Accept: application/ld+json", "value": { "@id": "/payments/123", "@type": "PaymentAttempt", "id": 123, "created_at": 1750152600, "completed_at": null, "status": 20, "amount": 121.38, "net_val": 100, "vat_val": 19.38, "fee_val": 2, "currency": "EUR", "type": 7, "invoice": null, "error": null } }, "payment": { "summary": "Payment attempt detail", "description": "Example response for GET /payments/{id} (payment with redirect URL)", "value": { "id": 123, "created_at": 1750152600, "completed_at": null, "status": 20, "amount": 121.38, "net_val": 100, "vat_val": 19.38, "fee_val": 2, "currency": "EUR", "type": 7, "invoice": null, "error": null } }, "payment_methods": { "summary": "Payment methods example", "description": "Example response for GET /payment_methods", "value": { "sepa_mandate": { "id": 747, "iban_masked": "DExxxxxxxxxxxxxxxx0 00", "last4": "3000", "bank": "", "bic": "37040044", "account_holder": "", "street": "", "postcode": 0, "city": "", "created_at": 1775504768 }, "stored_cards": [ { "id": 94, "last4": "4242", "exp_month": 12, "exp_year": 2034, "brand": "visa", "country": "US", "created_at": 1781775977 } ] } }, "example_sms_request_minimal": { "summary": "Mensagem SMS b\u00e1sica", "description": "Exemplo de uma mensagem SMS simples com apenas campos obrigat\u00f3rios", "value": { "text": "Ol\u00e1! Esta \u00e9 uma mensagem SMS de teste.", "sender_id": "+491701234567", "phone": "+14155552671" } }, "example_sms_request_text2speech": { "summary": "Mensagem de voz com texto simples", "description": "Exemplo de mensagem de voz texto-para-fala com conte\u00fado de texto simples", "value": { "text": "Ol\u00e1, esta mensagem ser\u00e1 convertida em fala e entregue como uma chamada de voz.", "sender_id": "+491701234567", "phone": "+14155552671", "service_code": "text2speech", "voice_lang": "EN" } }, "example_sms_request_text2speech_ssml": { "summary": "Mensagem de voz com SSML", "description": "Exemplo de texto-para-fala com marca\u00e7\u00e3o SSML para s\u00edntese de voz aprimorada", "value": { "text": "Seu c\u00f3digo de verifica\u00e7\u00e3o \u00e9 A1B2C3.Por favor, digite-o agora.", "sender_id": "+491701234567", "phone": "+14155552671", "service_code": "text2speech", "voice_lang": "EN" } }, "example_sms_request_text2speech_single_call": { "summary": "Mensagem de voz com chamada \u00fanica (sem tentativas)", "description": "Exemplo de mensagem de voz sintetizada com conte\u00fado em texto simples e uma \u00fanica tentativa de entrega sem repeti\u00e7\u00f5es.", "value": { "text": "Ol\u00e1, esta mensagem ser\u00e1 convertida em voz e entregue como uma chamada de voz.", "sender_id": "+491701234567", "phone": "+14155552671", "service_code": "text2speech", "voice_lang": "PT", "attempts_count_max": 1 } }, "example_sms_request_unicode": { "summary": "Mensagem SMS Unicode", "description": "Exemplo de SMS com caracteres Unicode (emojis, caracteres especiais, scripts n\u00e3o latinos)", "value": { "text": "\\ud83c\\udf89 Bem-vindos! Welcome! \\u6b22\\u8fce\\u5149\\u4e34! \\u0645\\u0631\\u062d\\u0628\\u0627 \\u0628\\u0643\\u0645!", "sender_id": "+491701234567", "phone": "+14155552671", "is_unicode": true } }, "example_sms_request_translit": { "summary": "Mensagem transliterada", "description": "Exemplo de mensagem com translitera\u00e7\u00e3o de caracteres n\u00e3o GSM para uma SMS GSM pura (ver exemplo de resposta)", "value": { "text": "Nem todos os caracteres especiais est\u00e3o inclu\u00eddos no conjunto de caracteres GSM, ex. apenas o ap\u00f3strofe correto: Carro da Anna funciona, mas n\u00e3o a casa do Max. Acentos funcionam parcialmente: Andr\u00e9, mas n\u00e3o todos: H\u00e1ns. H\u00edfens normais - funcionam, mas n\u00e3o os mais longos: \u2013", "sender_id": "Test", "phone": "+14155552671", "is_unicode": false } }, "example_sms_request_delete_text": { "summary": "Mensagem com exclus\u00e3o de texto", "description": "Exemplo de SMS onde o texto da mensagem ser\u00e1 exclu\u00eddo ap\u00f3s a entrega por seguran\u00e7a/privacidade", "value": { "text": "Seu c\u00f3digo de verifica\u00e7\u00e3o \u00e9: 123456. Esta mensagem ser\u00e1 exclu\u00edda ap\u00f3s a entrega.", "sender_id": "+491701234567", "phone": "+14155552671", "is_text_deleted": true } }, "example_sms_request_callback": { "summary": "SMS com dados de callback", "description": "Exemplo de SMS com dados de callback para notifica\u00e7\u00f5es de status de entrega e rastreamento personalizado", "value": { "text": "Seu pedido #12345 foi enviado e est\u00e1 a caminho!", "sender_id": "+491701234567", "phone": "+14155552671", "callback_data": "order_12345_shipping_notification" } }, "example_sms_response_basic_sms_jsonld": { "summary": "Basic sms Message response", "description": "API response for a successfully request with minimum parameters", "value": { "@context": "/contexts/sms", "@id": "/sms/11111111-2222-3333-4444-555555555555", "@type": "sms", "text": "Hello! This is a test SMS message.", "sender_id": "+19388888025", "phone": "+14155552671", "delivery_at": 0, "status_code": 0, "gateway_sent_at": 0, "source": 0, "dlr_code": 0, "ip": "10.1.1.1", "created_at": 1755868416, "is_unicode": false, "uuid": "11111111-2222-3333-4444-555555555555", "iso2": "US", "voice_lang": null, "parts_count": 1, "chars_count": 34, "callback_data": null, "bulk_id": null, "key_id": 8291, "service_code": "direct", "is_text_deleted": false, "price": 0.056, "is_sent": false, "requests": "/sms/11111111-2222-3333-4444-555555555555/requests", "clicks": "/sms/11111111-2222-3333-4444-555555555555/clicks" } }, "example_sms_response_translit_jsonld": { "summary": "Transliterated message response", "description": "API response for a successfully sent transliterated SMS message", "value": { "@context": "/contexts/sms", "@id": "/sms/11111111-2222-3333-4444-555555555555", "@type": "sms", "text": "Nicht alle Sonderzeichen sind im GSM Zeichensatz enthalten, z.B. nur das richtige Apostroph: Anna's Auto geht, aber nicht Max's Haus. Akzente gehen teilweise: Andr\u00e9, jedoch nicht alle: Hans. Normale Bindestriche - gehen, nicht allerdings l\u00e4ngere: -", "sender_id": "Test", "phone": "+491701234567", "delivery_at": 0, "status_code": 100, "gateway_sent_at": 1755780931, "source": 0, "dlr_code": 16, "ip": "1.1.1.1", "created_at": 1755780931, "is_unicode": false, "uuid": "11111111-2222-3333-4444-555555555555", "iso2": "DE", "voice_lang": "DE", "parts_count": 2, "chars_count": 248, "callback_data": null, "bulk_id": null, "key_id": 200100, "service_code": "direct", "is_text_deleted": false, "price": 0.13, "is_sent": true, "requests": "/sms/11111111-2222-3333-4444-555555555555/requests", "clicks": "/sms/11111111-2222-3333-4444-555555555555/clicks" } }, "example_sms_response_delete_text_jsonld": { "summary": "Message with text deletion response", "description": "API response for a successfully sent SMS with text deletion enabled", "value": { "@context": "/contexts/sms", "@id": "/sms/11111111-2222-3333-4444-555555555555", "@type": "sms", "text": "", "sender_id": "USSender", "phone": "+14155552671", "delivery_at": 0, "status_code": 100, "gateway_sent_at": 1755783151, "source": 0, "dlr_code": 0, "ip": "10.1.1.1", "created_at": 1755783151, "is_unicode": false, "uuid": "11111111-2222-3333-4444-555555555555", "iso2": "US", "voice_lang": null, "parts_count": 1, "chars_count": 79, "callback_data": null, "bulk_id": null, "key_id": 8207, "service_code": "direct", "is_text_deleted": true, "price": 0.07, "is_sent": true, "requests": "/sms/11111111-2222-3333-4444-555555555555/requests", "clicks": "/sms/11111111-2222-3333-4444-555555555555/clicks" } }, "example_sms_response_basic_sms": { "summary": "Basic sms Message response", "description": "API response for a successfully request with minimum parameters", "value": { "text": "Hello! This is a test SMS message.", "sender_id": "+19388888025", "phone": "+14155552671", "delivery_at": 0, "status_code": 0, "gateway_sent_at": 0, "source": 0, "dlr_code": 0, "ip": "10.1.1.1", "created_at": 1755868416, "is_unicode": false, "uuid": "11111111-2222-3333-4444-555555555555", "iso2": "US", "voice_lang": null, "parts_count": 1, "chars_count": 34, "callback_data": null, "bulk_id": null, "key_id": 8291, "service_code": "direct", "is_text_deleted": false, "price": 0.056, "is_sent": false, "requests": "/sms/11111111-2222-3333-4444-555555555555/requests", "clicks": "/sms/11111111-2222-3333-4444-555555555555/clicks" } }, "example_sms_response_translit": { "summary": "Respuesta de mensagem transliterada", "description": "Resposta da API para uma mensagem SMS transliterada enviada com sucesso", "value": { "text": "Nicht alle Sonderzeichen sind im GSM Zeichensatz enthalten, z.B. nur das richtige Apostroph: Anna's Auto geht, aber nicht Max's Haus. Akzente gehen teilweise: Andr\u00e9, jedoch nicht alle: Hans. Normale Bindestriche - gehen, nicht allerdings l\u00e4ngere: -", "sender_id": "Test", "phone": "+491701234567", "delivery_at": 0, "status_code": 100, "gateway_sent_at": 1755780931, "source": 0, "dlr_code": 16, "ip": "1.1.1.1", "created_at": 1755780931, "is_unicode": false, "uuid": "11111111-2222-3333-4444-555555555555", "iso2": "DE", "voice_lang": "DE", "parts_count": 2, "chars_count": 248, "callback_data": null, "bulk_id": null, "key_id": 200100, "service_code": "direct", "is_text_deleted": false, "price": 0.13, "is_sent": true, "requests": "/sms/11111111-2222-3333-4444-555555555555/requests", "clicks": "/sms/11111111-2222-3333-4444-555555555555/clicks" } }, "example_sms_response_delete_text": { "summary": "Resposta de mensagem com exclus\u00e3o de texto", "description": "Resposta da API para um SMS enviado com sucesso com exclus\u00e3o de texto ativada", "value": { "text": "", "sender_id": "USSender", "phone": "+14155552671", "delivery_at": 0, "status_code": 100, "gateway_sent_at": 1755783151, "source": 0, "dlr_code": 0, "ip": "10.1.1.1", "created_at": 1755783151, "is_unicode": false, "uuid": "11111111-2222-3333-4444-555555555555", "iso2": "US", "voice_lang": null, "parts_count": 1, "chars_count": 79, "callback_data": null, "bulk_id": null, "key_id": 8207, "service_code": "direct", "is_text_deleted": true, "price": 0.07, "is_sent": true, "requests": "/sms/11111111-2222-3333-4444-555555555555/requests", "clicks": "/sms/11111111-2222-3333-4444-555555555555/clicks" } }, "blocked_numbers_get_jsonld": { "summary": "Blocked numbers list (JSON-LD)", "description": "Example response for GET /blocked_numbers with Accept: application/ld+json", "value": { "member": [ { "@id": "/blocked_numbers/1", "@type": "BlockedNumber", "id": 1, "number": "+491701234567", "type": 1, "added_at": "2025-08-22T08:06:56+00:00" } ], "hydra:totalItems": 1, "hydra:view": { "@id": "/blocked_numbers?page=1", "@type": "hydra:PartialCollectionView", "hydra:first": "/blocked_numbers?page=1", "hydra:last": "/blocked_numbers?page=1" }, "hydra:search": { "@type": "hydra:IriTemplate", "hydra:template": "/blocked_numbers{?number,type}", "hydra:variableRepresentation": "BasicRepresentation", "hydra:mapping": [] } } }, "blocked_numbers_get": { "summary": "Blocked numbers list", "description": "Example response for GET /blocked_numbers with Accept: application/json", "value": [ { "id": 1, "number": "+491701234567", "type": 1, "added_at": "2025-08-22T08:06:56+00:00" } ] }, "blocked_number_request": { "summary": "Block a phone number", "description": "Example request to block a phone number", "value": { "number": "+491701234567" } }, "blocked_number_post_jsonld": { "summary": "Blocked number created (JSON-LD)", "description": "Example response for POST /blocked_numbers with Accept: application/ld+json", "value": { "@context": "/contexts/BlockedNumber", "@id": "/blocked_numbers/1", "@type": "BlockedNumber", "id": 1, "number": "+491701234567", "type": 1, "added_at": "2025-08-22T08:06:56+00:00" } }, "blocked_number_post": { "summary": "Blocked number created", "description": "Example response for POST /blocked_numbers with Accept: application/json", "value": { "id": 1, "number": "+491701234567", "type": 1, "added_at": "2025-08-22T08:06:56+00:00" } }, "blocked_number_get_jsonld": { "summary": "Blocked number (JSON-LD)", "description": "Example response for GET /blocked_numbers/{id} with Accept: application/ld+json", "value": { "@context": "/contexts/BlockedNumber", "@id": "/blocked_numbers/1", "@type": "BlockedNumber", "id": 1, "number": "+491701234567", "type": 1, "added_at": "2025-08-22T08:06:56+00:00" } }, "blocked_number_get": { "summary": "Blocked number", "description": "Example response for GET /blocked_numbers/{id} with Accept: application/json", "value": { "id": 1, "number": "+491701234567", "type": 1, "added_at": "2025-08-22T08:06:56+00:00" } }, "example_verify_code_request": { "summary": "Verify code with multi-channel routing", "description": "Create a verification code with a 3-step routing strategy: Telegram, Voice, and SMS.", "value": { "phone": "+491701234567", "code": "1234", "is_code_deleted": false, "payload": "yours payload here", "lang": "EN", "routing_strategy": [ { "channel": "telegram", "timeout_sec": 30 }, { "channel": "voice", "sender_id": "LOX24", "template": "Your code is {{code}}" }, { "channel": "sms", "sender_id": "LOX24", "template": "Your code is {{code}}" } ] } }, "example_verify_code_request_telegram": { "summary": "Verify code via Telegram", "description": "Send a verification code through a Telegram bot. The code will be delivered as a Telegram message to the user's chat.", "value": { "phone": "+491701234567", "lang": "EN", "routing_strategy": [ { "channel": "telegram", "timeout_sec": 60 } ] } }, "example_verify_code_request_voice": { "summary": "Verify code via Voice call", "description": "Deliver a verification code through an automated voice call. The code is read aloud to the recipient using a text-to-speech template.", "value": { "phone": "+491701234567", "code_length": 6, "lang": "EN", "routing_strategy": [ { "channel": "voice", "sender_id": "LOX24", "template": "Your verification code is {{code}}" } ] } }, "example_verify_code_response": { "summary": "Verify code response with multi-channel routing", "description": "Successful response after creating a verification code with a 3-step routing strategy. Telegram and voice channels failed, SMS succeeded.", "value": { "id": "d7ad7539-fb8f-4dbb-a7f7-7c40babec969", "user_id": 12345, "phone": "+491701234567", "routing_strategy": [ { "channel": "telegram", "timeout_sec": 30 }, { "channel": "voice", "sender_id": "LOX24", "template": "Your code is {{code}}" }, { "channel": "sms", "sender_id": "LOX24", "template": "Your code is {{code}}" } ], "status": 10, "delivered_channel": "sms", "cost": 120, "currency": "EUR", "code": "1234", "code_length": 4, "payload": "yours payload here", "lang": "EN", "created_at": 1779903448, "updated_at": 1779903510, "history": [ { "id": "bccaff09-59f2-11f1-a685-7c10c91d54a1", "channel": "telegram", "status": 20, "processed_at": 1779903478, "external_id": "tg_msg_001" }, { "id": "bccaff09-59f2-11f1-a685-7c10c91d54a2", "channel": "voice", "status": 20, "processed_at": 1779903490, "external_id": "voice_msg_002" }, { "id": "bccaff09-59f2-11f1-a685-7c10c91d54a3", "channel": "sms", "status": 10, "processed_at": 1779903510, "external_id": "sms_msg_003" } ], "is_code_deleted": false } }, "webhooks.examples.sms-delivery-event": { "summary": "Evento de Entrega SMS", "description": "Evento enviado quando o status de entrega do SMS muda", "value": { "id": "a3cd6e19-8af2-498d-ad07-c7840f1b4ac8", "api_version": "2022-05-25", "name": "sms.delivery", "created_at": 1653378603, "attempt_total": 4, "attempt_number": 1, "data": { "id": "d6c12ac4-cc7d-11ec-b6da-525400bbb7dc", "key_id": 8207, "dlr_code": 1, "status_code": 100, "callback_data": "some data from user's request here" }, "notification_task_id": "3378de83-de66-4de8-9d29-2b10d41bb641" } }, "webhooks.examples.sms-delivery-event-expired": { "summary": "Evento de Entrega SMS Expirada", "description": "Evento enviado quando a entrega do SMS expira", "value": { "id": "a3cd6e19-8af2-498d-ad07-c7840f1b4ac8", "api_version": "2022-05-25", "name": "sms.delivery", "created_at": 1653378603, "attempt_total": 4, "attempt_number": 1, "data": { "id": "d6c12ac4-cc7d-11ec-b6da-525400bbb7dc", "key_id": 8207, "dlr_code": 8, "status_code": 100, "callback_data": "order-12345" }, "notification_task_id": "3378de83-de66-4de8-9d29-2b10d41bb641" } }, "webhooks.examples.sms-incoming-event": { "summary": "Evento de SMS Recebido", "description": "Evento enviado quando um SMS recebido \u00e9 recebido", "value": { "id": "d6ff9b42-1da5-711f-df20-f0173a4e7df1", "api_version": "2022-05-25", "name": "sms.incoming", "created_at": 1653378703, "attempt_total": 1, "attempt_number": 1, "data": { "id": "e7d23bd5-dd8e-22fd-c7eb-636511ccc8ed", "to": "+1234567890", "from": "+490987654321", "text": "Hello, this is a reply message", "received_at": 1653378703, "msg_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, "notification_task_id": "4489ef94-ef77-5ef9-ae2a-3c21e52cc752" } }, "webhooks.examples.bulk-email-parsing-fail-event": { "summary": "Evento de Falha na An\u00e1lise de Email em Massa", "description": "Evento enviado quando a an\u00e1lise de email em massa falha", "value": { "id": "d6ff9b42-1da5-711f-df20-f0173a4e7df1", "api_version": "2022-05-25", "name": "bulk.email.parsing.fail", "created_at": 1653378903, "attempt_total": 1, "attempt_number": 1, "data": { "field": "to", "description": "Invalid phone number format", "email": { "id": "email-124", "from": "sender@example.com", "to": "bulk@your-domain.com", "subject": "SMS Bulk Request", "body": "Invalid message content" } }, "notification_task_id": "6601ab16-ca99-7fe1-cf4c-5e43f74ee974" } }, "webhooks.examples.bulk-email-parsing-success-event": { "summary": "Evento de Sucesso na An\u00e1lise de Email em Massa", "description": "Evento enviado quando o email em massa \u00e9 analisado com sucesso", "value": { "id": "d6ff9b42-1da5-711f-df20-f0173a4e7df1", "api_version": "2022-05-25", "name": "bulk.email.parsing.success", "created_at": 1653378803, "attempt_total": 1, "attempt_number": 1, "data": { "bulk": { "id": "f8a34ce6-ee9f-33ae-d8fc-747622ddd9fe", "status": 10, "created_at": 1653378803 }, "email": { "id": "email-123", "from": "sender@example.com", "to": "bulk@your-domain.com", "subject": "SMS Bulk Request", "body": "Message content here" } }, "notification_task_id": "5590fa05-fb88-6fc0-bf3b-4d32f63dd863" } }, "webhooks.examples.fraud-check-done-event": { "summary": "Evento de Verifica\u00e7\u00e3o de Fraude Conclu\u00edda", "description": "Evento enviado quando a verifica\u00e7\u00e3o de detec\u00e7\u00e3o de fraude \u00e9 conclu\u00edda", "value": { "id": "a7bc0d53-2ab6-822c-df31-a1284b5f8ea2", "api_version": "2022-05-25", "name": "fraud-check.done", "created_at": 1653379003, "attempt_total": 1, "attempt_number": 1, "data": { "check_id": "fraud-check-123", "result": "clean", "confidence_score": 0.95 }, "notification_task_id": "7712ab27-cd00-8ef2-da5d-6f54f85ff085" } }, "webhooks.examples.sms-email-parsing-success-event": { "summary": "SMS Email Parsing Success Event", "description": "Event sent when email to SMS parsing is successful", "value": { "id": "d6ff9b42-1da5-711f-df20-f0173a4e7df1", "api_version": "2022-05-25", "name": "sms.email.parsing.success", "created_at": 1653378803, "attempt_total": 1, "attempt_number": 1, "data": { "sms": [ { "uuid": "f8a34ce6-ee9f-33ae-d8fc-747622ddd9fe", "to": "+4915123456789", "text": "Hello, this is your SMS message content parsed from email." } ], "email": { "id": "email-456", "from": "sender@example.com", "to": "sms@your-domain.com", "subject": "SMS Request", "body": "Send SMS to +4915123456789: Hello, this is your SMS message content parsed from email." } }, "notification_task_id": "5590fa05-fb88-6fc0-bf3b-4d32f63dd863" } }, "webhooks.examples.sms-email-parsing-fail-event": { "summary": "SMS Email Parsing Fail Event", "description": "Event sent when email to SMS parsing fails", "value": { "id": "a3cd6e19-8af2-498d-ad07-c7840f1b4ac8", "api_version": "2022-05-25", "name": "sms.email.parsing.fail", "created_at": 1653378603, "attempt_total": 1, "attempt_number": 1, "data": { "field": "recipient", "description": "Invalid phone number format", "email": { "id": "email-789", "from": "sender@example.com", "to": "sms@your-domain.com", "subject": "SMS Request", "body": "Send SMS to invalid-phone: Test message" } }, "notification_task_id": "3378de83-de66-4de8-9d29-2b10d41bb641" } }, "webhooks.examples.verify-code-success-event": { "summary": "Verify Code Success Event", "description": "Event sent when the verification code was successfully delivered and verified", "value": { "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479", "api_version": "2022-05-25", "name": "verify_code.success", "created_at": 1735689600, "attempt_total": 3, "attempt_number": 1, "data": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "user_id": 12345, "phone": "+4915112345678", "routing_strategy": [ { "channel": "telegram", "timeout_sec": 30, "sender_id": "LOX24" }, { "channel": "sms", "timeout_sec": 60, "sender_id": "LOX24" } ], "status": 10, "delivered_channel": "telegram", "cost": 5, "currency": "EUR", "code": "1234", "code_length": 4, "payload": "session_abc123", "created_at": 1735689540, "updated_at": 1735689600, "history": [ { "id": "a1b2c3d4-d5e6-7890-abcd-ef1234567890", "channel": "telegram", "status": 10, "processed_at": 1735689570, "external_id": "tg_msg_001" } ], "is_code_deleted": false }, "notification_task_id": "3378de83-de66-4de8-9d29-2b10d41bb641" } }, "webhooks.examples.verify-code-failed-event": { "summary": "Verify Code Failed Event", "description": "Event sent when the verification code delivery failed across all channels", "value": { "id": "c93a1f2e-4b5d-4c6a-8e7f-9d0a1b2c3d4e", "api_version": "2022-05-25", "name": "verify_code.failed", "created_at": 1735689720, "attempt_total": 3, "attempt_number": 1, "data": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "user_id": 12345, "phone": "+4915112345678", "routing_strategy": [ { "channel": "telegram", "timeout_sec": 30, "sender_id": "LOX24" }, { "channel": "sms", "timeout_sec": 60, "sender_id": "LOX24" } ], "status": 20, "delivered_channel": null, "cost": 5, "currency": "EUR", "code": "5678", "code_length": 4, "payload": null, "created_at": 1735689540, "updated_at": 1735689720, "history": [ { "id": "a1b2c3d4-d5e6-7890-abcd-ef1234567890", "channel": "telegram", "status": 20, "processed_at": 1735689570, "external_id": "tg_msg_002" }, { "id": "b5a6c7d8-e9f0-1234-abcd-ef5678901234", "channel": "sms", "status": 20, "processed_at": 1735689660, "external_id": "sms_msg_003" } ], "is_code_deleted": false }, "notification_task_id": "44a9ef94-ef77-5ef9-0e3a-3c21d52cc752" } }, "webhooks.examples.verify-code-channel-updated-event": { "summary": "Verify Code Channel Updated Event", "description": "Event sent when the verification code task status changes during processing", "value": { "id": "a7b8c9d0-1e2f-4a3b-4c5d-6e7f8a9b0c1d", "api_version": "2022-05-25", "name": "verify_code.channel.updated", "created_at": 1735689650, "attempt_total": 3, "attempt_number": 1, "data": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "user_id": 12345, "phone": "+4915112345678", "routing_strategy": [ { "channel": "telegram", "timeout_sec": 30, "sender_id": "LOX24" }, { "channel": "sms", "timeout_sec": 60, "sender_id": "LOX24" } ], "status": 5, "delivered_channel": null, "cost": 10, "currency": "EUR", "code": "1234", "code_length": 4, "payload": "session_abc123", "created_at": 1735689540, "updated_at": 1735689650, "history": [ { "id": "a1b2c3d4-d5e6-7890-abcd-ef1234567890", "channel": "telegram", "status": 20, "processed_at": 1735689575, "external_id": "tg_msg_001" }, { "id": "b5a6c7d8-e9f0-1234-abcd-ef5678901234", "channel": "sms", "status": 5, "processed_at": 1735689640, "external_id": "sms_msg_002" } ], "is_code_deleted": false }, "notification_task_id": "88edf307-fd11-4fd1-0a7e-7b65f96ff086" } }, "webhooks.examples.verify-code-channel-sent-event": { "summary": "Verify Code Channel Sent Event", "description": "Event sent when the verification code was dispatched through a specific channel", "value": { "id": "d04b2f3e-5c6d-4d7b-9f8a-0e1b2c3d4e5f", "api_version": "2022-05-25", "name": "verify_code.channel.sent", "created_at": 1735689555, "attempt_total": 3, "attempt_number": 1, "data": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "user_id": 12345, "phone": "+4915112345678", "routing_strategy": [ { "channel": "telegram", "timeout_sec": 30, "sender_id": "LOX24" }, { "channel": "sms", "timeout_sec": 60, "sender_id": "LOX24" } ], "status": 5, "delivered_channel": null, "cost": 5, "currency": "EUR", "code": "1234", "code_length": 4, "payload": "session_abc123", "created_at": 1735689540, "updated_at": 1735689555, "history": [ { "id": "a1b2c3d4-d5e6-7890-abcd-ef1234567890", "channel": "telegram", "status": 10, "processed_at": 1735689555, "external_id": "tg_msg_001" } ], "is_code_deleted": false, "channel": { "id": "a1b2c3d4-d5e6-7890-abcd-ef1234567890", "channel": "telegram", "status": 10, "processed_at": 1735689555, "external_id": "tg_msg_001", "error": null, "cost": 5 } }, "notification_task_id": "55baf095-fa88-6fa9-1f4b-4d32e63dd863" } }, "webhooks.examples.verify-code-channel-success-event": { "summary": "Verify Code Channel Success Event", "description": "Event sent when a specific channel has confirmed successful delivery of the verification code", "value": { "id": "b3e4f5a6-7c8d-4e9f-0a1b-2c3d4e5f6a7b", "api_version": "2022-05-25", "name": "verify_code.channel.success", "created_at": 1735689575, "attempt_total": 3, "attempt_number": 1, "data": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "user_id": 12345, "phone": "+4915112345678", "routing_strategy": [ { "channel": "telegram", "timeout_sec": 30, "sender_id": "LOX24" }, { "channel": "sms", "timeout_sec": 60, "sender_id": "LOX24" } ], "status": 10, "delivered_channel": "telegram", "cost": 5, "currency": "EUR", "code": "1234", "code_length": 4, "payload": "session_abc123", "created_at": 1735689540, "updated_at": 1735689575, "history": [ { "id": "a1b2c3d4-d5e6-7890-abcd-ef1234567890", "channel": "telegram", "status": 10, "processed_at": 1735689570, "external_id": "tg_msg_001" } ], "is_code_deleted": false, "channel": { "id": "a1b2c3d4-d5e6-7890-abcd-ef1234567890", "channel": "telegram", "status": 10, "processed_at": 1735689570, "external_id": "tg_msg_001", "error": null, "cost": 5 } }, "notification_task_id": "66cbf195-fb99-4fb9-8a5c-5e43f74ee864" } }, "webhooks.examples.verify-code-channel-failed-event": { "summary": "Verify Code Channel Failed Event", "description": "Event sent when a specific channel has failed to deliver the verification code", "value": { "id": "e5f6a7b8-9c0d-4e1f-2a3b-4c5d6e7f8a9b", "api_version": "2022-05-25", "name": "verify_code.channel.failed", "created_at": 1735689630, "attempt_total": 3, "attempt_number": 1, "data": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "user_id": 12345, "phone": "+4915112345678", "routing_strategy": [ { "channel": "telegram", "timeout_sec": 30, "sender_id": "LOX24" }, { "channel": "sms", "timeout_sec": 60, "sender_id": "LOX24" } ], "status": 5, "delivered_channel": null, "cost": 5, "currency": "EUR", "code": "1234", "code_length": 4, "payload": "session_abc123", "created_at": 1735689540, "updated_at": 1735689630, "history": [ { "id": "a1b2c3d4-d5e6-7890-abcd-ef1234567890", "channel": "telegram", "status": 20, "processed_at": 1735689575, "external_id": "tg_msg_001" } ], "is_code_deleted": false, "channel": { "id": "a1b2c3d4-d5e6-7890-abcd-ef1234567890", "channel": "telegram", "status": 20, "processed_at": 1735689575, "external_id": "tg_msg_001", "error": "Delivery timeout: no confirmation received within 30 seconds", "cost": 5 } }, "notification_task_id": "77dcf296-fc00-4fc0-9b6d-6f54e85ff975" } } }, "responses": { "400-bad-request": { "description": "Invalid input" }, "401-unauthorized": { "description": "Client ID or API key isn't active or invalid!" }, "403-forbidden": { "description": "Account isn't activated. Please wait or contact to support!" }, "429-too-many-requests": { "description": "O endere\u00e7o IP foi bloqueado temporariamente, pois durante um curto per\u00edodo de tempo foram enviadas v\u00e1rias solicita\u00e7\u00f5es com credenciais inv\u00e1lidas. Aguarde e tente mais tarde." }, "422-unprocessable-entity": { "description": "The request was well-formed but was unable to be followed due to semantic errors" }, "404-not-found": { "description": "Resource not found" }, "204-deleted": { "description": "The entity has been deleted" }, "402-not-enough-funds": { "description": "There are not enough funds on your account!" }, "409-conflict": { "description": "Conflict - Entity already exists" }, "webhook-200": { "description": "Webhook recebido" }, "webhook-400": { "description": "Estrutura do corpo do pedido de webhook inv\u00e1lido" }, "webhook-401": { "description": "Pedido de webhook n\u00e3o autorizado" }, "webhook-403": { "description": "Acesso proibido ao webhook" }, "webhook-404": { "description": "Acesso proibido ao webhook" }, "webhook-500": { "description": "Erro do servidor" } } }, "x-doc-version": "2.27 (2026-06-29)", "x-tagGroups": [ { "name": "user-info", "x-displayName": "Informa\u00e7\u00f5es do usu\u00e1rio", "tags": [ "user" ] }, { "name": "accounting", "x-displayName": "Contabilidade", "tags": [ "pricelist", "invoices", "credit_notes", "payments" ] }, { "name": "messages", "x-displayName": "Mensagens", "tags": [ "sms", "bulks", "incomings", "blocked-numbers" ] }, { "name": "phone-groups", "x-displayName": "N\u00fameros de telefone e grupos", "tags": [ "groups", "phones" ] }, { "name": "shortlinks", "x-displayName": "Links curtos", "tags": [ "send-link", "campaigns", "links", "requests", "click-rate" ] }, { "name": "fraud-checks", "x-displayName": "Verifica\u00e7\u00f5es de fraude", "tags": [ "fraud-detection" ] }, { "name": "verify-codes", "x-displayName": "C\u00f3digos de verifica\u00e7\u00e3o", "tags": [ "verify-codes" ] }, { "name": "misc", "x-displayName": "Diversos", "tags": [ "collection-filters", "sms-status-codes", "sms-delivery-report-codes-dlr", "encoding-and-number-of-characters", "inbound-and-reply-sms", "kannel", "ssml-language-detection", "email-to-sms", "notifications", "release-notes" ] } ] }