{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://www.apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/communication:surevoip-co-uk/get":{"get":{"operationId":"communication_surevoip_co_uk_get","summary":"List global resources","description":"GET /","tags":["communication"],"parameters":[{"name":"hypermedia","in":"query","required":false,"description":"Disable Hypermedia","schema":{"type":"string","enum":["yes","no"],"default":"yes","description":"Disable Hypermedia"}},{"name":"content-type","in":"query","required":false,"description":"Content Type","schema":{"type":"string","enum":["application/json","text/html","text/xml","application/xml"],"default":"application/json","description":"Content Type"}}],"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:surevoip-co-uk/get-announcements":{"get":{"operationId":"communication_surevoip_co_uk_get_announcements","summary":"List global announcements","description":"GET /announcements","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:surevoip-co-uk/post-announcements":{"post":{"operationId":"communication_surevoip_co_uk_post_announcements","summary":"Add a new announcement audio file","description":"POST /announcements","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"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:surevoip-co-uk/get-areacodes":{"get":{"operationId":"communication_surevoip_co_uk_get_areacodes","summary":"List areacodes","description":"GET /areacodes","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:surevoip-co-uk/get-billing":{"get":{"operationId":"communication_surevoip_co_uk_get_billing","summary":"List global billing detail","description":"GET /billing","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:surevoip-co-uk/get-calls":{"get":{"operationId":"communication_surevoip_co_uk_get_calls","summary":"Validate a phone number by calling it once","description":"GET /calls","tags":["communication"],"parameters":[{"name":"validate","in":"query","required":false,"description":"Validate a phone number by calling it for one ring. Note; not 100% proof the number is in service.","schema":{"type":"integer","description":"Validate a phone number by calling it for one ring. Note; not 100% proof the number is in service."},"example":441224900123}],"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:surevoip-co-uk/post-calls":{"post":{"operationId":"communication_surevoip_co_uk_post_calls","summary":"Create phone calls with or without announcements and scheduled hangups","description":"POST /calls","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:surevoip-co-uk/get-charges":{"get":{"operationId":"communication_surevoip_co_uk_get_charges","summary":"List charges","description":"GET /charges","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:surevoip-co-uk/post-charges":{"post":{"operationId":"communication_surevoip_co_uk_post_charges","summary":"Create charges for invoices","description":"POST /charges","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":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:surevoip-co-uk/get-contacts":{"get":{"operationId":"communication_surevoip_co_uk_get_contacts","summary":"List contacts","description":"GET /contacts","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:surevoip-co-uk/get-customers":{"get":{"operationId":"communication_surevoip_co_uk_get_customers","summary":"List all customers or find your own account","description":"GET /customers","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:surevoip-co-uk/get-customer":{"get":{"operationId":"communication_surevoip_co_uk_get_customer","summary":"Represents a customer","description":"GET /customers/{account}","tags":["communication"],"parameters":[{"name":"account","in":"query","required":true,"description":"Account ID of customer","schema":{"type":"integer","description":"Account ID of customer"}}],"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:surevoip-co-uk/get-customers-account-announcements":{"get":{"operationId":"communication_surevoip_co_uk_get_customers_account_announcements","summary":"List of announcement audio files","description":"GET /customers/{account}/announcements","tags":["communication"],"parameters":[{"name":"account","in":"query","required":true,"description":"Account ID of customer","schema":{"type":"integer","description":"Account ID of customer"}}],"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:surevoip-co-uk/get-customers-account-announcements-announcement-id":{"get":{"operationId":"communication_surevoip_co_uk_get_customers_account_announcements_announcement_id","summary":"Represents an announcement audio file","description":"GET /customers/{account}/announcements/{announcement_id}","tags":["communication"],"parameters":[{"name":"announcement_id","in":"query","required":true,"description":"Announcement ID of audio file","schema":{"type":"string","description":"Announcement ID of audio file"}},{"name":"account","in":"query","required":true,"description":"Path parameter {account}","schema":{"type":"string","description":"Path parameter {account}"}}],"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:surevoip-co-uk/delete-customers-account-announcements-announcement-id":{"post":{"operationId":"communication_surevoip_co_uk_delete_customers_account_announcements_announcement_id","summary":"Delete an announcement audio file","description":"DELETE /customers/{account}/announcements/{announcement_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["account","announcement_id"],"properties":{"account":{"type":"string","description":"Path parameter {account}"},"announcement_id":{"type":"string","description":"Path parameter {announcement_id}"}}}}}},"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:surevoip-co-uk/get-faxes":{"get":{"operationId":"communication_surevoip_co_uk_get_faxes","summary":"List global ongoing faxes","description":"GET /faxes","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:surevoip-co-uk/get-hosted":{"get":{"operationId":"communication_surevoip_co_uk_get_hosted","summary":"List Hosted VoIP domains","description":"GET /hosted","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:surevoip-co-uk/get-ip-address":{"get":{"operationId":"communication_surevoip_co_uk_get_ip_address","summary":"Return the IP address from where your API request originated","description":"GET /ip-address","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:surevoip-co-uk/get-mobile":{"get":{"operationId":"communication_surevoip_co_uk_get_mobile","summary":"List mobile accounts","description":"GET /mobile","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:surevoip-co-uk/get-numbers":{"get":{"operationId":"communication_surevoip_co_uk_get_numbers","summary":"List available SureVoIP Ofcom number allocations for purchase","description":"GET /numbers","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:surevoip-co-uk/get-numbers-areacodes":{"get":{"operationId":"communication_surevoip_co_uk_get_numbers_areacodes","summary":"Search available numbers by areacode","description":"GET /numbers/areacodes","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:surevoip-co-uk/get-partners":{"get":{"operationId":"communication_surevoip_co_uk_get_partners","summary":"List SureVoIP Partner accounts","description":"GET /partners","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:surevoip-co-uk/get-porting":{"get":{"operationId":"communication_surevoip_co_uk_get_porting","summary":"List ported numbers","description":"GET /porting","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:surevoip-co-uk/get-service-status":{"get":{"operationId":"communication_surevoip_co_uk_get_service_status","summary":"List all Service Status messages","description":"GET /service-status","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:surevoip-co-uk/get-sip":{"get":{"operationId":"communication_surevoip_co_uk_get_sip","summary":"List all SIP accounts","description":"GET /sip","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:surevoip-co-uk/get-sms":{"get":{"operationId":"communication_surevoip_co_uk_get_sms","summary":"List SMS","description":"GET /sms","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:surevoip-co-uk/post-support-echo":{"post":{"operationId":"communication_surevoip_co_uk_post_support_echo","summary":"Return your POSTed data for testing","description":"POST /support/echo","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":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:surevoip-co-uk/get-support-ip-address":{"get":{"operationId":"communication_surevoip_co_uk_get_support_ip_address","summary":"Return the IP address from where your API request originated","description":"GET /support/ip-address","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:surevoip-co-uk/get-support-service-status":{"get":{"operationId":"communication_surevoip_co_uk_get_support_service_status","summary":"List all Service Status messages","description":"GET /support/service-status","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:surevoip-co-uk/get-topups":{"get":{"operationId":"communication_surevoip_co_uk_get_topups","summary":"List all account credit topups","description":"GET /topups","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"}}},"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"}}}}}}}