{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/communication:sms77/analytics":{"get":{"operationId":"communication_sms77_analytics","summary":"GET /analytics","description":"GET /analytics","tags":["communication"],"parameters":[{"name":"start","in":"query","required":false,"description":"Start date of the statistics in the format YYYY-MM-DD. By default, the date of 30 days ago is set.","schema":{"type":"string","description":"Start date of the statistics in the format YYYY-MM-DD. By default, the date of 30 days ago is set."}},{"name":"end","in":"query","required":false,"description":"End date of the statistics in the format YYYY-MM-DD. By default, the current day.","schema":{"type":"string","description":"End date of the statistics in the format YYYY-MM-DD. By default, the current day."}},{"name":"label","in":"query","required":false,"description":"Shows only data of a specific label.","schema":{"type":"string","description":"Shows only data of a specific label."}},{"name":"subaccounts","in":"query","required":false,"description":"Receive the data only for the main account, all your (sub-)accounts or only for specific subaccounts.","schema":{"type":"string","description":"Receive the data only for the main account, all your (sub-)accounts or only for specific subaccounts."}},{"name":"group_by","in":"query","required":false,"description":"Defines the grouping of the data.","schema":{"type":"string","enum":["date","label","subaccount","country"],"description":"Defines the grouping of the data."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:sms77/balance":{"get":{"operationId":"communication_sms77_balance","summary":"GET /balance","description":"GET /balance","tags":["communication"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:sms77/contacts-get":{"get":{"operationId":"communication_sms77_contacts_get","summary":"GET /contacts","description":"GET /contacts","tags":["communication"],"parameters":[{"name":"action","in":"query","required":true,"description":"Determines the action to execute.","schema":{"type":"string","enum":["read"],"description":"Determines the action to execute."}},{"name":"json","in":"query","required":false,"description":"Defines whether to return the response as JSON or CSV separated by semicolon.","schema":{"type":"number","enum":[0,1],"default":0,"description":"Defines whether to return the response as JSON or CSV separated by semicolon."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:sms77/contacts-post":{"post":{"operationId":"communication_sms77_contacts_post","summary":"POST /contacts","description":"POST /contacts","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["action"],"properties":{"action":{"type":"string","enum":["del","write"],"description":"Determines the action to execute."},"json":{"type":"number","enum":[0,1],"default":0,"description":"Defines whether to return the response as JSON or CSV separated by semicolon."},"id":{"type":"string","description":"The contact ID for editing/deletion."},"nick":{"type":"string","description":"The contacts name."},"empfaenger":{"type":"string","description":"The contacts phone number."},"email":{"type":"string","description":"The contacts email address."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:sms77/hooks-get":{"get":{"operationId":"communication_sms77_hooks_get","summary":"GET /hooks","description":"GET /hooks","tags":["communication"],"parameters":[{"name":"action","in":"query","required":true,"description":"Determines the action to execute.","schema":{"type":"string","enum":["read"],"description":"Determines the action to execute."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:sms77/hooks-post":{"post":{"operationId":"communication_sms77_hooks_post","summary":"POST /hooks","description":"POST /hooks","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["action"],"properties":{"action":{"type":"string","enum":["subscribe","unsubscribe"],"description":"Determines the action to execute."},"id":{"type":"integer","description":"The Webhook ID you wish to unsubscribe."},"target_url":{"type":"string","description":"Target URL of your Webhook."},"event_type":{"type":"string","enum":["all","sms_mo","dlr","voice_status"],"description":"Type of event for which you would like to receive a webhook."},"request_method":{"type":"string","enum":["POST","JSON","GET"],"default":"POST","description":"Request method in which you want to receive the webhook."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:sms77/lookup":{"post":{"operationId":"communication_sms77_lookup","summary":"POST /lookup","description":"POST /lookup","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["type","number"],"properties":{"type":{"type":"string","description":"Allowed values are \"cnam\", \"format\", \"hlr\" and \"mnp\"."},"number":{"type":"array","description":"The phone number to look up."},"json":{"type":"string","description":"Determines whether the response shall be returned in JSON format. Does not work with type \"format\"."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:sms77/lookup-cnam":{"post":{"operationId":"communication_sms77_lookup_cnam","summary":"POST /lookup/cnam","description":"POST /lookup/cnam","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["number"],"properties":{"number":{"type":"array","description":"The phone number to look up."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:sms77/lookup-format":{"post":{"operationId":"communication_sms77_lookup_format","summary":"POST /lookup/format","description":"POST /lookup/format","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["number"],"properties":{"number":{"type":"array","description":"The phone number to look up."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:sms77/lookup-hlr":{"post":{"operationId":"communication_sms77_lookup_hlr","summary":"POST /lookup/hlr","description":"POST /lookup/hlr","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["number"],"properties":{"number":{"type":"array","description":"The phone number to look up."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:sms77/lookup-mnp":{"post":{"operationId":"communication_sms77_lookup_mnp","summary":"POST /lookup/mnp","description":"POST /lookup/mnp","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["number"],"properties":{"number":{"type":"array","description":"The phone number to look up."},"json":{"type":"string","description":"Determines whether the response shall be returned in JSON format."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:sms77/pricing":{"get":{"operationId":"communication_sms77_pricing","summary":"GET /pricing","description":"GET /pricing","tags":["communication"],"parameters":[{"name":"country","in":"query","required":false,"description":"The countries ISO code to get pricings for. Allowed values are de, fr, at. Omit to show pricings for all channels.","schema":{"type":"string","description":"The countries ISO code to get pricings for. Allowed values are de, fr, at. Omit to show pricings for all channels."}},{"name":"format","in":"query","required":false,"description":"Determines the response format. Allowed values are json and csv. The default value is json.","schema":{"type":"string","description":"Determines the response format. Allowed values are json and csv. The default value is json."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:sms77/sms":{"post":{"operationId":"communication_sms77_sms","summary":"POST /sms","description":"POST /sms","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["text","to"],"properties":{"text":{"type":"string","description":"The actual text message to send."},"to":{"type":"string","description":"The recipient number or group name."},"from":{"type":"string","description":"Set a custom sender name."},"foreign_id":{"type":"string","description":"Identifier to return in callbacks."},"label":{"type":"string","description":"A custom label."},"udh":{"type":"string","description":"A custom User Data Header."},"delay":{"type":"string","description":"Date/Time for delayed dispatch."},"debug":{"type":"number","enum":[1,0],"default":0,"description":"Disable message sending."},"no_reload":{"type":"number","enum":[1,0],"default":0,"description":"Enable sending of duplicated messages within 180 seconds."},"unicode":{"type":"number","enum":[1,0],"default":0,"description":"Force unicode encoding. Reduces sms length to 70 chars."},"flash":{"type":"number","enum":[1,0],"default":0,"description":"Send as flash."},"utf8":{"type":"number","enum":[1,0],"default":0,"description":"Force UTF8 encoding."},"details":{"type":"number","enum":[1,0],"default":0,"description":"Attach message details to response."},"return_msg_id":{"type":"number","enum":[1,0],"default":0,"description":"Attach message ID to second row in a text response."},"json":{"type":"number","enum":[1,0],"default":0,"description":"Return a detailed JSON response."},"performance_tracking":{"type":"number","enum":[1,0],"default":0,"description":"Enable performance tracking for found URLs."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:sms77/status":{"get":{"operationId":"communication_sms77_status","summary":"GET /status","description":"GET /status","tags":["communication"],"parameters":[{"name":"msg_id","in":"query","required":true,"description":"The ID from the SMS.","schema":{"type":"string","description":"The ID from the SMS."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:sms77/validate-for-voice":{"post":{"operationId":"communication_sms77_validate_for_voice","summary":"POST /validate_for_voice","description":"POST /validate_for_voice","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["number"],"properties":{"number":{"type":"string","description":"Determines the recipient. Can only be a number, not a contact from your address book."},"callback":{"type":"string","description":"The callback URL which gets queried right after validation."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:sms77/voice":{"post":{"operationId":"communication_sms77_voice","summary":"POST /voice","description":"POST /voice","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["to","text"],"properties":{"to":{"type":"string","description":"Determines the receiver. Must be a valid phone number or contact from the address book."},"text":{"type":"string","description":"The text to convert to a voice message. Accepts valid XML too."},"xml":{"type":"number","enum":[1,0],"description":"Decides whether the parameter \"text\" is plain text or XML. The default value is 0."},"from":{"type":"string","description":"Sets the sender. Must be a verified sender. Use an inbound number of yours or one of ours."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}