{"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:bulksms/blocked-numbers-list-retrieval":{"get":{"operationId":"communication_bulksms_blocked_numbers_list_retrieval","summary":"List blocked numbers","description":"GET /blocked-numbers","tags":["communication"],"parameters":[{"name":"min-id","in":"query","required":false,"description":"Records with an `id` that is greater or equal to min-id will be returned. The default value is `0`. You can add 1 to an id that you…","schema":{"type":"integer","description":"Records with an `id` that is greater or equal to min-id will be returned. The default value is `0`. You can add 1 to an id that you…"}},{"name":"limit","in":"query","required":false,"description":"The maximum number of records to return. The default value is `10000`. The value cannot be greater than 10000.","schema":{"type":"integer","description":"The maximum number of records to return. The default value is `10000`. The value cannot be greater than 10000."}}],"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:bulksms/blocked-numbers-create-blocked-number":{"post":{"operationId":"communication_bulksms_blocked_numbers_create_blocked_number","summary":"Create a blocked number","description":"POST /blocked-numbers","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"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:bulksms/credits-transfer-credits-to-account":{"post":{"operationId":"communication_bulksms_credits_transfer_credits_to_account","summary":"Transfer credits to another account","description":"POST /credit/transfer","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"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:bulksms/message-list-retrieval":{"get":{"operationId":"communication_bulksms_message_list_retrieval","summary":"Retrieve Messages","description":"GET /messages","tags":["communication"],"parameters":[{"name":"limit","in":"query","required":false,"description":"The maximum number of messages that are returned. The default is 1000. The value of `limit` is not a guarantee that a specific number of…","schema":{"type":"number","description":"The maximum number of messages that are returned. The default is 1000. The value of `limit` is not a guarantee that a specific number of…"}},{"name":"filter","in":"query","required":false,"description":"See the message filtering for more information.","schema":{"type":"string","description":"See the message filtering for more information."}},{"name":"sortOrder","in":"query","required":false,"description":"The default value is DESCENDING If the `sortOrder` is DESCENDING, the newest messages be first in the result. ASCENDING places the oldest…","schema":{"type":"string","enum":["ASCENDING"],"description":"The default value is DESCENDING If the `sortOrder` is DESCENDING, the newest messages be first in the result. ASCENDING places the oldest…"}}],"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:bulksms/message-send-batch-messages":{"post":{"operationId":"communication_bulksms_message_send_batch_messages","summary":"Send Messages","description":"POST /messages","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"deduplication-id":{"type":"integer","description":"Safeguards against the possibility of sending the same messages more than once. If a communication failure occurs during a submission, you…"},"auto-unicode":{"type":"boolean","default":false,"description":"Specifies how to deal with message text that contains characters not present in the GSM 03.38 character set. Messages that contain only…"},"schedule-date":{"type":"string","description":"Allows you to send a message in the future. An example value is `2019-02-18T13:00:00+02:00`. It encodes to…"},"schedule-description":{"type":"string","description":"A note that is stored together with a scheduled submission, which could be used to more easily identify the scheduled submission at a…"},"body":{"type":"object","description":"JSON request body"}}}}}},"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:bulksms/message-submit-message":{"get":{"operationId":"communication_bulksms_message_submit_message","summary":"Send message by simple GET or POST","description":"GET /messages/send","tags":["communication"],"parameters":[{"name":"to","in":"query","required":true,"description":"The phone number of the recipient.","schema":{"type":"string","description":"The phone number of the recipient."}},{"name":"body","in":"query","required":true,"description":"The text you want to send.","schema":{"type":"string","description":"The text you want to send."}},{"name":"deduplication-id","in":"query","required":false,"description":"Refer to the `deduplication-id` parameter.","schema":{"type":"integer","description":"Refer to the `deduplication-id` parameter."}}],"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:bulksms/message-by-id-get":{"get":{"operationId":"communication_bulksms_message_by_id_get","summary":"Show Message","description":"GET /messages/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"The `id` of the message you want to retrieve","schema":{"type":"string","description":"The `id` of the message you want to retrieve"}}],"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:bulksms/message-related-received-messages-list":{"get":{"operationId":"communication_bulksms_message_related_received_messages_list","summary":"List Related Messages","description":"GET /messages/{id}/relatedReceivedMessages","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"The `id` of the sent message","schema":{"type":"string","description":"The `id` of the sent message"}}],"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:bulksms/profile-get-user-information":{"get":{"operationId":"communication_bulksms_profile_get_user_information","summary":"Get profile","description":"GET /profile","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:bulksms/attachments-upload-via-pre-signed-url":{"post":{"operationId":"communication_bulksms_attachments_upload_via_pre_signed_url","summary":"Upload an attachment via a signed URL","description":"POST /rmm/pre-sign-attachment","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"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:bulksms/webhooks-list-webhooks":{"get":{"operationId":"communication_bulksms_webhooks_list_webhooks","summary":"List webhooks","description":"GET /webhooks","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:bulksms/webhooks-create-webhook":{"post":{"operationId":"communication_bulksms_webhooks_create_webhook","summary":"Create a webhook","description":"POST /webhooks","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"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:bulksms/webhooks-read-webhook":{"get":{"operationId":"communication_bulksms_webhooks_read_webhook","summary":"Read a webhook","description":"GET /webhooks/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"The `id` of the webhook","schema":{"type":"string","description":"The `id` of 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":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:bulksms/webhooks-update-webhook":{"post":{"operationId":"communication_bulksms_webhooks_update_webhook","summary":"Update a webhook","description":"POST /webhooks/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"The `id` of the webhook"},"body":{"type":"object","description":"JSON request body"}}}}}},"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:bulksms/webhooks-delete-webhook":{"post":{"operationId":"communication_bulksms_webhooks_delete_webhook","summary":"Delete a webhook","description":"DELETE /webhooks/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The `id` of 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"}}},"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"}}}}}}}