{"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/open-data:vonage-vgis/get-user":{"get":{"operationId":"open_data_vonage_vgis_get_user","summary":"User info","description":"GET /self","tags":["open-data"],"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":"live"}},"/v1/open-data:vonage-vgis/get-account":{"get":{"operationId":"open_data_vonage_vgis_get_account","summary":"Account info","description":"GET /self/account","tags":["open-data"],"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":"live"}},"/v1/open-data:vonage-vgis/list-calls":{"get":{"operationId":"open_data_vonage_vgis_list_calls","summary":"List active calls","description":"GET /self/calls","tags":["open-data"],"parameters":[{"name":"fromDate","in":"query","required":false,"description":"Return calls that occurred after this point in time","schema":{"type":"integer","description":"Return calls that occurred after this point in time"}},{"name":"toDate","in":"query","required":false,"description":"Return calls that occurred before this point in time","schema":{"type":"integer","description":"Return calls that occurred before this point in time"}},{"name":"direction","in":"query","required":false,"description":"Filter by call direction. For multiple criteria, seperate values by a comma.","schema":{"type":"string","enum":["INBOUND","OUTBOUND"],"description":"Filter by call direction. For multiple criteria, seperate values by a comma."}},{"name":"states","in":"query","required":false,"description":"Filter calls by state. For multiple criteria, seperate values by a comma.","schema":{"type":"string","enum":["INITIALIZING","RINGING","ACTIVE","HELD","REMOTE_HELD"],"default":"ACTIVE","description":"Filter calls by state. For multiple criteria, seperate values by a comma."}},{"name":"offset","in":"query","required":false,"description":"Page number of calls to return","schema":{"type":"integer","description":"Page number of calls to return"}},{"name":"size","in":"query","required":false,"description":"Return this amount of calls in the response","schema":{"type":"integer","default":20,"description":"Return this amount of calls in the response"}},{"name":"order","in":"query","required":false,"description":"Sort in either ascending or descending order","schema":{"type":"string","enum":["DESC","ASC"],"default":"ASC","description":"Sort in either ascending or descending order"}},{"name":"sort","in":"query","required":false,"description":"Sort calls by property","schema":{"type":"string","description":"Sort calls by property"}}],"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":"live"}},"/v1/open-data:vonage-vgis/create-call":{"post":{"operationId":"open_data_vonage_vgis_create_call","summary":"Place a call","description":"POST /self/calls","tags":["open-data"],"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":"live"}},"/v1/open-data:vonage-vgis/get-calls-count":{"get":{"operationId":"open_data_vonage_vgis_get_calls_count","summary":"Get calls count","description":"GET /self/calls/count","tags":["open-data"],"parameters":[{"name":"fromDate","in":"query","required":false,"description":"Return calls that occurred after this point in time","schema":{"type":"integer","description":"Return calls that occurred after this point in time"}},{"name":"toDate","in":"query","required":false,"description":"Return calls that occurred before this point in time","schema":{"type":"integer","description":"Return calls that occurred before this point in time"}},{"name":"direction","in":"query","required":false,"description":"Filter by call direction. For multiple criteria, seperate values by a comma.","schema":{"type":"string","enum":["INBOUND","OUTBOUND"],"description":"Filter by call direction. For multiple criteria, seperate values by a comma."}},{"name":"states","in":"query","required":false,"description":"Filter calls by state. For multiple criteria, seperate values by a comma.","schema":{"type":"string","enum":["INITIALIZING","RINGING","ACTIVE","HELD","REMOTE_HELD"],"default":"ACTIVE","description":"Filter calls by state. For multiple criteria, seperate values by a comma."}}],"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":"live"}},"/v1/open-data:vonage-vgis/get-roles":{"get":{"operationId":"open_data_vonage_vgis_get_roles","summary":"Get a call","description":"GET /self/calls/{id}","tags":["open-data"],"parameters":[{"name":"id","in":"query","required":true,"description":"Unique identifier of the call","schema":{"type":"string","description":"Unique identifier of the call"}}],"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":"live"}},"/v1/open-data:vonage-vgis/destroy-call":{"post":{"operationId":"open_data_vonage_vgis_destroy_call","summary":"End a call","description":"DELETE /self/calls/{id}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Unique identifier of the call"}}}}}},"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":"live"}},"/v1/open-data:vonage-vgis/call-answer":{"post":{"operationId":"open_data_vonage_vgis_call_answer","summary":"Answer call (On supported devices)","description":"PUT /self/calls/{id}/answer","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Unique identifier of the call"}}}}}},"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":"live"}},"/v1/open-data:vonage-vgis/call-hold":{"post":{"operationId":"open_data_vonage_vgis_call_hold","summary":"Put call on hold","description":"PUT /self/calls/{id}/hold","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Unique identifier of the call"}}}}}},"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":"live"}},"/v1/open-data:vonage-vgis/call-unold":{"post":{"operationId":"open_data_vonage_vgis_call_unold","summary":"Unhold","description":"DELETE /self/calls/{id}/hold","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Unique identifier of the call"}}}}}},"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":"live"}},"/v1/open-data:vonage-vgis/call-transfer":{"post":{"operationId":"open_data_vonage_vgis_call_transfer","summary":"Transfer call","description":"POST /self/calls/{id}/transfer","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"Unique identifier of the call"},"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":"live"}},"/v1/open-data:vonage-vgis/call-vmtransfer":{"post":{"operationId":"open_data_vonage_vgis_call_vmtransfer","summary":"Send call to voicemail","description":"PUT /self/calls/{id}/vmtransfer","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Unique identifier of the call"}}}}}},"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":"live"}},"/v1/open-data:vonage-vgis/list-events":{"get":{"operationId":"open_data_vonage_vgis_list_events","summary":"List events","description":"GET /self/events","tags":["open-data"],"parameters":[{"name":"types","in":"query","required":false,"description":"Record type","schema":{"type":"string","enum":["CALL"],"description":"Record type"}},{"name":"fromDate","in":"query","required":false,"description":"Return events that occurred after this point in time","schema":{"type":"integer","description":"Return events that occurred after this point in time"}},{"name":"toDate","in":"query","required":false,"description":"Return events that occurred before this point in time","schema":{"type":"integer","description":"Return events that occurred before this point in time"}},{"name":"direction","in":"query","required":false,"description":"Filter by event direction","schema":{"type":"string","enum":["INBOUND","OUTBOUND"],"description":"Filter by event direction"}},{"name":"states","in":"query","required":false,"description":"Filter events by state","schema":{"type":"string","enum":["INITIALIZING","RINGING","ACTIVE","HELD","REMOTE_HELD","DETACHED","REJECTED","CANCELLED","ANSWERED","MISSED"],"description":"Filter events by state"}},{"name":"offset","in":"query","required":false,"description":"Page number of events to return","schema":{"type":"integer","description":"Page number of events to return"}},{"name":"size","in":"query","required":false,"description":"Return this amount of events in the response","schema":{"type":"integer","default":20,"description":"Return this amount of events in the response"}},{"name":"order","in":"query","required":false,"description":"Sort in either ascending or descending order'","schema":{"type":"string","enum":["DESC","ASC"],"default":"ASC","description":"Sort in either ascending or descending order'"}},{"name":"sort","in":"query","required":false,"description":"Sort events by property","schema":{"type":"string","description":"Sort events by property"}}],"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":"live"}},"/v1/open-data:vonage-vgis/get-events-count":{"get":{"operationId":"open_data_vonage_vgis_get_events_count","summary":"Get events count","description":"GET /self/events/count","tags":["open-data"],"parameters":[{"name":"fromDate","in":"query","required":false,"description":"Return events that occurred after this point in time","schema":{"type":"integer","description":"Return events that occurred after this point in time"}},{"name":"toDate","in":"query","required":false,"description":"Return events that occurred before this point in time","schema":{"type":"integer","description":"Return events that occurred before this point in time"}},{"name":"direction","in":"query","required":false,"description":"Filter by event direction","schema":{"type":"string","enum":["INBOUND","OUTBOUND"],"description":"Filter by event direction"}},{"name":"states","in":"query","required":false,"description":"Filter events by state","schema":{"type":"string","enum":["INITIALIZING","RINGING","ACTIVE","HELD","REMOTE_HELD"],"description":"Filter events by state"}}],"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":"live"}},"/v1/open-data:vonage-vgis/get-event":{"get":{"operationId":"open_data_vonage_vgis_get_event","summary":"Get event","description":"GET /self/events/{id}","tags":["open-data"],"parameters":[{"name":"id","in":"query","required":true,"description":"Unique identifier of the event","schema":{"type":"string","description":"Unique identifier of the event"}}],"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":"live"}},"/v1/open-data:vonage-vgis/list-webhooks":{"get":{"operationId":"open_data_vonage_vgis_list_webhooks","summary":"List web hooks","description":"GET /self/webhooks","tags":["open-data"],"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":"live"}},"/v1/open-data:vonage-vgis/create-webhook":{"post":{"operationId":"open_data_vonage_vgis_create_webhook","summary":"Create a new webhook subscription","description":"POST /self/webhooks","tags":["open-data"],"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":"live"}},"/v1/open-data:vonage-vgis/view-webhook":{"get":{"operationId":"open_data_vonage_vgis_view_webhook","summary":"Get web hook details","description":"GET /self/webhooks/{id}","tags":["open-data"],"parameters":[{"name":"id","in":"query","required":true,"description":"Unique identifier of the webhook","schema":{"type":"string","description":"Unique identifier 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":"live"}},"/v1/open-data:vonage-vgis/destroy-webhook":{"post":{"operationId":"open_data_vonage_vgis_destroy_webhook","summary":"Remove a web hook","description":"DELETE /self/webhooks/{id}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Unique identifier 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":"live"}},"/v1/open-data:vonage-vgis/renew-webhook":{"post":{"operationId":"open_data_vonage_vgis_renew_webhook","summary":"Renews a web hook","description":"PUT /self/webhooks/{id}/renew","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Webhook 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":"live"}}},"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"}}}}}}}