{ "openapi": "3.1.0", "info": { "title": "Snapcom API", "version": "45.1.2", "description": "Use the Snapcom API to read and manage your organization's phone system: users, devices, call queues, call history, voicemail and more. Every endpoint below has a **Test Request** button, so you can try calls against your own account from this page.\n\n## Base URL\n\nSend every request to:\n\n```\nhttps://developer.snapcom.com/api/v2\n```\n\nAPI keys issued for integrations only work through this address.\n\n## Authentication\n\nAuthenticate with an API key sent as a bearer token. To check that your key works, ask the API about the key itself:\n\n```bash\ncurl https://developer.snapcom.com/api/v2/apikeys/~ \\\n -H \"Authorization: Bearer nsd_your_key_here\"\n```\n\nTo get a key, email [support@snapcom.com](mailto:support@snapcom.com) with what you are building. Each key is tied to your organization and a permission level, and can be limited to read-only.\n\nKeep keys on your server. Do not put a key in browser JavaScript, a mobile app, or a public code repository. If a key is exposed, contact us and we will revoke it.\n\n## Testing on this page\n\nPaste your key into **Bearer Token** in the Authentication box near the top of this page. Then open any endpoint and use **Test Request**. Requests run against your live account, so use a read-only key while exploring. The key is not saved; it is cleared when you reload or close the page.\n\n## Pagination\n\nEndpoints that return lists send back one page at a time.\n\n| Parameter | Meaning |\n|---|---|\n| `limit` | Records per page. Defaults to 100, maximum 100. |\n| `start` | Offset of the first record, starting at 0. |\n\nA request with `limit` above 100, or with `limit` sent more than once, is rejected with `400`. To read a full list, request pages until one comes back with fewer records than you asked for:\n\n```python\nimport time\nimport requests\n\nBASE = \"https://developer.snapcom.com/api/v2\"\nHEADERS = {\"Authorization\": \"Bearer nsd_your_key_here\"}\n\ndef fetch_all(path, params=None):\n params = {**(params or {}), \"limit\": 100, \"start\": 0}\n while True:\n r = requests.get(BASE + path, headers=HEADERS, params=params, timeout=30)\n if r.status_code == 429:\n time.sleep(int(r.headers.get(\"Retry-After\", \"5\")))\n continue\n r.raise_for_status()\n page = r.json()\n yield from page\n if len(page) < params[\"limit\"]:\n break\n params[\"start\"] += params[\"limit\"]\n```\n\n## Rate limits\n\n| Limit | Value |\n|---|---|\n| Requests per API key | 300 per minute, with short bursts of up to 30 more |\n| Requests in progress at once, per key | 5 |\n\nGoing over a limit returns `429 Too Many Requests` with a `Retry-After` header. Wait that many seconds before trying again, and back off further if you keep getting `429`. Retrying immediately in a loop only extends the wait.\n\n## Avoid polling\n\nMost heavy API use comes from asking the same question over and over. A few habits keep integrations fast and well under the limits:\n\n- To react to calls and other activity, use **Event Subscriptions** so Snapcom sends events to your server, rather than checking every few seconds.\n- Cache data that rarely changes, such as users, devices and call queues, and refresh it occasionally.\n- When reading call history, ask for a time range you have not seen yet instead of re-reading everything.\n\n## Errors\n\n| Status | Meaning | What to do |\n|---|---|---|\n| `400` | The request is invalid, including a `limit` above 100 | Fix the request; retrying will not help |\n| `401` | The key is missing, wrong or revoked | Check the `Authorization` header |\n| `403` | The key is not allowed to do this | Ask us for a key with the access you need |\n| `404` | The record or endpoint does not exist | Check the path and IDs |\n| `429` | Rate limit reached | Wait for `Retry-After` seconds, then retry |\n\n## Building with AI coding tools\n\nIf you use an AI assistant to write your integration, give it the machine-readable spec at [https://developer.snapcom.com/openapi.json](https://developer.snapcom.com/openapi.json) or the summary at [https://developer.snapcom.com/llms.txt](https://developer.snapcom.com/llms.txt), and include these rules in your prompt:\n\n```text\nUse the Snapcom API at https://developer.snapcom.com/api/v2 with a bearer API key kept server side.\nPage through lists with limit=100 and start, stopping at a short page.\nOn HTTP 429, wait for the Retry-After header before retrying.\nUse Event Subscriptions instead of polling, and cache data that rarely changes.\n```\n", "contact": { "name": "Snapcom support", "email": "support@snapcom.com" } }, "tags": [ { "name": "Phone Numbers" }, { "name": "Phone Numbers/Use Cases" }, { "name": "Phones/Macs" }, { "name": "Phones/Macs/Supported Models and Servers" }, { "name": "SnapBuilder" }, { "name": "SnapBuilder/Phone Templates" }, { "name": "Version" }, { "name": "Your API key" }, { "name": "Event Subscriptions" }, { "name": "Domains" }, { "name": "Users" }, { "name": "Devices" }, { "name": "Sites" }, { "name": "Call Center/Callqueues" }, { "name": "Call Center/Agents" }, { "name": "Call Center/Agent Actions" }, { "name": "Call Center/QueuedCalls" }, { "name": "Call Center/Statistics" }, { "name": "Answer Rules" }, { "name": "Call Blocking" }, { "name": "Auto Attendant" }, { "name": "Media/Voicemail" }, { "name": "Media/Greetings" }, { "name": "Media/Music on Hold/Domain" }, { "name": "Media/Music on Hold/User" }, { "name": "Media/Hold Messages/Domain" }, { "name": "Media/Hold Messages/User" }, { "name": "Media/Text to Speech" }, { "name": "CDR (Call History)" }, { "name": "CDR Schedule" }, { "name": "Transcriptions & Sentiment" }, { "name": "Call Traces & Cradle to Grave" }, { "name": "Calls (live/active calls)" }, { "name": "Contacts" }, { "name": "Contacts/Shared Contacts" }, { "name": "Addresses" }, { "name": "Voicemail Reminders" }, { "name": "Dialrule" }, { "name": "Dial Permisions" }, { "name": "Messages" }, { "name": "Messages/SMS Block" }, { "name": "SMS Numbers" }, { "name": "Recordings" }, { "name": "Email" }, { "name": "Meetings" }, { "name": "Meetings/Event Logs" }, { "name": "Meetings/Iotum" }, { "name": "Images" }, { "name": "Templates" }, { "name": "Timeframes/Domain (Shared)" }, { "name": "Timeframes/Domain (Shared)/Always" }, { "name": "Timeframes/Domain (Shared)/Specific Dates" }, { "name": "Timeframes/User" }, { "name": "Timeframes/User/Always" }, { "name": "Timeframes/User/Specific Dates" }, { "name": "Timeframes/Holiday Information" }, { "name": "iNSight" }, { "name": "Conference/Conferences" }, { "name": "Conference/Participants" }, { "name": "Charts" }, { "name": "Dashboards" }, { "name": "Quotas" }, { "name": "Departments" }, { "name": "Presence" }, { "name": "Audit Log" }, { "name": "Access Log" }, { "name": "ReadOnlyDomain" }, { "name": "44.3" }, { "name": "hidetemp" }, { "name": "44.4" }, { "name": "Iotum" } ], "paths": { "/version": { "get": { "summary": "Read API Version ", "deprecated": false, "description": "", "operationId": "Version", "tags": [ "Version" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiversion": { "type": "string", "description": "The version the API is currently running" }, "hostname": { "type": "string", "description": "The hostname of the server connected to" }, "current-time": { "type": "string", "description": "The current timestamp as seen by the server" } }, "required": [ "apiversion", "hostname" ] } } }, "headers": {} } }, "security": [] } }, "/apikeys/~": { "get": { "summary": "Read API Key info on your API Key", "deprecated": false, "description": "This parameter-less action will return the information on the API key being used for the request giving confirmation on access levels allowed. ", "operationId": "ReadMyApikey", "tags": [ "Your API key" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKey" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/subscriptions": { "get": { "summary": "Read Event Subscriptions", "deprecated": false, "description": "", "operationId": "ReadSubscriptions", "tags": [ "Event Subscriptions" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Subscription" } } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "post": { "summary": "Create a Event Subscription", "deprecated": false, "description": "", "operationId": "CreateSubscription", "tags": [ "Event Subscriptions" ], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "model": { "type": "string", "description": "This is the type of data that will be sent. you will need to reqest multiple subscriptions if you want more than one model.", "enum": [ "agent", "auditlog", "auditlog_lite", "call", "call_origid", "cdr", "message", "messagesession", "subscriber", "presence", "voicemail" ] }, "post-url": { "type": "string", "description": "This is the url the API will be posting data to. Should be in the format including https://. Can make a custom port if needed and the URL should have a valid SSL certificate as well. Http:// is supproted but not ideal for production. ", "examples": [ "https://webhook.example.com/event" ], "format": "url" }, "subscription-geo-support": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "reseller": { "type": "string", "description": "This is the reseller that the subscription will filter data for. * will be used for all resellers, but only valid with Super User scope on the request. " }, "domain": { "type": "string", "description": "This is the domain that the subscription will filter data for. \"*\" will be used for all domains, but only valid with Super User scope", "default": "*" }, "user": { "type": "string", "description": "This is the user that the subscription will filter data for. * will be used for all users.", "default": "*" }, "subscription-expires-datetime": { "type": "string", "description": "This timestamp in the format of YYYY-MM-DD HH:MM:SS will be with the subscription will expire. After it expires it will be removed after some amount of time. If left blank it will set the expires time to the expires time of the timed token used, if using a APIkey it will be 20 years from the creation date that it will set for the expires for the new subscription", "format": "date-time" }, "preferred-server": { "type": "string", "description": "This is the server hostname for the prefered server for this subscription, meaning if this server is up and online it will be the one sending the events. It wil fail back to this servre after 60s of stability. ", "format": "hostname", "examples": [ "core1.example.com" ] } } }, "example": { "post-url": "https://local.example.com/log.php", "model": "call", "user": "*", "reseller": "*", "domain": "*", "user-scope": "Super User", "subscription-geo-support": "yes", "server_preferred": "eng0-san.example.com" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": { "id": "f38d00a5eed9d15603922fe98db23600", "subscription-geo-support": "yes", "post-url": "https://local.example.com/log.php", "model": "call", "user-scope": "Super User", "reseller": "*", "domain": "*", "user": "*", "preferred-server": "eng0-san.example.com", "current-active-server": "", "status": "pending", "error-count": 0, "posts-count": 0, "subscription-creation-datetime": "2023-10-09 17:16:36", "subscription-expires-datetime": "2043-10-04 17:16:36" } } }, "headers": {} }, "409": { "description": "Subscription already exists", "content": { "application/json": { "schema": { "title": "", "type": "object", "properties": { "message": { "type": "string", "description": "\"Subscription ID already Exists or matching set of parameters already exists\"" } }, "required": [ "message" ] } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/subscriptions": { "get": { "summary": "Read Event Subscriptions for Domain", "deprecated": false, "description": "", "operationId": "ReadSubscriptionsDomain", "tags": [ "Event Subscriptions" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "example", "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Subscription" } } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "post": { "summary": "Create a Event Subscription for Domain", "deprecated": false, "description": "", "operationId": "CreateSubscriptionDomain", "tags": [ "Event Subscriptions" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "model": { "type": "string", "description": "This is the type of data that will be sent. you will need to reqest multiple subscriptions if you want more than one model.", "enum": [ "agent", "auditlog", "auditlog_lite", "call", "call_origid", "cdr", "message", "messagesession", "subscriber", "presence", "voicemail" ] }, "post-url": { "type": "string", "description": "This is the url the API will be posting data to. Should be in the format including https://. Can make a custom port if needed and the URL should have a valid SSL certificate as well. Http:// is supproted but not ideal for production. ", "examples": [ "https://webhook.example.com/event" ], "format": "url" }, "subscription-geo-support": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "reseller": { "type": "string", "description": "This is the reseller that the subscription will filter data for. * will be used for all resellers, but only valid with Super User scope on the request. " }, "domain": { "type": "string", "description": "This is the domain that the subscription will filter data for. \"*\" will be used for all domains, but only valid with Super User scope", "default": "*" }, "user": { "type": "string", "description": "This is the user that the subscription will filter data for. * will be used for all users.", "default": "*" }, "subscription-expires-datetime": { "type": "string", "description": "This timestamp in the format of YYYY-MM-DD HH:MM:SS will be with the subscription will expire. After it expires it will be removed after some amount of time. If left blank it will set the expires time to the expires time of the timed token used, if using a APIkey it will be 20 years from the creation date that it will set for the expires for the new subscription", "format": "date-time" }, "preferred-server": { "type": "string", "description": "This is the server hostname for the prefered server for this subscription, meaning if this server is up and online it will be the one sending the events. It wil fail back to this servre after 60s of stability. ", "format": "hostname", "examples": [ "core1.example.com" ] } } }, "example": { "post-url": "https://local.example.com/log.php", "model": "call", "user": "*", "reseller": "*", "domain": "*", "user-scope": "Super User", "subscription-geo-support": "yes", "server_preferred": "eng0-san.example.com" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": { "id": "f38d00a5eed9d15603922fe98db23600", "subscription-geo-support": "yes", "post-url": "https://local.example.com/log.php", "model": "call", "user-scope": "Super User", "reseller": "*", "domain": "*", "user": "*", "preferred-server": "eng0-san.example.com", "current-active-server": "", "status": "pending", "error-count": 0, "posts-count": 0, "subscription-creation-datetime": "2023-10-09 17:16:36", "subscription-expires-datetime": "2043-10-04 17:16:36" } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "409": { "description": "Subscription already exists", "content": { "application/json": { "schema": { "title": "", "type": "object", "properties": { "message": { "type": "string", "description": "\"Subscription ID already Exists or matching set of parameters already exists\"" } }, "required": [ "message" ] } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/subscriptions/{id}": { "get": { "summary": "Read Event Subscription By Id", "deprecated": false, "description": "", "operationId": "ReadSubscription", "tags": [ "Event Subscriptions" ], "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "example": "a4a8d60aa4d735f8f16087143ba5500f", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription" }, "example": { "id": "f38d00a5eed9d15603922fe98db23630", "subscription-geo-support": "yes", "post-url": "https://local.example.com/log.php", "model": "call", "user-scope": "Super User", "reseller": "*", "domain": "*", "user": "*", "preferred-server": "eng0-san.example.com", "current-active-server": "", "status": "pending", "error-count": 0, "posts-count": 0, "subscription-creation-datetime": "2023-10-09 17:16:36", "subscription-expires-datetime": "2043-10-04 17:16:36" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "put": { "summary": "Update an Event Subscription", "deprecated": false, "description": "", "operationId": "UpdateSubscription", "tags": [ "Event Subscriptions" ], "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "example": "369a5b1f9afa32c060167b68c225f8d0", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "model": { "type": "string", "description": "This is the type of data that will be sent. you will need to reqest multiple subscriptions if you want more than one model.", "enum": [ "agent", "auditlog", "auditlog_lite", "call", "call_origid", "cdr", "message", "messagesession", "subscriber", "presence", "voicemail" ] }, "post-url": { "type": "string", "description": "This is the url the API will be posting data to. Should be in the format including https://. Can make a custom port if needed and the URL should have a valid SSL certificate as well. Http:// is supproted but not ideal for production. ", "examples": [ "https://webhook.example.com/event" ], "format": "url" }, "subscription-geo-support": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "subscription-expires-datetime": { "type": "string", "description": "This timestamp in the format of YYYY-MM-DD HH:MM:SS will be with the subscription will expire. After it expires it will be removed after some amount of time. If left blank it will set the expires time to the expires time of the timed token used, if using a APIkey it will be 20 years from the creation date that it will set for the expires for the new subscription", "format": "date-time" }, "preferred-server": { "type": "string", "description": "This is the server hostname for the prefered server for this subscription, meaning if this server is up and online it will be the one sending the events. It wil fail back to this servre after 60s of stability. ", "format": "hostname", "examples": [ "core1.example.com" ] }, "error-count": { "type": "integer", "description": "This is the number of attempted post's that resulted in a error, either an inability to send to a server (network,dns, timeout, etc..) or a response code that is above a 302. This value can be \"reset\" by setting it to 0 in a update request, but only 0 is allowed value. " }, "posts-count": { "type": "integer", "description": "This is the number of attempted post's in this schedule. This includes error and success attempts. This value can be \"reset\" by setting it to 0 in a update request, but only 0 is allowed value. " } } }, "example": { "post-url": "https://local.example.com/event2", "error-count": 0, "posts-count": 0 } } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "delete": { "summary": "Delete a subscription", "deprecated": false, "description": "", "operationId": "DeleteSubscription", "tags": [ "Event Subscriptions" ], "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "subscription_id": { "type": "string", "description": "ID of subscription to be deleted" }, "domain": { "type": "string", "description": "Required when requests are submitted as scopes lower than Super User" } }, "required": [ "subscription_id" ] }, "examples": {} } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/subscriptions/{id}": { "put": { "summary": "Update an Event Subscription for Domain", "deprecated": false, "description": "", "operationId": "UpdateSubscriptionDomain", "tags": [ "Event Subscriptions" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "example", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "id", "in": "path", "description": "", "required": true, "example": "369a5b1f9afa32c060167b68c225f8d0", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "model": { "type": "string", "description": "This is the type of data that will be sent. you will need to reqest multiple subscriptions if you want more than one model.", "enum": [ "agent", "auditlog", "auditlog_lite", "call", "call_origid", "cdr", "message", "messagesession", "subscriber", "presence", "voicemail" ] }, "post-url": { "type": "string", "description": "This is the url the API will be posting data to. Should be in the format including https://. Can make a custom port if needed and the URL should have a valid SSL certificate as well. Http:// is supproted but not ideal for production. ", "examples": [ "https://webhook.example.com/event" ], "format": "url" }, "subscription-geo-support": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "subscription-expires-datetime": { "type": "string", "description": "This timestamp in the format of YYYY-MM-DD HH:MM:SS will be with the subscription will expire. After it expires it will be removed after some amount of time. If left blank it will set the expires time to the expires time of the timed token used, if using a APIkey it will be 20 years from the creation date that it will set for the expires for the new subscription", "format": "date-time" }, "preferred-server": { "type": "string", "description": "This is the server hostname for the prefered server for this subscription, meaning if this server is up and online it will be the one sending the events. It wil fail back to this servre after 60s of stability. ", "format": "hostname", "examples": [ "core1.example.com" ] }, "error-count": { "type": "integer", "description": "This is the number of attempted post's that resulted in a error, either an inability to send to a server (network,dns, timeout, etc..) or a response code that is above a 302. This value can be \"reset\" by setting it to 0 in a update request, but only 0 is allowed value. " }, "posts-count": { "type": "integer", "description": "This is the number of attempted post's in this schedule. This includes error and success attempts. This value can be \"reset\" by setting it to 0 in a update request, but only 0 is allowed value. " } } }, "example": { "post-url": "https://local.example.com/event2", "error-count": 0, "posts-count": 0 } } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "delete": { "summary": "Delete a subscription For Domain", "deprecated": false, "description": "", "operationId": "DeleteSubscriptionDomain", "tags": [ "Event Subscriptions" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}": { "get": { "summary": "Get Specific Domain", "deprecated": false, "description": "", "operationId": "GetDomain", "tags": [ "Domains" ], "parameters": [ { "name": "domain", "in": "path", "description": "The Domain name for the resource being requested", "required": true, "example": "example.com", "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": { "$ref": "#/components/schemas/DomainName" }, "reseller": { "type": "string", "description": "This is the reseller that owns this domain. Must be a valid resller name on creation. If Reseller level scope you can use \"~\" to set your own reseller on create, Super User's will need to set this to a valid Reseller. " }, "description": { "type": "string", "description": "This is a description of the domain. This will be shown in many places to help show a more user friendly version of the domain to help identify it. " }, "music-on-hold-enabled": { "$ref": "#/components/schemas/YesNoString", "description": "Enabled will trigger music on hold for the domain and allow it to be customized. " }, "music-on-ring-enabled": { "$ref": "#/components/schemas/YesNoString", "description": "Enabled will trigger music on hold for the domain and allow it to be customized. " }, "music-on-hold-randomized-enabled": { "$ref": "#/components/schemas/YesNoString", "description": "Enabled will trigger music on hold for the domain and allow it to be customized. " }, "domain-type": { "type": "string", "enum": [ "Standard", "Residential", "Hospitality" ], "description": "Allows a special domain type to be set for specific use cases. Currently Residenital and Hospitality are options which will limit and effect the users expierence. " }, "dial-plan": { "type": "string", "description": "This is the default dial plan that will be used for new users created in the domain. A dial plan is created by default on new domain creation with a name matching the domain. " }, "dial-policy": { "type": "string", "description": "This is the default dial policy (permission) that will be used for new users added ot the domain. Generally these are system wide policies and will not need to create one per domain. " }, "email-send-from-address": { "type": "string", "description": "This is the email source that will be used when sending out emails for this domain. This address should be configured properly through the email server so that emails are not blocked. In most cases this is recommended to be an address on the service providers or resellers hostname so DNS SPF records can be added on the hostname to prevent spam issues. More info on SPF records available via https://www.cloudflare.com/learning/dns/dns-records/dns-spf-record/" }, "single-sign-on-enabled": { "$ref": "#/components/schemas/YesNoString", "description": "Enabled will trigger music on hold for the domain and allow it to be customized. " }, "area-code": { "type": "number", "description": "The default area code for the domain. This is used by default on 7 digit dials to extent the number to a valid 10 digit number. ", "minimum": 100, "maximum": 999, "examples": [ 858 ] }, "caller-id-name": { "type": "string", "description": "This is the main caller id name for the user to be used for outbound calls outside of the domain. " }, "caller-id-number": { "type": [ "string", "integer", "boolean", "array", "object", "number", "null" ], "description": "This is the main caller id number for the user to be used for outbound calls outside of the domain. " }, "caller-id-number-emergency": { "type": [ "string", "integer", "boolean", "array", "object", "number", "null" ], "description": "This is the main caller id that will be used for emergency calls when placed by the user. " }, "limits-max-subcriber-resources-total": { "type": "integer", "description": "This is the maximum number of subscribers allowed for domain including the subscribers that would be created as part of resources like call queues and auto attendants. If looking to limit nornal users it would be better to use limits-max-users" }, "limits-max-active-calls-total": { "type": "integer", "description": "This is the limit for the number of active calls allowed in the domain simultaniously. Note: this will count and limit intra domain calls. " }, "limits-max-active-calls-offnet": { "type": "integer", "description": "This is the limit for the number of active calls allowed in the domain simultaniously that are connected to offnet or external numbers. " }, "limits-max-call-queues": { "type": "integer", "description": "This is the maximum number of call queues that would be allowed to be created in this domain. " }, "limits-max-auto-attendants": { "type": "integer", "description": "This is the maximum number of auto attendants that would be allowed to be created in this domain. " }, "limits-max-conferences": { "type": "integer", "description": "This is the maximum number of conference bridges that would be allowed to be created in this domain. " }, "limits-max-departments": { "type": "integer", "description": "This is the maximum number of departments that would be allowed to be created in this domain. " }, "limits-max-users": { "type": "integer", "description": "This is the maximum number of regular users that would be allowed to be created in this domain. " }, "limits-max-sites": { "type": "integer", "description": "This is the maximum number of sites that would be allowed to be created in this domain. " }, "limits-max-fax-accounts": { "type": "integer", "description": "This is the maximum number of fax accounts that would be allowed to be created in this domain. " }, "time-zone": { "$ref": "#/components/schemas/TimeZone" }, "email-send-smtp-hostname": { "type": [ "string", "null" ], "description": "This is the SMTP server hostname. SMTP server configs are NOT required at domain level as they will inherit reseller or system level as needed. ", "format": "hostname" }, "email-send-smtp-port": { "type": [ "string", "null" ], "description": "This is the SMTP port for sending emails. SMTP server configs are NOT required at domain level as they will inherit reseller or system level as needed. " }, "email-send-smtp-username": { "type": [ "string", "null" ], "description": "This is the username used in connecting to SMTP server for sending email. SMTP server configs are NOT required at domain level as they will inherit reseller or system level as needed. " }, "email-send-smtp-password": { "type": [ "string", "null" ], "description": "This is the password used in connecting to SMTP server for sending email. SMTP server configs are NOT required at domain level as they will inherit reseller or system level as needed. ", "format": "pass" }, "active-calls-total-current": { "type": "integer", "readOnly": true, "description": "This is the total active calls for the domain including on-net (intra domain) calls and calls across geo servers and calls linked to \"guest\" video sessions" }, "active-calls-against-license-count": { "type": "integer", "readOnly": true, "description": "This is the total active calls for the domain including on-net (intra domain) calls but counted as the license would be enforced inlcuding ignoring geo call legs and guest video sessions. " }, "active-calls-offnet-current": { "type": "integer", "readOnly": true, "description": "This is the total active calls for the domain only including calls that are connected to a remote (non intra domain) caller/calling party." }, "count-subcriber-resources-total": { "type": "integer", "description": "This is the total number of users plus all the system users as well for the entire domain. ", "readOnly": true }, "emergency-address-id": { "type": [ "string", "null" ], "description": "Value will need to be an exact match to an address-id which links to a address for DLR (dynamic location routing) for emergency calling" }, "voicemail-enabled": { "$ref": "#/components/schemas/YesNoString", "description": "Enabled will trigger music on hold for the domain and allow it to be customized. " }, "recording-configuration": { "$ref": "#/components/schemas/RecordingConfiguration" }, "voicemail-transcription-enabled": { "type": "string", "description": "Enable this setting and select a vendor if you wish to have voicemails transcripted after a voicemail is recorded. ", "enum": [ "no", "deepgram", "google", "mutare", "voicebase" ], "default": "no" }, "language-token": { "type": "string", "description": "This is the language that is set for the user to be used for portal viewing. ", "default": "en_US", "examples": [ "es_MX", "en_CA" ] }, "is-domain-locked": { "$ref": "#/components/schemas/YesNoString", "description": "Enabled will trigger music on hold for the domain and allow it to be customized. " }, "is-stir-enabled": { "$ref": "#/components/schemas/YesNoString", "description": "Enabled will trigger music on hold for the domain and allow it to be customized. " }, "is-ivr-forward-change-blocked": { "$ref": "#/components/schemas/YesNoString", "description": "Enabled will trigger music on hold for the domain and allow it to be customized. " } }, "required": [ "domain", "reseller", "description" ] }, "example": { "domain": "apidog2.Example2", "reseller": "Example2", "description": "apidog2.Example2", "active-calls-assessable-current": 0, "active-calls-offnet-current": 0, "active-calls-total-current": 0, "area-code": 858, "caller-id-name": "Acme Inc", "caller-id-number": 4623586947, "caller-id-number-emergency": 4190117524, "count-system-objects-total": 1, "dial-plan": "Default", "dial-policy": "US and Canada", "email-send-from-address": "no-reply@example.com", "email-send-smtp-hostname": "", "email-send-smtp-password": "", "email-send-smtp-port": "", "email-send-smtp-username": "", "emergency-address-id": "", "is-residental": "no", "language-token": "en_US", "limits-max-active-calls-offnet": 10, "limits-max-active-calls-total": 15, "limits-max-auto-attendants": 0, "limits-max-call-queues": 0, "limits-max-conferences": 0, "limits-max-departments": 0, "limits-max-devices": 0, "limits-max-fax-accounts": -1, "limits-max-sites": 0, "limits-max-system-objects-total": 0, "limits-max-users-toal": 0, "music-on-hold-enabled": "yes", "music-on-hold-randomized-enabled": "no", "music-on-ring-enabled": "no", "policies": "active", "single-sign-on-enabled": "yes", "time-zone": "US/Pacific", "voicemail-transcription-enabled": "no", "voicemail-user-control-enabled": "yes" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "put": { "summary": "Update a Domain", "deprecated": false, "description": "", "operationId": "UpdateDomain", "tags": [ "Domains" ], "parameters": [ { "name": "domain", "in": "path", "description": "This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise.", "required": true, "example": "example.com", "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "reseller": { "type": "string", "description": "This is the reseller that owns this domain. Must be a valid resller name on creation. If Reseller level scope you can use \"~\" to set your own reseller on create, Super User's will need to set this to a valid Reseller. " }, "description": { "type": "string", "description": "This is a description of the domain. This will be shown in many places to help show a more user friendly version of the domain to help identify it. " }, "music-on-hold-enabled": { "$ref": "#/components/schemas/YesNoString", "description": "Enabled will trigger music on hold for the domain and allow it to be customized. " }, "music-on-ring-enabled": { "$ref": "#/components/schemas/YesNoString", "description": "Enabled will trigger music on hold for the domain and allow it to be customized. " }, "music-on-hold-randomized-enabled": { "$ref": "#/components/schemas/YesNoString", "description": "Enabled will trigger music on hold for the domain and allow it to be customized. " }, "domain-type": { "type": "string", "enum": [ "Standard", "Residential", "Hospitality" ], "description": "Allows a special domain type to be set for specific use cases. Currently Residenital and Hospitality are options which will limit and effect the users expierence. " }, "dial-plan": { "type": "string", "description": "This is the default dial plan that will be used for new users created in the domain. A dial plan is created by default on new domain creation with a name matching the domain. " }, "dial-policy": { "type": "string", "description": "This is the default dial policy (permission) that will be used for new users added ot the domain. Generally these are system wide policies and will not need to create one per domain. " }, "email-send-from-address": { "type": "string", "description": "This is the email source that will be used when sending out emails for this domain. This address should be configured properly through the email server so that emails are not blocked. In most cases this is recommended to be an address on the service providers or resellers hostname so DNS SPF records can be added on the hostname to prevent spam issues. More info on SPF records available via https://www.cloudflare.com/learning/dns/dns-records/dns-spf-record/" }, "single-sign-on-enabled": { "$ref": "#/components/schemas/YesNoString", "description": "Enabled will trigger music on hold for the domain and allow it to be customized. " }, "area-code": { "type": "number", "description": "The default area code for the domain. This is used by default on 7 digit dials to extent the number to a valid 10 digit number. ", "minimum": 100, "maximum": 999, "examples": [ 858 ] }, "caller-id-name": { "type": "string", "description": "This is the main caller id name for the user to be used for outbound calls outside of the domain. " }, "caller-id-number": { "type": [ "string", "integer", "boolean", "array", "object", "number", "null" ], "description": "This is the main caller id number for the user to be used for outbound calls outside of the domain. " }, "caller-id-number-emergency": { "type": [ "string", "integer", "boolean", "array", "object", "number", "null" ], "description": "This is the main caller id that will be used for emergency calls when placed by the user. " }, "limits-max-subcriber-resources-total": { "type": "integer", "description": "This is the maximum number of subscribers allowed for domain including the subscribers that would be created as part of resources like call queues and auto attendants. If looking to limit nornal users it would be better to use limits-max-users" }, "limits-max-active-calls-total": { "type": "integer", "description": "This is the limit for the number of active calls allowed in the domain simultaniously. Note: this will count and limit intra domain calls. " }, "limits-max-active-calls-offnet": { "type": "integer", "description": "This is the limit for the number of active calls allowed in the domain simultaniously that are connected to offnet or external numbers. " }, "limits-max-call-queues": { "type": "integer", "description": "This is the maximum number of call queues that would be allowed to be created in this domain. " }, "limits-max-auto-attendants": { "type": "integer", "description": "This is the maximum number of auto attendants that would be allowed to be created in this domain. " }, "limits-max-conferences": { "type": "integer", "description": "This is the maximum number of conference bridges that would be allowed to be created in this domain. " }, "limits-max-departments": { "type": "integer", "description": "This is the maximum number of departments that would be allowed to be created in this domain. " }, "limits-max-users": { "type": "integer", "description": "This is the maximum number of regular users that would be allowed to be created in this domain. " }, "limits-max-sites": { "type": "integer", "description": "This is the maximum number of sites that would be allowed to be created in this domain. " }, "limits-max-fax-accounts": { "type": "integer", "description": "This is the maximum number of fax accounts that would be allowed to be created in this domain. " }, "time-zone": { "$ref": "#/components/schemas/TimeZone" }, "email-send-smtp-hostname": { "type": [ "string", "null" ], "description": "This is the SMTP server hostname. SMTP server configs are NOT required at domain level as they will inherit reseller or system level as needed. ", "format": "hostname" }, "email-send-smtp-port": { "type": [ "string", "null" ], "description": "This is the SMTP port for sending emails. SMTP server configs are NOT required at domain level as they will inherit reseller or system level as needed. " }, "email-send-smtp-username": { "type": [ "string", "null" ], "description": "This is the username used in connecting to SMTP server for sending email. SMTP server configs are NOT required at domain level as they will inherit reseller or system level as needed. " }, "email-send-smtp-password": { "type": [ "string", "null" ], "description": "This is the password used in connecting to SMTP server for sending email. SMTP server configs are NOT required at domain level as they will inherit reseller or system level as needed. ", "format": "pass" }, "active-calls-total-current": { "type": "integer", "readOnly": true, "description": "This is the total active calls for the domain including on-net (intra domain) calls and calls across geo servers and calls linked to \"guest\" video sessions" }, "active-calls-against-license-count": { "type": "integer", "readOnly": true, "description": "This is the total active calls for the domain including on-net (intra domain) calls but counted as the license would be enforced inlcuding ignoring geo call legs and guest video sessions. " }, "active-calls-offnet-current": { "type": "integer", "readOnly": true, "description": "This is the total active calls for the domain only including calls that are connected to a remote (non intra domain) caller/calling party." }, "count-subcriber-resources-total": { "type": "integer", "description": "This is the total number of users plus all the system users as well for the entire domain. ", "readOnly": true }, "emergency-address-id": { "type": [ "string", "null" ], "description": "Value will need to be an exact match to an address-id which links to a address for DLR (dynamic location routing) for emergency calling" }, "voicemail-enabled": { "$ref": "#/components/schemas/YesNoString", "description": "Enabled will trigger music on hold for the domain and allow it to be customized. " }, "recording-configuration": { "$ref": "#/components/schemas/RecordingConfiguration" }, "voicemail-transcription-enabled": { "type": "string", "description": "Enable this setting and select a vendor if you wish to have voicemails transcripted after a voicemail is recorded. ", "enum": [ "no", "Deepgram", "Google", "Mutare", "Voicebase" ], "default": "no" }, "language-token": { "type": "string", "description": "This is the language that is set for the user to be used for portal viewing. ", "default": "en_US", "examples": [ "es_MX", "en_CA" ] }, "is-domain-locked": { "$ref": "#/components/schemas/YesNoString", "description": "Enabled will trigger music on hold for the domain and allow it to be customized. " }, "is-stir-enabled": { "$ref": "#/components/schemas/YesNoString", "description": "Enabled will trigger music on hold for the domain and allow it to be customized. " }, "is-ivr-forward-change-blocked": { "$ref": "#/components/schemas/YesNoString", "description": "Enabled will trigger music on hold for the domain and allow it to be customized. " } } }, "example": { "domain-type": "Residential", "description": "This is a example Domain." } } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/billing": { "get": { "summary": "Get Specific Domain With Billing Summary", "deprecated": false, "description": "", "operationId": "DomainBilling", "tags": [ "Domains" ], "parameters": [ { "name": "domain", "in": "path", "description": "The Domain name for the resource being requested", "required": true, "example": "example.com", "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Domain" }, "example": { "domain": "example.com", "territory": "Example2", "dial_match": "", "description": "Sample Domain", "moh": "yes", "mor": "no", "mot": "no", "rmoh": "no", "rating": "no", "resi": "no", "mksdir": "yes", "sso": "yes", "call_limit": 0, "call_limit_ext": 0, "sub_limit": 0, "max_call_queue": 0, "max_aa": 0, "max_conference": 0, "max_department": 0, "max_user": 0, "max_device": 0, "time_zone": "US/Pacific", "dial_plan": "portal", "dial_policy": "US and Canada", "policies": "active", "email_sender": "vmail@example.com", "smtp_host": "", "smtp_port": "", "smtp_uid": "", "smtp_pwd": "", "from_user": "[*]", "from_host": "[*]", "active_call": 0, "countForLimit": 0, "countExternal": 0, "sub_count": 137, "max_site": 0, "max_fax": -1, "address_id": "a-63d07bd75d0b1", "vmail_provisioned": "no", "callid_nmbr": 8005551234, "callid_name": "Example Co", "callid_emgr": 2014222707, "area_code": 858, "vmail_transcribe": "no", "language": "en_us" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/~": { "get": { "summary": "Get My Domain Info", "deprecated": false, "description": "", "operationId": "GetMyDomain", "tags": [ "Domains" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Domain" }, "example": { "domain": "example.com", "reseller": "Example2", "description": "This is a example Domain.", "active-calls-against-license-count": 0, "active-calls-offnet-current": 0, "active-calls-total-current": 0, "area-code": 947, "caller-id-name": "Pfannerstill - Graham", "caller-id-number": 8005552134, "caller-id-number-emergency": 8005552134, "count-system-objects-total": 5, "dial-plan": "Default", "dial-policy": "US and Canada", "domain-type": "Hospitality", "email-send-from-address": "vmail@example.com", "email-send-smtp-hostname": "", "email-send-smtp-password": "", "email-send-smtp-port": "", "email-send-smtp-username": "", "emergency-address-id": "", "is-domain-locked": "no", "is-ivr-forward-change-blocked": "no", "is-stir-enabled": "no", "language-token": "en_US", "limits-max-active-calls-offnet": 10, "limits-max-active-calls-total": 15, "limits-max-auto-attendants": 0, "limits-max-call-queues": 0, "limits-max-conferences": 0, "limits-max-departments": 0, "limits-max-devices": 0, "limits-max-fax-accounts": -1, "limits-max-sites": 0, "limits-max-system-objects-total": 0, "limits-max-users-toal": 0, "music-on-hold-enabled": "yes", "music-on-hold-randomized-enabled": "yes", "music-on-ring-enabled": "no", "single-sign-on-enabled": "yes", "time-zone": "US/Pacific", "voicemail-transcription-enabled": "no", "voicemail-user-control-enabled": "yes" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/count": { "get": { "summary": "Check if Domain Exists", "deprecated": false, "description": "", "operationId": "CountDomain", "tags": [ "Domains" ], "parameters": [ { "name": "domain", "in": "path", "description": "The Domain name for the resource being requested", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Count" }, "example": { "total": 1 } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/phonenumbers": { "put": { "summary": "Send Phonenumber to Call Queue", "deprecated": false, "description": "This API will allow updating of an existing number in a domain. ", "operationId": "UpdatePhonenumberQueue", "tags": [ "Phone Numbers/Use Cases" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "phonenumber": { "type": "string", "description": "This is the main phonenumber setting. Should be a formated in a e164 format with country count and number. US domestic numbers should be similiar to 18005551234", "examples": [ "18005551234" ] }, "enabled": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "dial-rule-application": { "$ref": "#/components/schemas/DialruleApplication" }, "dial-rule-parameter": { "type": "string", "description": "This is the application parameter field that can be used for additional settings based on the dial-rule-application. Default is empty string. " }, "dial-rule-translation-destination-user": { "type": "string", "description": "This is the forward destination the call will be sent to in partnership with the application (dial-rule-application) and host (dial-rule-translation-destination-host). This might be a user, queue or offnet number depending on the application. ", "examples": [ "1000", "2500", "18005551234" ] }, "dial-rule-translation-destination-host": { "type": "string", "description": "This is the forward destination host the call will be sent to in partnership with the application (dial-rule-application) and user (dial-rule-translation-destination-user). This might be the domain name or a connection name if trying to route offnet. ", "default": "[*]", "examples": [ "example.com", "" ] }, "dial-rule-translation-source-name": { "type": "string", "description": "This field will allow customization of the source \"name\" often used for the caller id name or the the descriptive quoted value outside of the sip uri. Defaults to [*] but you can add a prefix for example with something like this, sales_[*]", "default": "[*]", "examples": [ "sales_[*]", "[*]", "" ] }, "dial-rule-description": { "type": "string", "description": "This is a description of the number/rule that can be used for defintion or tracking purposes. " } }, "required": [ "phonenumber", "dial-rule-translation-destination-user" ] }, "example": { "phonenumber": "{{demo_phonenumber}}", "responder": "sip:start@call-queuing", "to_user": "3000", "to_host": "{{domain}}", "plan_description": "For Marketing to Queue" } } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} }, "409": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 409, "message": "Phone number already exists" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "get": { "summary": "Get All Phone Numbers for Domain", "deprecated": false, "description": "", "operationId": "GetDomainPhonenumbers", "tags": [ "Phone Numbers" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Phonenumber" } } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "post": { "summary": "Add Phone Number in Domain", "deprecated": false, "description": "This will allow adding a phone number. ", "operationId": "CreatePhonenumber", "tags": [ "Phone Numbers" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "phonenumber": { "type": "string", "description": "This is the main phonenumber setting. Should be a formated in a e164 format with country count and number. US domestic numbers should be similiar to 18005551234", "examples": [ "18005551234" ] }, "enabled": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "dial-rule-application": { "$ref": "#/components/schemas/DialruleApplication" }, "dial-rule-parameter": { "type": "string", "description": "This is the application parameter field that can be used for additional settings based on the dial-rule-application. Default is empty string. " }, "dial-rule-translation-destination-user": { "type": "string", "description": "This is the forward destination the call will be sent to in partnership with the application (dial-rule-application) and host (dial-rule-translation-destination-host). This might be a user, queue or offnet number depending on the application. ", "examples": [ "1000", "2500", "18005551234" ] }, "dial-rule-translation-destination-host": { "type": "string", "description": "This is the forward destination host the call will be sent to in partnership with the application (dial-rule-application) and user (dial-rule-translation-destination-user). This might be the domain name or a connection name if trying to route offnet. ", "default": "[*]", "examples": [ "example.com", "" ] }, "dial-rule-translation-source-name": { "type": "string", "description": "This field will allow customization of the source \"name\" often used for the caller id name or the the descriptive quoted value outside of the sip uri. Defaults to [*] but you can add a prefix for example with something like this, sales_[*]", "default": "[*]", "examples": [ "sales_[*]", "[*]", "" ] }, "dial-rule-description": { "type": "string", "description": "This is a description of the number/rule that can be used for defintion or tracking purposes. " } }, "required": [ "phonenumber", "dial-rule-translation-destination-user" ] }, "example": { "phonenumber": "{{demo_phonenumber}}", "enabled": "yes", "dial-rule-matching-start-date": "*", "dial-rule-matching-end-date": "*", "dial-rule-application": "available-number", "dial-rule-translation-destination-user": "[*]", "dial-rule-translation-destination-host": "[*]", "dial-rule-translation-source-name": "[*]", "dial-rule-description": "Test Number" } } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} }, "409": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 409, "message": "Phone number already exists" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/phonenumbers/count": { "get": { "summary": "Count Phone Numbers for Domain", "deprecated": false, "description": "", "operationId": "CountDomainPhonenumbers", "tags": [ "Phone Numbers" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Count" }, "example": { "total": 3 } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/phonenumbers": { "get": { "summary": "Get All Phone Numbers for System or Reseller", "deprecated": false, "description": "This path will give you all Phonenumbers (DIDs) that are accessable based on the access rights of the Access Token or API Key used to make the requests. Super User or Reseller both supported, but for per domain lookups you should use /domains/{domain}/phonenumbers. ", "operationId": "GetPhonenumbers", "tags": [ "Phone Numbers" ], "parameters": [ { "name": "start", "in": "query", "description": "Offset of the first record to return, starting at 0. Increase by `limit` for each page.", "required": false, "example": 0, "schema": { "$ref": "#/components/schemas/Start", "type": "integer", "minimum": 0 } }, { "name": "limit", "in": "query", "description": "Records per page. Defaults to 100, maximum 100. Higher values, or more than one `limit` parameter, are rejected with 400. Page through results with `start`.", "required": false, "schema": { "$ref": "#/components/schemas/Limit", "type": "integer", "minimum": 1, "maximum": 100, "default": 100 }, "example": 100 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Phonenumber" } } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/phonenumbers/count": { "get": { "summary": "Count All Phone Numbers for System or Reseller", "deprecated": false, "description": "This path will give you all Phonenumbers (DIDs) that are accessable based on the access rights of the Access Token or API Key used to make the requests. Super User or Reseller both supported, but for per domain lookups you should use /domains/{domain}/phonenumbers. ", "operationId": "CountPhonenumbers", "tags": [ "Phone Numbers" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Count" } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/phonenumbers/{phonenumber}": { "delete": { "summary": "Remove Phone Number from Domain", "deprecated": false, "description": "This will allow adding a phone number. ", "operationId": "DeletePhonenumber", "tags": [ "Phone Numbers" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "phonenumber", "in": "path", "description": "", "required": true, "example": "{{demo_phonenumber}}", "schema": { "type": "string" } } ], "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} }, "409": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 409, "message": "Phone number already exists" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "put": { "summary": "Update Phone Number in Domain", "deprecated": false, "description": "This API will allow updating of an existing number in a domain. ", "operationId": "UpdatePhonenumber", "tags": [ "Phone Numbers" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "phonenumber", "in": "path", "description": "", "required": true, "example": "{{demo_phonenumber}}", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "enabled": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "dial-rule-application": { "$ref": "#/components/schemas/DialruleApplication" }, "dial-rule-parameter": { "type": "string", "description": "This is the application parameter field that can be used for additional settings based on the dial-rule-application. Default is empty string. " }, "dial-rule-translation-destination-user": { "type": "string", "description": "This is the forward destination the call will be sent to in partnership with the application (dial-rule-application) and host (dial-rule-translation-destination-host). This might be a user, queue or offnet number depending on the application. ", "examples": [ "1000", "2500", "18005551234" ] }, "dial-rule-translation-destination-host": { "type": "string", "description": "This is the forward destination host the call will be sent to in partnership with the application (dial-rule-application) and user (dial-rule-translation-destination-user). This might be the domain name or a connection name if trying to route offnet. ", "default": "[*]", "examples": [ "example.com", "" ] }, "dial-rule-translation-source-name": { "type": "string", "description": "This field will allow customization of the source \"name\" often used for the caller id name or the the descriptive quoted value outside of the sip uri. Defaults to [*] but you can add a prefix for example with something like this, sales_[*]", "default": "[*]", "examples": [ "sales_[*]", "[*]", "" ] }, "dial-rule-description": { "type": "string", "description": "This is a description of the number/rule that can be used for defintion or tracking purposes. " } }, "required": [ "dial-rule-translation-destination-user" ] }, "example": { "phonenumber": "{{demo_phonenumber}}", "responder": "sip:start@call-queuing", "to_user": "3000", "to_host": "{{domain}}", "plan_description": "For Marketing to Queue" } } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} }, "409": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 409, "message": "Phone number already exists" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "get": { "summary": "Get Specific Phone Number in Domain", "deprecated": false, "description": "", "operationId": "GetPhonenumber", "tags": [ "Phone Numbers" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "phonenumber", "in": "path", "description": "", "required": true, "example": "{{demo_phonenumber}}", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Phonenumber" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users": { "get": { "summary": "Get Users in Domain", "deprecated": false, "description": "", "operationId": "GetUsers", "tags": [ "Users" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "example.com", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "limit", "in": "query", "description": "Records per page. Defaults to 100, maximum 100. Higher values, or more than one `limit` parameter, are rejected with 400. Page through results with `start`.", "required": false, "schema": { "$ref": "#/components/schemas/Limit", "type": "integer", "minimum": 1, "maximum": 100, "default": 100 }, "example": 100 }, { "name": "start", "in": "query", "description": "Offset of the first record to return, starting at 0. Increase by `limit` for each page.", "required": false, "example": 0, "schema": { "$ref": "#/components/schemas/Start", "type": "integer", "minimum": 0 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/User" } } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "post": { "summary": "Create User in Domain", "deprecated": false, "description": "", "operationId": "CreateUser", "tags": [ "Users" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "", "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "synchronous": { "$ref": "#/components/schemas/Synchronous" }, "user": { "$ref": "#/components/schemas/UserName" }, "name-first-name": { "type": "string", "description": "This is the first name for the user" }, "name-last-name": { "type": "string", "description": "This is the last name for the user" }, "login-username": { "type": "string", "description": "This is the login for the user used to access the portals and other applications. The default will be [user]@[domain] if not set otherwise. This value is required to be unique across the entire system so 409 will be returned if not unique." }, "email": { "type": "string", "description": "This is the email adresses or list of email addresses sepertaed with a semi-colon. ", "format": "email" }, "user-scope": { "$ref": "#/components/schemas/Scopes" }, "department": { "type": "string", "description": "This is the depertment that user belongs to in the domain. Can be any string to group users, a department is not require to be setup before in order to set it for a user. " }, "site": { "type": "string", "description": "This is the site or location for this user. The site will group users that are at the same phyiscal location, but can be used for other grouping purposes as well. New users will inherit some settings from the site if the site was previously setup. If the site is not previously created then a new site will be created with the value given on new user create assuming the domain's max sites setting has remaining sites. " }, "time-zone": { "$ref": "#/components/schemas/TimeZone" }, "voicemail-login-pin": { "type": "string", "description": "This is the numberic pin that would be used by the user validating their account when connecting into voice IVR to check voicemail. " }, "privacy": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "dial-plan": { "type": "string", "description": "This is the dial plan set for the user. Dial plans are used to control action and forward options that will be used when dialing out from the user. " }, "dial-policy": { "type": "string", "description": "This value is the dial policy/permission for this user whch will control the destinations this user can dial. Generally dial policys are preconfigured at system level and selected at user level. " }, "status-message": { "type": "string", "description": "This is is a value that is often set by the end user to show their current status, often a away message of some kind. ", "examples": [ "Im at lunch", "PTO till 3/15" ] }, "user-presence-status": { "type": "string", "readOnly": true, "description": "This is a read only presence status for the user that will be calculated by the core system based on registration, answer rules and active call status. " }, "directory-name-number-dtmf-mapping": { "type": "integer", "description": "This is a 3 digit numberic mapping that correlates to the first 3 digits of a user's first or last name for dial by name directory. Example Smith would be \"764\" translating the letters to numbers using the normal phone number mappings. ", "minimum": 100, "maximum": 999 }, "voicemail-user-control-enabled": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "phone-numbers-to-allow-enabled": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "phone-numbers-to-reject-enabled": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "call-screening-enabled": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "ring-no-answer-timeout-seconds": { "type": "integer", "description": "This time setting in seconds will controll how long a inbound call attempt will attempt to connect the call before stopping and attempting the next option which might be a forward setting in answer rules or voicemail if enabled. ", "minimum": 0, "maximum": 3600 }, "language-token": { "type": "string", "description": "This is the language that is set for the user to be used for portal viewing. ", "default": "en_US", "examples": [ "ca_FR", "es_MX", "en_UK" ] }, "limits-max-data-storage-kilobytes": { "type": "integer", "description": "This is the maximum value in kilobytes that is allowed to be stored in the user's voicemail, audio greetings and fax storage. ", "minimum": 0 }, "limits-max-active-calls-total": { "type": "integer", "description": "This is the maximum number of active calls allowed for the user. ", "minimum": 0, "maximum": 3600 }, "directory-announce-in-dial-by-name-enabled": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "directory-override-order-duplicate-dtmf-mapping": { "type": "integer", "description": "This value can be used in cases where multiple users have the same value for directory-name-number-dtmf-mapping, if they are the same then use this setting to set the order low to high for playback in dial by name directory menu. ", "minimum": 0, "maximum": 100 }, "voicemail-greeting-index": { "type": "integer", "description": "This is the index of the greeting that is enabled currently for the user. Greeting 0 is the generic \"[name] is not available\" message will be played. ", "minimum": 0 }, "voicemail-enabled": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "voicemail-receive-broadcast-enabled": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "reject-anonymous-calls-enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "voicemail-playback-announce-datetime-received": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "voicemail-playback-announce-caller-id": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "voicemail-playback-sort-newest-to-oldest": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "email-send-alert-new-voicemail-cc-list-csv": { "type": "string", "description": "This list of user's which will be forward copies of new voicemails left on that user. ", "examples": [ "1001,1002,3000" ] }, "email-send-alert-new-voicemail-behavior": { "type": "string", "description": "This is the behavior that the voicemail logic will take after a voicmail is left. The options include ability to send with attachements or hyperlinks.", "enum": [ "no", "yes", "attnew", "attsave", "atttrash", "brief", "briefattnew", "briefattsave", "briefatttrash" ], "default": "no" }, "email-send-alert-new-voicemail-enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "email-send-alert-new-missed-call-enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "email-send-alert-data-storage-limit-reached-enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "caller-id-number": { "type": "string", "description": "This is the main caller id number for the user to be used for outbound calls outside of the domain. ", "examples": [ "18585551234", "\"[*]\"" ], "format": "phonenumber" }, "caller-id-name": { "type": "string", "description": "This is the main caller id name for the user to be used for outbound calls outside of the domain. " }, "caller-id-number-emergency": { "anyOf": [ { "type": "integer", "title": "", "description": "" }, { "type": "string", "title": "", "description": "" } ], "description": "This is the main caller id that will be used for emergency calls when placed by the user." }, "area-code": { "type": "integer", "description": "This is a area code for the user. I will be used when user dial's 7 digits to translate it to full 10 or 11 digit number. ", "minimum": 100, "maximum": 999 }, "directory-name-visible-in-list-enabled": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "service-code": { "type": "string", "description": "Service codes are for internal use that allow user's to be tagged for billing and tracking purposes. Any service code starting with \"system-\" will be hidden by default in the portals and not count as regular users. " }, "voicemail-transcription-enabled": { "type": "string", "description": "Enable this setting and select a vendor if you wish to have voicemails transcripted after a voicemail is recorded. ", "enum": [ "no", "Deepgram", "Google", "Mutare", "Voicebase" ], "default": "no" }, "emergency-address-id": { "type": "string", "description": "Value will need to be an exact match to an address-id which links to a address for DLR (dynamic location routing) for emergency calling" }, "call-recordings-hide-from-others-enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "music-on-hold-randomized-enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "music-on-hold-comfort-message-repeat-interval-seconds": { "type": "integer", "minimum": 0, "maximum": 3600, "description": "This interval will control how frequently the music on hold would be interupted and have messages played. Should be used when using music on hod and custom messages. " }, "active-calls-total-current": { "type": "integer", "readOnly": true, "description": "This read only setting is the current active call count for this user. " }, "account-status": { "type": "string", "readOnly": true, "enum": [ "standard", "reset", "new", "pwd reset" ], "description": "This status is read only and is calcuated to suggest special states that can be relayed to the end user or manager views. Status's include when a user is new, the user has been reset or pasword needs to be set. " }, "created-datetime": { "type": "string", "readOnly": true, "format": "date-time", "description": "This datetime is when the user was created. " }, "last-modified-datetime": { "type": "string", "format": "date-time", "readOnly": true, "description": "This datetime is when the user was last modified. " }, "recording-configuration": { "$ref": "#/components/schemas/RecordingConfiguration" } }, "required": [ "user", "name-first-name", "name-last-name", "email", "user-scope" ] }, "example": { "synchronous": "no", "user": "{{user}}a", "name-first-name": "John", "name-last-name": "Doe", "email-address": "john.doe@example.com", "user-scope": "Basic User", "time-zone": "Pacific/Tahiti", "language-token": "en_US", "caller-id-number": 45376199, "area-code": 612, "dial-policy": "US & Canada", "site": "New York" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" }, "example": { "domain": "apidog.ApiReseller", "user": "10001", "first_name": "Catherine", "last_name": "Greenholt", "subscriber_login": "10001@apidog.ApiReseller", "email": "", "site": "New Braunfels", "group": "", "dir": 473, "message": "", "vmail_provisioned": "yes", "accept": "yes", "reject": "yes", "screen": "yes", "no_answer_timeout": 25, "subscriber_pin": 44822305, "language": "en_US", "data_limit": 50000, "call_limit": 15, "time_zone": "US/Pacific", "dir_anc": "yes", "directory_order": 1, "vmail_greeting": "", "vmail_enabled": "yes", "rcv_broadcast": "yes", "rej_anony": "no", "vmail_annc_time": "yes", "vmail_annc_cid": "yes", "vmail_sort_lifo": "no", "vmail_fwd_to": "", "vmail_notify": "", "vmail_notify_enabled": "", "ntfy_missed_call": "no", "ntfy_data_limit": "no", "dial_plan": "Default", "dial_policy": "US and Canada", "callid_nmbr": 689346037, "callid_name": "Dicki - Reilly", "callid_emgr": 8286318610, "area_code": 457, "privacy": "no", "presence": "inactive", "dir_list": "yes", "date_created": "2023-07-28 19:56:11", "srv_code": "", "scope": "Basic User", "last_update": "2023-07-28 19:56:12", "gauSession": 0, "vmail_transcribe": "no", "address_id": "", "hide_call_recordings": "no", "rmoh": "yes", "moh_interval": 0 } } }, "headers": {} }, "202": { "description": "", "content": { "*/*": { "schema": { "type": "object", "properties": {} }, "example": "{\n \"code\": 202,\n \"message\": \"Accepted\"\n}" } }, "headers": {} }, "409": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 409, "message": "UID already exists." } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/count": { "get": { "summary": "Count users in Domain", "deprecated": false, "description": "", "operationId": "CountUsers", "tags": [ "Users" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Count" }, "example": { "total": 25 } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 403, "message": "Domain not found or access denied" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}": { "delete": { "summary": "Delete User in Domain", "deprecated": false, "description": "", "operationId": "DeleteUser", "tags": [ "Users" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "example.com", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "1000", "schema": { "$ref": "#/components/schemas/UserNamePath" } } ], "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "put": { "summary": "Update a User in Domain", "deprecated": false, "description": "", "operationId": "UpdateUser", "tags": [ "Users" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "example.com", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "1000", "schema": { "$ref": "#/components/schemas/UserNamePath" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name-first-name": { "type": "string", "description": "This is the first name for the user" }, "name-last-name": { "type": "string", "description": "This is the last name for the user" }, "login-username": { "type": "string", "description": "This is the login for the user used to access the portals and other applications. The default will be [user]@[domain] if not set otherwise. This value is required to be unique across the entire system so 409 will be returned if not unique." }, "email": { "type": "string", "description": "This is the email adresses or list of email addresses sepertaed with a semi-colon. ", "format": "email" }, "user-scope": { "$ref": "#/components/schemas/Scopes" }, "department": { "type": "string", "description": "This is the depertment that user belongs to in the domain. Can be any string to group users, a department is not require to be setup before in order to set it for a user. " }, "site": { "type": "string", "description": "This is the site or location for this user. The site will group users that are at the same phyiscal location, but can be used for other grouping purposes as well. New users will inherit some settings from the site if the site was previously setup. If the site is not previously created then a new site will be created with the value given on new user create assuming the domain's max sites setting has remaining sites. " }, "time-zone": { "$ref": "#/components/schemas/TimeZone" }, "voicemail-login-pin": { "type": "string", "description": "This is the numberic pin that would be used by the user validating their account when connecting into voice IVR to check voicemail. " }, "privacy": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "dial-plan": { "type": "string", "description": "This is the dial plan set for the user. Dial plans are used to control action and forward options that will be used when dialing out from the user. " }, "dial-policy": { "type": "string", "description": "This value is the dial policy/permission for this user whch will control the destinations this user can dial. Generally dial policys are preconfigured at system level and selected at user level. " }, "status-message": { "type": "string", "description": "This is is a value that is often set by the end user to show their current status, often a away message of some kind. ", "examples": [ "Im at lunch", "PTO till 3/15" ] }, "user-presence-status": { "type": "string", "readOnly": true, "description": "This is a read only presence status for the user that will be calculated by the core system based on registration, answer rules and active call status. " }, "directory-name-number-dtmf-mapping": { "type": "integer", "description": "This is a 3 digit numberic mapping that correlates to the first 3 digits of a user's first or last name for dial by name directory. Example Smith would be \"764\" translating the letters to numbers using the normal phone number mappings. ", "minimum": 100, "maximum": 999 }, "voicemail-user-control-enabled": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "phone-numbers-to-allow-enabled": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "phone-numbers-to-reject-enabled": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "call-screening-enabled": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "ring-no-answer-timeout-seconds": { "type": "integer", "description": "This time setting in seconds will controll how long a inbound call attempt will attempt to connect the call before stopping and attempting the next option which might be a forward setting in answer rules or voicemail if enabled. ", "minimum": 0, "maximum": 3600 }, "language-token": { "type": "string", "description": "This is the language that is set for the user to be used for portal viewing. ", "default": "en_US", "examples": [ "ca_FR", "es_MX", "en_UK" ] }, "limits-max-data-storage-kilobytes": { "type": "integer", "description": "This is the maximum value in kilobytes that is allowed to be stored in the user's voicemail, audio greetings and fax storage. ", "minimum": 0 }, "limits-max-active-calls-total": { "type": "integer", "description": "This is the maximum number of active calls allowed for the user. ", "minimum": 0, "maximum": 3600 }, "directory-announce-in-dial-by-name-enabled": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "directory-override-order-duplicate-dtmf-mapping": { "type": "integer", "description": "This value can be used in cases where multiple users have the same value for directory-name-number-dtmf-mapping, if they are the same then use this setting to set the order low to high for playback in dial by name directory menu. ", "minimum": 0, "maximum": 100 }, "voicemail-greeting-index": { "type": "integer", "description": "This is the index of the greeting that is enabled currently for the user. Greeting 0 is the generic \"[name] is not available\" message will be played. ", "minimum": 0 }, "voicemail-enabled": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "voicemail-receive-broadcast-enabled": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "reject-anonymous-calls-enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "voicemail-playback-announce-datetime-received": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "voicemail-playback-announce-caller-id": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "voicemail-playback-sort-newest-to-oldest": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "email-send-alert-new-voicemail-cc-list-csv": { "type": "string", "description": "This list of user's which will be forward copies of new voicemails left on that user. ", "examples": [ "1001,1002,3000" ] }, "email-send-alert-new-voicemail-behavior": { "type": "string", "description": "This is the behavior that the voicemail logic will take after a voicmail is left. The options include ability to send with attachements or hyperlinks.", "enum": [ "no", "yes", "attnew", "attsave", "atttrash", "brief", "briefattnew", "briefattsave", "briefatttrash" ], "default": "no" }, "email-send-alert-new-voicemail-enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "email-send-alert-new-missed-call-enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "email-send-alert-data-storage-limit-reached-enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "caller-id-number": { "type": "string", "description": "This is the main caller id number for the user to be used for outbound calls outside of the domain. ", "examples": [ "18585551234", "\"[*]\"" ], "format": "phonenumber" }, "caller-id-name": { "type": "string", "description": "This is the main caller id name for the user to be used for outbound calls outside of the domain. " }, "caller-id-number-emergency": { "anyOf": [ { "type": "integer", "title": "", "description": "" }, { "type": "string", "title": "", "description": "" } ], "description": "This is the main caller id that will be used for emergency calls when placed by the user." }, "area-code": { "type": "integer", "description": "This is a area code for the user. I will be used when user dial's 7 digits to translate it to full 10 or 11 digit number. ", "minimum": 100, "maximum": 999 }, "directory-name-visible-in-list-enabled": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "service-code": { "type": "string", "description": "Service codes are for internal use that allow user's to be tagged for billing and tracking purposes. Any service code starting with \"system-\" will be hidden by default in the portals and not count as regular users. " }, "voicemail-transcription-enabled": { "type": "string", "description": "Enable this setting and select a vendor if you wish to have voicemails transcripted after a voicemail is recorded. ", "enum": [ "no", "Deepgram", "Google", "Mutare", "Voicebase" ], "default": "no" }, "emergency-address-id": { "type": "string", "description": "Value will need to be an exact match to an address-id which links to a address for DLR (dynamic location routing) for emergency calling" }, "call-recordings-hide-from-others-enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "music-on-hold-randomized-enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "music-on-hold-comfort-message-repeat-interval-seconds": { "type": "integer", "minimum": 0, "maximum": 3600, "description": "This interval will control how frequently the music on hold would be interupted and have messages played. Should be used when using music on hod and custom messages. " }, "active-calls-total-current": { "type": "integer", "readOnly": true, "description": "This read only setting is the current active call count for this user. " }, "account-status": { "type": "string", "readOnly": true, "enum": [ "standard", "reset", "new", "pwd reset" ], "description": "This status is read only and is calcuated to suggest special states that can be relayed to the end user or manager views. Status's include when a user is new, the user has been reset or pasword needs to be set. " }, "created-datetime": { "type": "string", "readOnly": true, "format": "date-time", "description": "This datetime is when the user was created. " }, "last-modified-datetime": { "type": "string", "format": "date-time", "readOnly": true, "description": "This datetime is when the user was last modified. " }, "recording-configuration": { "$ref": "#/components/schemas/RecordingConfiguration" } }, "required": [ "name-first-name", "name-last-name", "email", "user-scope" ] } } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "get": { "summary": "Get Specific User in Domain", "deprecated": false, "description": "", "operationId": "GetUser", "tags": [ "Users" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "example.com", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "5226", "schema": { "$ref": "#/components/schemas/UserNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/~/users/~": { "get": { "summary": "Get My User ", "deprecated": false, "description": "", "operationId": "GetMyUser", "tags": [ "Users" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/list": { "get": { "summary": "List Basic Info on Users in Domain", "deprecated": false, "description": "", "operationId": "ListUsers", "tags": [ "Users", "ReadOnlyDomain" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "fields", "in": "query", "description": "Comma delimited string of specific return fields to list.", "required": false, "example": "user,domain,site,first_name,last_name,group,dir", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PublicUserInfo" } }, "example": [ { "user": "1001", "domain": "example", "site": "", "name-first-name": "example SU", "name-last-name": "test", "department": "", "directory-name-number-dtmf-mapping": 837 }, { "user": "1002", "domain": "example", "site": "", "name-first-name": "example", "name-last-name": "test", "department": "", "directory-name-number-dtmf-mapping": 837 }, { "user": "1003", "domain": "example", "site": "", "name-first-name": "example another", "name-last-name": "test", "department": "", "directory-name-number-dtmf-mapping": 837 }, { "user": "2002", "domain": "example", "site": "", "name-first-name": "test", "name-last-name": "user", "department": "department example 2", "directory-name-number-dtmf-mapping": 873 }, { "user": "5555", "domain": "example", "site": "", "name-first-name": "s", "name-last-name": "s", "department": "", "directory-name-number-dtmf-mapping": 7 }, { "user": "9999", "domain": "example", "site": "", "name-first-name": "example", "name-last-name": "user", "department": "", "directory-name-number-dtmf-mapping": 873 } ] } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 403, "message": "Domain not found or access denied" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 404, "message": "Domain domain does not exist" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/devices": { "get": { "summary": "Get Devices for User", "deprecated": false, "description": "", "operationId": "GetDevices", "tags": [ "Devices" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Device" } } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "post": { "summary": "Create Device for User", "deprecated": false, "description": "", "operationId": "CreateDevice", "tags": [ "Devices" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "synchronous": { "$ref": "#/components/schemas/Synchronous" }, "device": { "type": "string", "description": "This is the \"device\" id which will be the first part of the device-sip-registration-uri which can be used to read specific device information. " }, "device-sip-registration-uri": { "type": "string", "readOnly": true, "description": "This read-only value is the full SIP uri and will often be sip:[device]@[domain]" }, "device-sip-registration-state": { "type": "string", "readOnly": true, "enum": [ "registered", "unregistered" ], "description": "This is the current registration status for the device. This value will be registered if its in the value time windoe " }, "device-sip-registration-password": { "type": "string", "format": "password", "description": "This is the password which would be used for device registration. If left unset on device create it will create a new random password with a default length of 16 characters. " }, "caller-id-number-emergency": { "type": "string", "description": "This is a override value for emergency caller id value that would be specific to this device and would override the user's set value. ", "default": "[*]" }, "device-force-notify-new-voicemails-enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "device-level-call-recording-enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "device-push-enabled": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "device-sip-registration-contact": { "type": "string", "readOnly": true, "description": "This is the contact value for the device from the last successfull registration. " }, "device-sip-registration-core-server": { "type": "string", "format": "hostname", "readOnly": true, "description": "This is the hostname for which the last registration was completed. This would be used to connect the device from on inbound call. " }, "device-sip-registration-datetime": { "type": [ "string", "null" ], "readOnly": true, "format": "date-time", "description": "This date-time will be the last registration time of the device. This time may be slightly delayed to improve replication throughput. " }, "device-sip-registration-expires-datetime": { "type": [ "string", "null" ], "readOnly": true, "format": "date-time", "description": "This date-time will be the time at which the device will be treated as unregisted and should be in the future for active registed devices." }, "device-sip-registration-expiry-seconds": { "type": "integer", "description": "This is the requested re-register perior for the device. The device will be treated as unregistered if they do not register in this window + a system wide grace period. ", "default": 60 }, "device-sip-registration-ignore-for-presence-calculation": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "device-sip-registration-ignore-report-enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "device-sip-registration-ip-address": { "type": "string", "readOnly": true, "format": "i", "description": "This is the read-only value is the IP:port for the last successfull registration. " }, "device-sip-registration-user-agent": { "type": "string", "readOnly": true, "examples": [ "Yealink T48 2.3.232", "SnapMobile Web 44.0.2" ], "description": "This is the read-only value for the user-agent used during the last successfully registration. " }, "device-sip-no-to-tag-in-cancel": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "device-srtp-enabled": { "type": "string", "enum": [ "yes", "no", "opportunistic" ], "default": "no", "description": "This setting will enable SRTP (secure/encrypted audio) on the the device. Yes will force and \"opp" }, "auto-answer-enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "device-sip-allowed-user-agent": { "type": "string", "description": "This value can be used to restrict registration to a specific User Agent or partial match of User Agent. This allows for an extra layer of secutiry if you know the expected user agent. " }, "device-sip-nat-traversal-enabled": { "type": "string", "description": "This is the main nat transveral setting. In most all device cases \"automatic\" is the correct answe", "enum": [ "automatic", "none", "never", "fixed" ], "default": "automatic" }, "device-sip-latency-seconds-current": { "type": "number", "readOnly": true, "description": "This is the latency from the latest registration measured in seconds from the time the core sent a 407 challenge to the 200ok with Auth. " }, "device-sip-latency-seconds-average": { "type": "number", "readOnly": true, "description": "This is the average of the last 5 registration attempts measured similiarly to device-sip-latency-seconds-current. " }, "emergency-address-id": { "type": [ "string", "null" ], "description": "This value if set will be the address-id specific to this device for emegeny calling" }, "error-reading-from-endpoint-module": { "type": "string", "readOnly": true, "description": "If yes, it means the API had an issue accessing the NDP for mac specific data" }, "login-username": { "type": "string", "readOnly": true, "description": "This is a read-only value of the user's login for the owner of the device. " }, "name-full-name": { "type": "string", "readOnly": true, "description": "This is a read-only value of the user's full name for the owner of the device. " }, "device-models-model": { "type": "string", "description": "This is an optional model that when provided with device-provisioning-mac-address will link this device to the mac address in the device provisioning platform. " }, "device-provisioning-mac-address": { "type": "string", "description": "This is the mac address that has this device linked to it. This field can be used to link a mac address on device create. Must also provide a device-models-model" }, "device-provisioning-registration-core-server": { "type": "string", "description": "This is the SiPbx Servers primary server config from a list of valid " }, "device-provisioning-sip-transport-protocol": { "type": "string", "enum": [ "udp", "tcp", "tls" ], "default": "udp", "description": "This is the transport that will be requested when provising the device. " }, "device-provisioning-username": { "type": [ "string", "null" ], "description": "The provisioning username for the request to authenticate the configuration request. " }, "device-provisioning-password": { "type": [ "string", "null" ], "description": "The provisioning password for the request to authenticate the configuration request. " }, "device-provisioning-line": { "type": "integer", "description": "Optional setting to select which line is used on the device when provisionined with device-models-model and device-provisioning-mac-address" }, "device-provisioning-overrides": { "type": "string", "description": "This is the overrides set for the mac address in the provisioning server on the mac linked to this device." }, "recording-configuration": { "$ref": "#/components/schemas/RecordingConfiguration" } }, "required": [ "device" ] }, "example": { "device": "{{user}}x", "device-srtp-enabled": "yes", "device-sip-registration-ignore-for-presence-calculation": "no", "device-push-enabled": "yes", "device-level-call-recording-enabled": "yes", "device-sip-auto-answer-enabled": "no", "mac": "5588665412", "model": "Polcom VVX500" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Device" } } }, "headers": {} }, "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/devices/count": { "get": { "summary": "Count Devices for Domain", "deprecated": false, "description": "", "tags": [ "Devices" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "limit", "in": "query", "description": "Records per page. Defaults to 100, maximum 100. Higher values, or more than one `limit` parameter, are rejected with 400. Page through results with `start`.", "required": false, "schema": { "$ref": "#/components/schemas/Limit", "type": "integer", "minimum": 1, "maximum": 100, "default": 100 }, "example": 100 }, { "name": "start", "in": "query", "description": "Offset of the first record to return, starting at 0. Increase by `limit` for each page.", "required": false, "schema": { "$ref": "#/components/schemas/Start", "type": "integer", "minimum": 0 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Count" }, "example": { "total": 22 } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 403, "message": "Domain not found or access denied" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 404, "message": "Domain domain does not exist" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/devices/count": { "get": { "summary": "Count Devices for User", "deprecated": false, "description": "", "operationId": "CountDevices", "tags": [ "Devices" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "limit", "in": "query", "description": "Records per page. Defaults to 100, maximum 100. Higher values, or more than one `limit` parameter, are rejected with 400. Page through results with `start`.", "required": false, "schema": { "$ref": "#/components/schemas/Limit", "type": "integer", "minimum": 1, "maximum": 100, "default": 100 }, "example": 100 }, { "name": "start", "in": "query", "description": "Offset of the first record to return, starting at 0. Increase by `limit` for each page.", "required": false, "schema": { "$ref": "#/components/schemas/Start", "type": "integer", "minimum": 0 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Count" }, "example": { "total": 2 } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 403, "message": "Domain not found or access denied" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "2": { "summary": "Domain Not Found", "description": "", "value": { "code": 404, "message": "Domain domain does not exist" } }, "3": { "summary": "User Not Found", "description": "", "value": { "code": 404, "message": "User 1000 does not exist in domain domain" } } } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/devices/{device}/count": { "get": { "summary": "Count Devices by Device", "deprecated": false, "description": "", "tags": [ "Devices" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "device", "in": "path", "description": "", "required": true, "example": "{{device}}", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Records per page. Defaults to 100, maximum 100. Higher values, or more than one `limit` parameter, are rejected with 400. Page through results with `start`.", "required": false, "schema": { "$ref": "#/components/schemas/Limit", "type": "integer", "minimum": 1, "maximum": 100, "default": 100 }, "example": 100 }, { "name": "start", "in": "query", "description": "Offset of the first record to return, starting at 0. Increase by `limit` for each page.", "required": false, "schema": { "$ref": "#/components/schemas/Start", "type": "integer", "minimum": 0 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Count" }, "example": { "total": 1 } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 404, "message": "Domain domain does not exist" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/devices/{device}": { "put": { "summary": "Update Device for User", "deprecated": false, "description": "", "operationId": "UpdateDevice", "tags": [ "Devices" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "device", "in": "path", "description": "", "required": true, "example": "{{user}}a", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "device-sip-registration-uri": { "type": "string", "readOnly": true, "description": "This read-only value is the full SIP uri and will often be sip:[device]@[domain]" }, "device-sip-registration-state": { "type": "string", "readOnly": true, "enum": [ "registered", "unregistered" ], "description": "This is the current registration status for the device. This value will be registered if its in the value time windoe " }, "device-sip-registration-password": { "type": "string", "format": "password", "description": "This is the password which would be used for device registration. If left unset on device create it will create a new random password with a default length of 16 characters. " }, "caller-id-number-emergency": { "type": "string", "description": "This is a override value for emergency caller id value that would be specific to this device and would override the user's set value. ", "default": "[*]" }, "device-force-notify-new-voicemails-enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "device-level-call-recording-enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "device-push-enabled": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "device-sip-registration-contact": { "type": "string", "readOnly": true, "description": "This is the contact value for the device from the last successfull registration. " }, "device-sip-registration-core-server": { "type": "string", "format": "hostname", "readOnly": true, "description": "This is the hostname for which the last registration was completed. This would be used to connect the device from on inbound call. " }, "device-sip-registration-datetime": { "type": [ "string", "null" ], "readOnly": true, "format": "date-time", "description": "This date-time will be the last registration time of the device. This time may be slightly delayed to improve replication throughput. " }, "device-sip-registration-expires-datetime": { "type": [ "string", "null" ], "readOnly": true, "format": "date-time", "description": "This date-time will be the time at which the device will be treated as unregisted and should be in the future for active registed devices." }, "device-sip-registration-expiry-seconds": { "type": "integer", "description": "This is the requested re-register perior for the device. The device will be treated as unregistered if they do not register in this window + a system wide grace period. ", "default": 60 }, "device-sip-registration-ignore-for-presence-calculation": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "device-sip-registration-ignore-report-enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "device-sip-registration-ip-address": { "type": "string", "readOnly": true, "format": "i", "description": "This is the read-only value is the IP:port for the last successfull registration. " }, "device-sip-registration-user-agent": { "type": "string", "readOnly": true, "examples": [ "Yealink T48 2.3.232", "SnapMobile Web 44.0.2" ], "description": "This is the read-only value for the user-agent used during the last successfully registration. " }, "device-sip-no-to-tag-in-cancel": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "device-srtp-enabled": { "type": "string", "enum": [ "yes", "no", "opportunistic" ], "default": "no", "description": "This setting will enable SRTP (secure/encrypted audio) on the the device. Yes will force and \"opp" }, "auto-answer-enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "device-sip-allowed-user-agent": { "type": "string", "description": "This value can be used to restrict registration to a specific User Agent or partial match of User Agent. This allows for an extra layer of secutiry if you know the expected user agent. " }, "device-sip-nat-traversal-enabled": { "type": "string", "description": "This is the main nat transveral setting. In most all device cases \"automatic\" is the correct answe", "enum": [ "automatic", "none", "never", "fixed" ], "default": "automatic" }, "device-sip-latency-seconds-current": { "type": "number", "readOnly": true, "description": "This is the latency from the latest registration measured in seconds from the time the core sent a 407 challenge to the 200ok with Auth. " }, "device-sip-latency-seconds-average": { "type": "number", "readOnly": true, "description": "This is the average of the last 5 registration attempts measured similiarly to device-sip-latency-seconds-current. " }, "emergency-address-id": { "type": [ "string", "null" ], "description": "This value if set will be the address-id specific to this device for emegeny calling" }, "error-reading-from-endpoint-module": { "type": "string", "readOnly": true, "description": "If yes, it means the API had an issue accessing the NDP for mac specific data" }, "login-username": { "type": "string", "readOnly": true, "description": "This is a read-only value of the user's login for the owner of the device. " }, "name-full-name": { "type": "string", "readOnly": true, "description": "This is a read-only value of the user's full name for the owner of the device. " }, "device-models-model": { "type": "string", "description": "This is an optional model that when provided with device-provisioning-mac-address will link this device to the mac address in the device provisioning platform. " }, "device-provisioning-mac-address": { "type": "string", "description": "This is the mac address that has this device linked to it. This field can be used to link a mac address on device create. Must also provide a device-models-model" }, "device-provisioning-registration-core-server": { "type": "string", "description": "This is the SiPbx Servers primary server config from a list of valid " }, "device-provisioning-sip-transport-protocol": { "type": "string", "enum": [ "udp", "tcp", "tls" ], "default": "udp", "description": "This is the transport that will be requested when provising the device. " }, "device-provisioning-username": { "type": [ "string", "null" ], "description": "The provisioning username for the request to authenticate the configuration request. " }, "device-provisioning-password": { "type": [ "string", "null" ], "description": "The provisioning password for the request to authenticate the configuration request. " }, "device-provisioning-line": { "type": "integer", "description": "Optional setting to select which line is used on the device when provisionined with device-models-model and device-provisioning-mac-address" }, "device-provisioning-overrides": { "type": "string", "description": "This is the overrides set for the mac address in the provisioning server on the mac linked to this device." }, "recording-configuration": { "$ref": "#/components/schemas/RecordingConfiguration" } } }, "example": { "device-srtp-enabled": "no", "device-sip-registration-ignore-for-presence-calculation": "no", "device-sip-registration-expiry-seconds": 30, "auto_ans": "no" } } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "delete": { "summary": "Delete Device for User", "deprecated": false, "description": "", "operationId": "DeleteDevice", "tags": [ "Devices" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "device", "in": "path", "description": "", "required": true, "example": "{{user}}g", "schema": { "type": "string" } } ], "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "get": { "summary": "Get Specifc Device", "deprecated": false, "description": "", "operationId": "GetDevice", "tags": [ "Devices" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "device", "in": "path", "description": "", "required": true, "example": "{{user}}x", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Device" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/devices": { "get": { "summary": "Get Devices in Domain", "deprecated": false, "description": "", "operationId": "GetDomainDevices", "tags": [ "Devices" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Device" } } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/phones/models": { "get": { "summary": "Get list of Supported/Provisionable Models", "deprecated": false, "description": "", "operationId": "GetSupportedModels", "tags": [ "Phones/Macs/Supported Models and Servers" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NdpModel" } } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/phones/servers": { "get": { "summary": "Get list of Provisionable Server Profiles", "deprecated": false, "description": "", "operationId": "GetProvisionableServers", "tags": [ "Phones/Macs/Supported Models and Servers" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NdpServer" } } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/phones/servers/{server}": { "get": { "summary": "Read Provisionable Server Details", "deprecated": false, "description": "", "operationId": "GetProvisionableServer", "tags": [ "Phones/Macs/Supported Models and Servers" ], "parameters": [ { "name": "server", "in": "path", "description": "", "required": true, "example": "core1", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NdpServer" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/phones": { "get": { "summary": "Read Mac Addresses", "deprecated": false, "description": "", "tags": [ "Phones/Macs" ], "parameters": [ { "name": "limit", "in": "query", "description": "Records per page. Defaults to 100, maximum 100. Higher values, or more than one `limit` parameter, are rejected with 400. Page through results with `start`.", "required": false, "schema": { "$ref": "#/components/schemas/Limit", "type": "integer", "minimum": 1, "maximum": 100, "default": 100 }, "example": 100 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NdpPhone" } } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "post": { "summary": "Add MAC address", "deprecated": false, "description": "", "tags": [ "Phones/Macs" ], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NdpPhone" }, "example": null } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "put": { "summary": "Update MAC address", "deprecated": false, "description": "", "tags": [ "Phones/Macs" ], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NdpPhone" }, "example": { "mac": "{{mac}}", "server": "eng0-san", "domain": "{{domain}}", "notes": "my physical device (updated)", "transport": "tls" } } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "delete": { "summary": "Remove MAC address", "deprecated": false, "description": "", "tags": [ "Phones/Macs" ], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "device-provisioning-mac-address": { "type": "string", "maxLength": 12, "minLength": 12, "format": "mac", "examples": [ "000011223344" ] }, "reseller": { "type": "string" }, "device-models-brand-and-model": { "type": "string" }, "device-provisioning-registration-core-server": { "type": "string" }, "device-provisioning-sip-uri-1": { "type": "string" }, "device-provisioning-line-1-enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "device-provisioning-sip-uri-1-shared-line-enabled": { "type": "string" }, "device-provisioning-sip-uri-2": { "type": "string" }, "device-provisioning-line-2-enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "device-provisioning-sip-uri-2-shared-line-enabled": { "type": "string" }, "device-provisioning-sip-transport-protocol": { "type": "string" }, "device-provisioning-username": { "type": "string" }, "device-provisioning-password": { "type": "string", "format": "password" }, "device-models-count-buttons": { "type": "integer" }, "device-models-fxs-support-enabled": { "type": "integer" }, "device-models-overrides-blob": { "type": "string" }, "device-models-resync-support-enabled": { "type": "string" }, "device-models-shared-line-support-enabled": { "type": "string" }, "device-models-sidecar-support-enabled": { "type": "string" }, "device-provisioning-last-retrieved-datetime": { "type": "string" }, "device-provisioning-directory": { "type": "string" }, "device-provisioning-directory-support": { "type": "string" }, "device-provisioning-line-1-extensions": { "type": "string", "readOnly": true }, "device-provisioning-line-2-extensions": { "type": "string", "readOnly": true }, "device-provisioning-ndp-hostname": { "type": "string" }, "device-provisioning-presence": { "type": "string" }, "created-datetime": { "type": "string" }, "global-one-time-pass": { "type": "string" }, "last-modified-datetime": { "type": "string", "format": "date-time", "readOnly": true }, "redundency": { "type": "string" }, "device-provisioning-sip-uri-3": { "type": "string" }, "device-provisioning-line-3-enabled": { "type": "string" }, "device-provisioning-sip-uri-3-shared-line-enabled": { "type": "string" }, "device-provisioning-sip-uri-4": { "type": "string" }, "device-provisioning-line-4-enabled": { "type": "string" }, "device-provisioning-sip-uri-4-shared-line-enabled": { "type": "string" }, "device-provisioning-sip-uri-5": { "type": "string" }, "device-provisioning-line-5-enabled": { "type": "string" }, "device-provisioning-sip-uri-5-shared-line-enabled": { "type": "string" }, "device-provisioning-sip-uri-6": { "type": "string" }, "device-provisioning-line-6-enabled": { "type": "string" }, "device-provisioning-sip-uri-6-shared-line-enabled": { "type": "string" }, "device-provisioning-sip-uri-7": { "type": "string" }, "device-provisioning-line-7-enabled": { "type": "string" }, "device-provisioning-sip-uri-7-shared-line-enabled": { "type": "string" }, "device-provisioning-sip-uri-8": { "type": "string" }, "device-provisioning-line-8-enabled": { "type": "string" }, "device-provisioning-sip-uri-8-shared-line-enabled": { "type": "string" }, "device-sip-registration-contact": { "type": "string", "readOnly": true }, "device-sip-registration-datetime": { "type": "string", "readOnly": true }, "device-sip-registration-expires-datetime": { "type": "string", "readOnly": true }, "device-sip-registration-state": { "type": [ "string", "null" ], "readOnly": true }, "device-sip-registration-user-agent": { "type": "string", "readOnly": true } }, "required": [ "device-provisioning-mac-address", "reseller", "device-models-brand-and-model", "device-provisioning-registration-core-server", "device-provisioning-sip-uri-1", "device-provisioning-line-1-enabled", "device-provisioning-sip-uri-1-shared-line-enabled", "device-provisioning-sip-uri-2", "device-provisioning-line-2-enabled", "device-provisioning-sip-uri-2-shared-line-enabled", "device-provisioning-sip-transport-protocol", "device-provisioning-username", "device-provisioning-password", "device-models-count-buttons", "device-models-fxs-support-enabled", "device-models-overrides-blob", "device-models-resync-support-enabled", "device-models-shared-line-support-enabled", "device-models-sidecar-support-enabled", "device-provisioning-last-retrieved-datetime", "device-provisioning-directory", "device-provisioning-directory-support", "device-provisioning-ndp-hostname", "device-provisioning-presence", "created-datetime", "global-one-time-pass", "redundency" ] }, "example": { "mac": "{{mac}}" } } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/phones/count": { "get": { "summary": "Count Mac Addresses", "deprecated": false, "description": "", "tags": [ "Phones/Macs" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Count" }, "example": { "total": 6 } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 403, "message": "Domain not found or access denied" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/phones": { "get": { "summary": "Read Mac Addresses in Domain", "deprecated": false, "description": "", "tags": [ "Phones/Macs" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "limit", "in": "query", "description": "Records per page. Defaults to 100, maximum 100. Higher values, or more than one `limit` parameter, are rejected with 400. Page through results with `start`.", "required": false, "schema": { "$ref": "#/components/schemas/Limit", "type": "integer", "minimum": 1, "maximum": 100, "default": 100 }, "example": 100 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NdpPhone" } } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "post": { "summary": "Add MAC address for Domain", "deprecated": false, "description": "", "tags": [ "Phones/Macs" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NdpPhone" }, "example": null } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "put": { "summary": "Update MAC address in Domain", "deprecated": false, "description": "", "tags": [ "Phones/Macs" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NdpPhone" }, "example": { "mac": "{{mac}}", "server": "eng0-san", "domain": "{{domain}}", "notes": "my physical device (updated)", "transport": "tls" } } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "delete": { "summary": "Remove MAC address in Domain", "deprecated": false, "description": "", "tags": [ "Phones/Macs" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "device-provisioning-mac-address": { "type": "string", "maxLength": 12, "minLength": 12, "format": "mac", "examples": [ "000011223344" ] }, "reseller": { "type": "string" }, "device-models-brand-and-model": { "type": "string" }, "device-provisioning-registration-core-server": { "type": "string" }, "device-provisioning-sip-uri-1": { "type": "string" }, "device-provisioning-line-1-enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "device-provisioning-sip-uri-1-shared-line-enabled": { "type": "string" }, "device-provisioning-sip-uri-2": { "type": "string" }, "device-provisioning-line-2-enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "device-provisioning-sip-uri-2-shared-line-enabled": { "type": "string" }, "device-provisioning-sip-transport-protocol": { "type": "string" }, "device-provisioning-username": { "type": "string" }, "device-provisioning-password": { "type": "string", "format": "password" }, "device-models-count-buttons": { "type": "integer" }, "device-models-fxs-support-enabled": { "type": "integer" }, "device-models-overrides-blob": { "type": "string" }, "device-models-resync-support-enabled": { "type": "string" }, "device-models-shared-line-support-enabled": { "type": "string" }, "device-models-sidecar-support-enabled": { "type": "string" }, "device-provisioning-last-retrieved-datetime": { "type": "string" }, "device-provisioning-directory": { "type": "string" }, "device-provisioning-directory-support": { "type": "string" }, "device-provisioning-line-1-extensions": { "type": "string", "readOnly": true }, "device-provisioning-line-2-extensions": { "type": "string", "readOnly": true }, "device-provisioning-ndp-hostname": { "type": "string" }, "device-provisioning-presence": { "type": "string" }, "created-datetime": { "type": "string" }, "global-one-time-pass": { "type": "string" }, "last-modified-datetime": { "type": "string", "format": "date-time", "readOnly": true }, "redundency": { "type": "string" }, "device-provisioning-sip-uri-3": { "type": "string" }, "device-provisioning-line-3-enabled": { "type": "string" }, "device-provisioning-sip-uri-3-shared-line-enabled": { "type": "string" }, "device-provisioning-sip-uri-4": { "type": "string" }, "device-provisioning-line-4-enabled": { "type": "string" }, "device-provisioning-sip-uri-4-shared-line-enabled": { "type": "string" }, "device-provisioning-sip-uri-5": { "type": "string" }, "device-provisioning-line-5-enabled": { "type": "string" }, "device-provisioning-sip-uri-5-shared-line-enabled": { "type": "string" }, "device-provisioning-sip-uri-6": { "type": "string" }, "device-provisioning-line-6-enabled": { "type": "string" }, "device-provisioning-sip-uri-6-shared-line-enabled": { "type": "string" }, "device-provisioning-sip-uri-7": { "type": "string" }, "device-provisioning-line-7-enabled": { "type": "string" }, "device-provisioning-sip-uri-7-shared-line-enabled": { "type": "string" }, "device-provisioning-sip-uri-8": { "type": "string" }, "device-provisioning-line-8-enabled": { "type": "string" }, "device-provisioning-sip-uri-8-shared-line-enabled": { "type": "string" }, "device-sip-registration-contact": { "type": "string", "readOnly": true }, "device-sip-registration-datetime": { "type": "string", "readOnly": true }, "device-sip-registration-expires-datetime": { "type": "string", "readOnly": true }, "device-sip-registration-state": { "type": [ "string", "null" ], "readOnly": true }, "device-sip-registration-user-agent": { "type": "string", "readOnly": true } }, "required": [ "device-provisioning-mac-address", "reseller", "device-models-brand-and-model", "device-provisioning-registration-core-server", "device-provisioning-sip-uri-1", "device-provisioning-line-1-enabled", "device-provisioning-sip-uri-1-shared-line-enabled", "device-provisioning-sip-uri-2", "device-provisioning-line-2-enabled", "device-provisioning-sip-uri-2-shared-line-enabled", "device-provisioning-sip-transport-protocol", "device-provisioning-username", "device-provisioning-password", "device-models-count-buttons", "device-models-fxs-support-enabled", "device-models-overrides-blob", "device-models-resync-support-enabled", "device-models-shared-line-support-enabled", "device-models-sidecar-support-enabled", "device-provisioning-last-retrieved-datetime", "device-provisioning-directory", "device-provisioning-directory-support", "device-provisioning-ndp-hostname", "device-provisioning-presence", "created-datetime", "global-one-time-pass", "redundency" ] }, "example": { "mac": "{{mac}}" } } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/phones/{mac}": { "get": { "summary": "Read Specific Mac Address", "deprecated": false, "description": "", "tags": [ "Phones/Macs" ], "parameters": [ { "name": "mac", "in": "path", "description": "", "required": true, "example": "000111222333", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NdpPhone" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/phones/{mac}": { "get": { "summary": "Read Specific Mac Addresses in Domain", "deprecated": false, "description": "", "tags": [ "Phones/Macs" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "mac", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Records per page. Defaults to 100, maximum 100. Higher values, or more than one `limit` parameter, are rejected with 400. Page through results with `start`.", "required": false, "schema": { "$ref": "#/components/schemas/Limit", "type": "integer", "minimum": 1, "maximum": 100, "default": 100 }, "example": 100 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NdpPhone" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/sites/list": { "get": { "summary": "List Sites in Domain", "deprecated": false, "description": "", "tags": [ "Sites" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Site" } }, "example": [ { "domain": "example", "name-first-name": "example site first name", "name-last-name": "example site last name", "department": "", "site": "example site", "directory-name-number-dtmf-mapping": "sites" } ] } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 403, "message": "Domain not found or access denied" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/sites": { "get": { "summary": "Read Sites in Domain", "deprecated": false, "description": "", "tags": [ "Sites" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "example.com", "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Site" } } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "post": { "summary": "Create Site in Domain", "deprecated": false, "description": "", "tags": [ "Sites" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Site" }, "example": { "synchronous": "no", "site": "New York" } } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} }, "409": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/sites/count": { "get": { "summary": "Count Sites in Domain", "deprecated": false, "description": "", "tags": [ "Sites" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Count" }, "example": { "total": 1 } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 403, "message": "Domain not found or access denied" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/sites/{site}": { "put": { "summary": "Update Site in Domain", "deprecated": false, "description": "", "tags": [ "Sites" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "site", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "synchronous": { "$ref": "#/components/schemas/Synchronous" }, "login-username": { "type": "string", "description": "This is the login for the user used to access the portals and other applications. The default will be [user]@[domain] if not set otherwise. This value is required to be unique across the entire system so 409 will be returned if not unique." }, "email": { "type": "string", "description": "This is the email adresses or list of email addresses sepertaed with a semi-colon. ", "format": "email" }, "time-zone": { "$ref": "#/components/schemas/TimeZone" }, "dial-plan": { "type": "string", "description": "This is the dial plan set for the user. Dial plans are used to control action and forward options that will be used when dialing out from the user. " }, "dial-policy": { "type": "string", "description": "This value is the dial policy/permission for this user whch will control the destinations this user can dial. Generally dial policys are preconfigured at system level and selected at user level. " }, "voicemail-user-control-enabled": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "phone-numbers-to-allow-enabled": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "phone-numbers-to-reject-enabled": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "call-screening-enabled": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "language-token": { "type": "string", "description": "This is the language that is set for the user to be used for portal viewing. ", "default": "en_US", "examples": [ "ca_FR", "es_MX", "en_UK" ] }, "limits-max-data-storage-kilobytes": { "type": "integer", "description": "This is the maximum value in kilobytes that is allowed to be stored in the user's voicemail, audio greetings and fax storage. ", "minimum": 0 }, "limits-max-active-calls-total": { "type": "integer", "description": "This is the maximum number of active calls allowed for the user. ", "minimum": 0, "maximum": 3600 }, "directory-announce-in-dial-by-name-enabled": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "voicemail-enabled": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "voicemail-receive-broadcast-enabled": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "reject-anonymous-calls-enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "voicemail-playback-announce-datetime-received": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "voicemail-playback-announce-caller-id": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "voicemail-playback-sort-newest-to-oldest": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "caller-id-number": { "type": "string", "description": "This is the main caller id number for the user to be used for outbound calls outside of the domain. ", "examples": [ "18585551234", "\"[*]\"" ], "format": "phonenumber" }, "caller-id-name": { "type": "string", "description": "This is the main caller id name for the user to be used for outbound calls outside of the domain. " }, "caller-id-number-emergency": { "anyOf": [ { "type": "integer", "title": "", "description": "" }, { "type": "string", "title": "", "description": "" } ], "description": "This is the main caller id that will be used for emergency calls when placed by the user." }, "area-code": { "type": "integer", "description": "This is a area code for the user. I will be used when user dial's 7 digits to translate it to full 10 or 11 digit number. ", "minimum": 100, "maximum": 999 }, "directory-name-visible-in-list-enabled": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "emergency-address-id": { "type": "string", "description": "Value will need to be an exact match to an address-id which links to a address for DLR (dynamic location routing) for emergency calling" }, "music-on-hold-randomized-enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "active-calls-total-current": { "type": "integer", "readOnly": true, "description": "This read only setting is the current active call count for this user. " }, "created-datetime": { "type": "string", "readOnly": true, "format": "date-time", "description": "This datetime is when the user was created. " }, "last-modified-datetime": { "type": "string", "format": "date-time", "readOnly": true, "description": "This datetime is when the user was last modified. " }, "recording-configuration": { "$ref": "#/components/schemas/RecordingConfiguration" } }, "required": [ "email" ] }, "example": { "synchronous": "no", "site": "New York" } } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "get": { "summary": "Read Specific Site in Domain", "deprecated": false, "description": "", "tags": [ "Sites" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "example.com", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "site", "in": "path", "description": "", "required": true, "example": "New York", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Site" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/callqueues": { "get": { "summary": "Read Call Queues in Domain", "deprecated": false, "description": "", "operationId": "ReadCallqueues", "tags": [ "Call Center/Callqueues" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CallQueue" } } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "post": { "summary": "Create Call Queue in Domain", "deprecated": false, "description": "", "operationId": "CreateCallqueue", "tags": [ "Call Center/Callqueues" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "synchronous": { "$ref": "#/components/schemas/Synchronous" }, "callqueue": { "type": "string", "description": "This is the main call queue extension which is the identifier for this call quieue. " }, "domain": { "$ref": "#/components/schemas/DomainName" }, "description": { "type": "string", "description": "This is a simple description of the callqueue which can be used to better explain the use or purpose of this call queue. " }, "callqueue-dispatch-type": { "type": "string", "description": "This is the main dispatch type for hunting agents. The options are described below. \n#Round-robin\n#Tiered Round-robin\n#Ring All\n#Linear Cascade\n#Linear Hunt\n#Call Park\n", "title": "", "enum": [ "Round-robin", "Tiered Round-robin", "Ring All", "Linear Cascade", "Linear Hunt", "Call Park" ] }, "callqueue-calculate-statistics": { "$ref": "#/components/schemas/YesNoString", "description": "Enabled will trigger music on hold for the domain and allow it to be customized. " }, "active-queued-calls-total-current": { "type": "integer", "description": "This is the current calls waiting in the call queue waiting to be dispatched. ", "readOnly": true }, "callqueue-agent-dispatch-timeout-seconds": { "type": "integer", "description": "This is the timeout in seconds the call queue will attempt an agent before timing out and retrying additional resources." }, "callqueue-count-agents-available": { "type": "integer", "description": "This is the current number of agents logged in and available for work. ", "readOnly": true }, "callqueue-count-agents-total": { "type": "integer", "description": "This is the current number of agents configured for this callqueue. " }, "callqueue-debug": { "$ref": "#/components/schemas/YesNoString", "description": "Enabled will trigger music on hold for the domain and allow it to be customized. " }, "callqueue-force-full-intro-playback": { "$ref": "#/components/schemas/YesNoString", "description": "Enabled will trigger music on hold for the domain and allow it to be customized. " }, "callqueue-max-callback-queueing-hours": { "type": "integer", "description": "This setting will allow callback's in the callqueue allowing callers to press a buton and opt for a callback instead of waiting. 0 the default is off, any other positive number will enable callback and allow callback up to that many hours after the callback is requested. ", "default": 0, "minimum": 0, "maximum": 6 }, "callqueue-max-current-callers-to-accept-new-callers": { "type": "integer", "description": "This setting is the maximum number of callers allowed in the queue before forward busy answer rules will be followed. 0 is unlimited", "minimum": 0, "default": 0 }, "callqueue-max-current-wait-to-accept-new-callers-seconds": { "type": "integer", "description": "This setting is the maximum expected wait time allowed in the queue before forward busy answer rules will be followed. 0 is unlimited", "minimum": 0, "default": 0 }, "callqueue-max-wait-timeout-minutes": { "type": "integer", "description": "This is the max wait time in minutes that it would allow a call to wait before being forced out of the queue. 0 is unlimited", "default": 0, "minimum": 0 }, "callqueue-require-available-agents-to-accept-new-callers": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "callqueue-source-match": { "type": [ "string", "null" ], "description": "This is a optional setting that will control the source match for the forward dispatch leg of calls allowing if needed different matches to connecting devices when calls come through the queue. " }, "callqueue-sms-enable": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "callqueue-sms-phrase-initiate-chat": { "type": [ "string", "null" ], "description": "This is the keyword that will be the trigger for a new SMS queueing session " }, "callqueue-sms-phrase-initiate-success": { "type": [ "string", "null" ], "description": "The message to auto reply to a inbound SMS message once the trigger keyword is detected" }, "callqueue-sms-phrase-initiation-fail ": { "type": [ "string", "null" ], "description": "The message that will be auto replied when a message wihtout the keywork is detected. " }, "callqueue-sms-phrase-no-agents-available": { "type": [ "string", "null" ], "description": "The message that will be auto replied when there are no agents available and the system is unable to setup a sms chat session at this time. " }, "callqueue-sms-phrase-terminate-chat": { "type": [ "string", "null" ], "description": "This is the keyword that will be the trigger to end a active SMS session. " }, "callqueue-sms-phrase-terminate-success": { "type": [ "string", "null" ], "description": "The message that will be played after a successfully termination of a session via a keyword. " }, "callqueue-agent-auto-logout-after-missed": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "callqueue-sim-ring-1st-round": { "type": "integer", "description": "When using a callqueue-dispatch-type value that allows for mutlple agents to be run on at a time this setting controls the amount of agents that are dispatched in the first round.", "minimum": 0, "maximum": 99, "default": 0 }, "callqueue-sim-ring-increment": { "type": "integer", "description": "When using a callqueue-dispatch-type value that allows for mutlple agents to be run on at a time this setting controls the amount of agents that will be added to the group activly ringing at each agent timeout level. ", "minimum": 0, "maximum": 99, "default": 1 }, "recording-configuration": { "$ref": "#/components/schemas/RecordingConfiguration" } }, "required": [ "synchronous", "callqueue", "domain" ] }, "example": { "callqueue": "2032", "description": "Sales Queue", "callqueue-dispatch-type": "Ring All", "callqueue-debug": "yes", "callqueue-calculate-statistics": "yes", "callqueue-source-match": "", "callqueue-force-full-intro-playback": "yes", "callqueue-max-callback-queueing-hours": "2" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallQueue" } } }, "headers": {} }, "202": { "description": "", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CallQueue" } } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/callqueues/{callqueue}": { "put": { "summary": "Update Call Queue in Domain", "deprecated": false, "description": "", "operationId": "UpdateCallqueue", "tags": [ "Call Center/Callqueues" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "callqueue", "in": "path", "description": "", "required": true, "example": "", "schema": { "$ref": "#/components/schemas/CallqueuePath" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "description": "This is a simple description of the callqueue which can be used to better explain the use or purpose of this call queue. " }, "callqueue-dispatch-type": { "type": "string", "description": "This is the main dispatch type for hunting agents. The options are described below. \n#Round-robin\n#Tiered Round-robin\n#Ring All\n#Linear Cascade\n#Linear Hunt\n#Call Park\n", "title": "", "enum": [ "Round-robin", "Tiered Round-robin", "Ring All", "Linear Cascade", "Linear Hunt", "Call Park" ] }, "callqueue-calculate-statistics": { "$ref": "#/components/schemas/YesNoString", "description": "Enabled will trigger music on hold for the domain and allow it to be customized. " }, "active-queued-calls-total-current": { "type": "integer", "description": "This is the current calls waiting in the call queue waiting to be dispatched. ", "readOnly": true }, "callqueue-agent-dispatch-timeout-seconds": { "type": "integer", "description": "This is the timeout in seconds the call queue will attempt an agent before timing out and retrying additional resources." }, "callqueue-count-agents-available": { "type": "integer", "description": "This is the current number of agents logged in and available for work. ", "readOnly": true }, "callqueue-count-agents-total": { "type": "integer", "description": "This is the current number of agents configured for this callqueue. " }, "callqueue-debug": { "$ref": "#/components/schemas/YesNoString", "description": "Enabled will trigger music on hold for the domain and allow it to be customized. " }, "callqueue-force-full-intro-playback": { "$ref": "#/components/schemas/YesNoString", "description": "Enabled will trigger music on hold for the domain and allow it to be customized. " }, "callqueue-max-callback-queueing-hours": { "type": "integer", "description": "This setting will allow callback's in the callqueue allowing callers to press a buton and opt for a callback instead of waiting. 0 the default is off, any other positive number will enable callback and allow callback up to that many hours after the callback is requested. ", "default": 0, "minimum": 0, "maximum": 6 }, "callqueue-max-current-callers-to-accept-new-callers": { "type": "integer", "description": "This setting is the maximum number of callers allowed in the queue before forward busy answer rules will be followed. 0 is unlimited", "minimum": 0, "default": 0 }, "callqueue-max-current-wait-to-accept-new-callers-seconds": { "type": "integer", "description": "This setting is the maximum expected wait time allowed in the queue before forward busy answer rules will be followed. 0 is unlimited", "minimum": 0, "default": 0 }, "callqueue-max-wait-timeout-minutes": { "type": "integer", "description": "This is the max wait time in minutes that it would allow a call to wait before being forced out of the queue. 0 is unlimited", "default": 0, "minimum": 0 }, "callqueue-require-available-agents-to-accept-new-callers": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "callqueue-source-match": { "type": [ "string", "null" ], "description": "This is a optional setting that will control the source match for the forward dispatch leg of calls allowing if needed different matches to connecting devices when calls come through the queue. " }, "callqueue-sms-enable": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "callqueue-sms-phrase-initiate-chat": { "type": [ "string", "null" ], "description": "This is the keyword that will be the trigger for a new SMS queueing session " }, "callqueue-sms-phrase-initiate-success": { "type": [ "string", "null" ], "description": "The message to auto reply to a inbound SMS message once the trigger keyword is detected" }, "callqueue-sms-phrase-initiation-fail ": { "type": [ "string", "null" ], "description": "The message that will be auto replied when a message wihtout the keywork is detected. " }, "callqueue-sms-phrase-no-agents-available": { "type": [ "string", "null" ], "description": "The message that will be auto replied when there are no agents available and the system is unable to setup a sms chat session at this time. " }, "callqueue-sms-phrase-terminate-chat": { "type": [ "string", "null" ], "description": "This is the keyword that will be the trigger to end a active SMS session. " }, "callqueue-sms-phrase-terminate-success": { "type": [ "string", "null" ], "description": "The message that will be played after a successfully termination of a session via a keyword. " }, "callqueue-agent-auto-logout-after-missed": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "callqueue-sim-ring-1st-round": { "type": "integer", "description": "When using a callqueue-dispatch-type value that allows for mutlple agents to be run on at a time this setting controls the amount of agents that are dispatched in the first round.", "minimum": 0, "maximum": 99, "default": 0 }, "callqueue-sim-ring-increment": { "type": "integer", "description": "When using a callqueue-dispatch-type value that allows for mutlple agents to be run on at a time this setting controls the amount of agents that will be added to the group activly ringing at each agent timeout level. ", "minimum": 0, "maximum": 99, "default": 1 }, "recording-configuration": { "$ref": "#/components/schemas/RecordingConfiguration" } } }, "example": { "queue_name": "6005", "domain": "{{domain}}", "description": "My Call queue (updated)", "huntgroup_option": "RingAll", "run_stats": "no" } } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "delete": { "summary": "Delete Call Queue", "deprecated": false, "description": "", "operationId": "DeleteCallqueue", "tags": [ "Call Center/Callqueues" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "callqueue", "in": "path", "description": "", "required": true, "example": "", "schema": { "$ref": "#/components/schemas/CallqueuePath" } } ], "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "get": { "summary": "Read Specific Call Queue", "deprecated": false, "description": "", "operationId": "ReadCallqueue", "tags": [ "Call Center/Callqueues" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "callqueue", "in": "path", "description": "", "required": true, "example": "", "schema": { "$ref": "#/components/schemas/CallqueuePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallQueue" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/callqueues/list": { "get": { "summary": "Read Basic info on Call Queues in Domain", "deprecated": false, "description": "", "operationId": "ListCallqueues", "tags": [ "Call Center/Callqueues", "ReadOnlyDomain" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CallQueue" } } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/callqueues/{callqueue}/agents": { "get": { "summary": "Read Agents in Call Queue", "deprecated": false, "description": "", "operationId": "ReadAgents", "tags": [ "Call Center/Agents" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "callqueue", "in": "path", "description": "", "required": true, "example": "2032", "schema": { "$ref": "#/components/schemas/CallqueuePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Agent" } } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "post": { "summary": "Add Agent to Call Queue", "deprecated": false, "description": "", "operationId": "CreateAgent", "tags": [ "Call Center/Agents" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "callqueue", "in": "path", "description": "", "required": true, "example": "2032", "schema": { "$ref": "#/components/schemas/CallqueuePath" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "synchronous": { "$ref": "#/components/schemas/Synchronous" }, "callqueue-agent-id": { "type": "string", "examples": [ "1000@domain", "sip:1001@domain.com" ], "description": "This is the main identifier for a \"agent\" in a queue. There are two format supported here, either a user based option which will look like user@domain or a device based method like sip:device@domain. " }, "callqueue": { "type": "string", "description": "This is the callqueue id for which the agent is in. The agent may be in multiple callqueus, but this value is a single entry. ", "examples": [ "3000" ] }, "domain": { "$ref": "#/components/schemas/DomainName" }, "callqueue-agent-availability-type": { "type": "string", "enum": [ "automatic", "manual", "disabled", "offnet-automatic" ], "description": "This is the main toggle for the agents status in the queue. \"automatic\" is logged in, which manual is logged out with the option for one call. From a angent perspective and the actions of logging in and out the recomention would be to use the specific \"agent actions\" api instead of the basic agent update request. " }, "callqueue-agent-wrap-up-allowance-seconds": { "type": "integer", "default": 0, "description": "This is the number of seconds that the system will hold the agent offline before logging them back in automatically. This time allows the agent to comolete needed notes and conclusions to previous calls and prepare for next call. " }, "auto-answer-enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "callqueue-agent-dispatch-order-ordinal": { "type": "integer", "description": "For use in callqueues that have a linear order, this value would be to the order of the agent in that list, the lower the number the higher agent in the order. " }, "callqueue-agent-dispatch-queue-priority-ordinal": { "type": "integer", "description": "This setting is a priority value for this agent's entry with respect to the other callqueues they are in. Lower number is higher priority. This means that when the agent comes back available after a call the priority would be used to determine which queue its attempted first. " }, "limits-max-active-calls-total": { "type": "integer", "description": "This is the maximum number of calls an agent will be given at at time. Default and ideal is 1, but if needed it can be higher" }, "callqueue-agent-answer-confirmation-enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "callqueue-agent-has-registered-devices": { "type": "string", "enum": [ "yes", "no", "push-enabled", "offnet" ], "readOnly": true, "description": "This read only status will show the agents registration infor and if the system believes the device is registered. " }, "callqueue-agent-availability-for-dispatch": { "type": "string", "description": "This is the status for the agent generated by the system using all available informaion. " }, "active-calls-total-current": { "type": "integer", "readOnly": true, "description": "This is the total number of calls on the agent's account across all their queues" }, "last-modified-datetime": { "type": "string", "format": "date-time", "readOnly": true, "description": "This timestamp is the datetime of the last change to the agent's configuration and status" }, "callqueue-agent-max-concurrent-sms-conversations": { "type": "integer", "description": "This is the maximum number of SMS queue sessions the agent will be requested to handle before queing up future requests. " }, "last-callqueue-dispatch-datetime": { "type": [ "string", "null" ], "format": "date-time", "readOnly": true, "description": "This timestamp is the datetime of the last dispatch to the agent. " }, "callqueue-agent-entry-type": { "type": "string", "description": "This is a read only field that will tell you the type of agent config that is setup, this might include device or user based agents or \"offnet\"", "readOnly": true, "enum": [ "device", "user", "offnet" ] }, "login-username": { "type": "string", "readOnly": true, "description": "This value read only from the user that is linked to this agent. Its the user's login if needed. " }, "name-full-name": { "type": "string", "readOnly": true, "description": "This value read only from the user that is linked to this agent. Its the user's full name. " }, "agent-name-first-name": { "type": "string", "readOnly": true, "description": "This value read only from the user that is linked to this agent. Its the user's first name. " }, "agent-name-last-name": { "type": "string", "readOnly": true, "description": "This value read only from the user that is linked to this agent. Its the user's last name. " }, "agent-department": { "type": "string", "readOnly": true, "description": "This value read only from the user that is linked to this agent. Its the user's depeartment. " }, "agent-site": { "type": "string", "readOnly": true, "description": "This value read only from the user that is linked to this agent. Its the user's site " }, "agent-user-scope": { "type": "string", "readOnly": true, "description": "This value read only from the user that is linked to this agent. Its the user's scope. " }, "agent-status-message": { "type": [ "string", "null" ], "readOnly": true, "description": "This value read only from the user that is linked to this agent. Its the user's status message. " } }, "required": [ "callqueue-agent-id" ] }, "example": { "callqueue-agent-id": "{{user}}@{{domain}}", "callqueue-agent-availability-type": "automatic", "limits-max-active-calls-total": 2, "callqueue-agent-max-concurrent-sms-conversations": 2, "callqueue-agent-answer-confirmation-enabled": "yes", "auto-answer-enabled": "yes", "callqueue-agent-wrap-up-allowance-seconds": 10 } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Agent" }, "example": { "domain": "apidog.automation", "callqueue": "6000", "callqueue-agent-id": "1000@apidog.automation", "name-full-name": "John Doe", "callqueue-agent-availability-type": "automatic", "callqueue-agent-availability-for-dispatch": "unavailable", "callqueue-agent-wrap-up-allowance-seconds": 10, "callqueue-agent-has-registered-devices": "no", "callqueue-agent-dispatch-order-ordinal": 0, "callqueue-agent-dispatch-queue-priority-ordinal": 0, "sub_portal_status": "Im away 2", "active-calls-total-current": 0, "agent-department": "", "auto_ans": "yes", "callqueue-agent-answer-confirmation-enabled": "yes", "callqueue-agent-entry-type": "user", "callqueue-agent-max-concurrent-sms-conversations": 2, "last-callqueue-dispatch-datetime": null, "last-modified-datetime": "2023-10-11 16:53:54", "limits-max-active-calls-total": 2, "login-username": "1000@apidog.automation", "name-first-name": "John", "name-last-name": "Doe", "sub_scope": "Basic User", "sub_site": "New York" } } }, "headers": {} }, "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/callqueues/{callqueue}/agents/count": { "get": { "summary": "Count Agents in Call Queue", "deprecated": false, "description": "", "tags": [ "Call Center/Agents" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "callqueue", "in": "path", "description": "", "required": true, "example": "{{callqueue}}", "schema": { "$ref": "#/components/schemas/CallqueuePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Count" }, "example": { "total": 4 } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 403, "message": "Domain not found or access denied" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/agents": { "get": { "summary": "Read Agents in Domain", "deprecated": false, "description": "", "operationId": "ReadAgentsDomain", "tags": [ "Call Center/Agents" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Agent" } } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/callqueues/{callqueue}/agents/{callqueue-agent-id}": { "get": { "summary": "Read Specific Agent in Call Queue", "deprecated": false, "description": "", "operationId": "ReadAgent", "tags": [ "Call Center/Agents" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "callqueue", "in": "path", "description": "", "required": true, "example": "2032", "schema": { "$ref": "#/components/schemas/CallqueuePath" } }, { "name": "callqueue-agent-id", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/AgentPath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Agent" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "put": { "summary": "Update Agent in Call Queue", "deprecated": false, "description": "", "operationId": "UpdateAgent", "tags": [ "Call Center/Agents" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "callqueue", "in": "path", "description": "", "required": true, "example": "2032", "schema": { "$ref": "#/components/schemas/CallqueuePath" } }, { "name": "callqueue-agent-id", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/AgentPath" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "callqueue-agent-availability-type": { "type": "string", "enum": [ "automatic", "manual", "disabled", "offnet-automatic" ], "description": "This is the main toggle for the agents status in the queue. \"automatic\" is logged in, which manual is logged out with the option for one call. From a angent perspective and the actions of logging in and out the recomention would be to use the specific \"agent actions\" api instead of the basic agent update request. " }, "callqueue-agent-wrap-up-allowance-seconds": { "type": "integer", "default": 0, "description": "This is the number of seconds that the system will hold the agent offline before logging them back in automatically. This time allows the agent to comolete needed notes and conclusions to previous calls and prepare for next call. " }, "auto-answer-enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "callqueue-agent-dispatch-order-ordinal": { "type": "integer", "description": "For use in callqueues that have a linear order, this value would be to the order of the agent in that list, the lower the number the higher agent in the order. " }, "callqueue-agent-dispatch-queue-priority-ordinal": { "type": "integer", "description": "This setting is a priority value for this agent's entry with respect to the other callqueues they are in. Lower number is higher priority. This means that when the agent comes back available after a call the priority would be used to determine which queue its attempted first. " }, "limits-max-active-calls-total": { "type": "integer", "description": "This is the maximum number of calls an agent will be given at at time. Default and ideal is 1, but if needed it can be higher" }, "callqueue-agent-answer-confirmation-enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "callqueue-agent-has-registered-devices": { "type": "string", "enum": [ "yes", "no", "push-enabled", "offnet" ], "readOnly": true, "description": "This read only status will show the agents registration infor and if the system believes the device is registered. " }, "callqueue-agent-availability-for-dispatch": { "type": "string", "description": "This is the status for the agent generated by the system using all available informaion. " }, "active-calls-total-current": { "type": "integer", "readOnly": true, "description": "This is the total number of calls on the agent's account across all their queues" }, "last-modified-datetime": { "type": "string", "format": "date-time", "readOnly": true, "description": "This timestamp is the datetime of the last change to the agent's configuration and status" }, "callqueue-agent-max-concurrent-sms-conversations": { "type": "integer", "description": "This is the maximum number of SMS queue sessions the agent will be requested to handle before queing up future requests. " }, "last-callqueue-dispatch-datetime": { "type": [ "string", "null" ], "format": "date-time", "readOnly": true, "description": "This timestamp is the datetime of the last dispatch to the agent. " }, "callqueue-agent-entry-type": { "type": "string", "description": "This is a read only field that will tell you the type of agent config that is setup, this might include device or user based agents or \"offnet\"", "readOnly": true, "enum": [ "device", "user", "offnet" ] }, "login-username": { "type": "string", "readOnly": true, "description": "This value read only from the user that is linked to this agent. Its the user's login if needed. " }, "name-full-name": { "type": "string", "readOnly": true, "description": "This value read only from the user that is linked to this agent. Its the user's full name. " }, "agent-name-first-name": { "type": "string", "readOnly": true, "description": "This value read only from the user that is linked to this agent. Its the user's first name. " }, "agent-name-last-name": { "type": "string", "readOnly": true, "description": "This value read only from the user that is linked to this agent. Its the user's last name. " }, "agent-department": { "type": "string", "readOnly": true, "description": "This value read only from the user that is linked to this agent. Its the user's depeartment. " }, "agent-site": { "type": "string", "readOnly": true, "description": "This value read only from the user that is linked to this agent. Its the user's site " }, "agent-user-scope": { "type": "string", "readOnly": true, "description": "This value read only from the user that is linked to this agent. Its the user's scope. " }, "agent-status-message": { "type": [ "string", "null" ], "readOnly": true, "description": "This value read only from the user that is linked to this agent. Its the user's status message. " } } }, "example": { "callqueue-agent-answer-confirmation-enabled": "no", "callqueue-agent-availability-type": "manual", "callqueue-agent-wrap-up-allowance-seconds": 10, "auto-answer-enabled": "yes" } } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" }, "example": { "code": 202, "message": "Accepted" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "delete": { "summary": "Remove Agent from Call Queue", "deprecated": false, "description": "", "operationId": "DeleteAgent", "tags": [ "Call Center/Agents" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "callqueue", "in": "path", "description": "", "required": true, "example": "6000", "schema": { "$ref": "#/components/schemas/CallqueuePath" } }, { "name": "callqueue-agent-id", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/AgentPath" } } ], "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/callqueues/{callqueue}/agents/{callqueue-agent-id}/login": { "patch": { "summary": "Agent Login ", "deprecated": false, "description": "", "operationId": "AgentLogin", "tags": [ "Call Center/Agent Actions" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "callqueue", "in": "path", "description": "", "required": true, "example": "all", "schema": { "$ref": "#/components/schemas/CallqueuePath" } }, { "name": "callqueue-agent-id", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/AgentPath" } } ], "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/callqueues/{callqueue}/agents/{callqueue-agent-id}/logout": { "patch": { "summary": "Agent Logout", "deprecated": false, "description": "", "operationId": "AgentLogout", "tags": [ "Call Center/Agent Actions" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "callqueue", "in": "path", "description": "", "required": true, "example": "all", "schema": { "$ref": "#/components/schemas/CallqueuePath" } }, { "name": "callqueue-agent-id", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/AgentPath" } } ], "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/callqueues/{callqueue}/agents/{callqueue-agent-id}/onecall": { "patch": { "summary": "Agent Single Call", "deprecated": false, "description": "", "operationId": "AgentSingleCall", "tags": [ "Call Center/Agent Actions" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "callqueue", "in": "path", "description": "", "required": true, "example": "2032", "schema": { "$ref": "#/components/schemas/CallqueuePath" } }, { "name": "callqueue-agent-id", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/AgentPath" } } ], "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/callqueues/all/agents/{callqueue-agent-id}/{status}": { "patch": { "summary": "Agent Set Offline Status", "deprecated": false, "description": "", "operationId": "AgentStatus", "tags": [ "Call Center/Agent Actions" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "callqueue-agent-id", "in": "path", "description": "", "required": true, "example": "{{callqueue-agent-id}}", "schema": { "$ref": "#/components/schemas/AgentPath" } }, { "name": "status", "in": "path", "description": "If you're going to use the custom status such as how you set it in the portal, you need to use \"cust1\" through \"cust8\" instead of the literal/actual status name you intend to use, and then alias/reference the \"custX\" status in your code.", "required": true, "example": "cust1", "schema": { "type": "string" } } ], "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/queuedcall/{queue}": { "get": { "summary": "Read Queued Calls", "deprecated": false, "description": "", "tags": [ "Call Center/QueuedCalls" ], "parameters": [ { "name": "domain", "in": "path", "description": "Domain containing Callqueue", "required": true, "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "queue", "in": "path", "description": "Callqueue from which to read queued calls", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/queuedcall/{callqueue}": { "post": { "summary": "Add a Queued Call", "deprecated": false, "description": "Used to create a queue call between desginated Queue and destination.", "tags": [ "Call Center/QueuedCalls" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "callqueue", "in": "path", "description": "When used in path the callqueue value will link to a extension id for a preconfigured callqueue.", "required": true, "example": "421", "schema": { "$ref": "#/components/schemas/CallqueuePath" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "destination": { "type": "string", "description": "Call back destination" } }, "required": [ "destination" ] }, "example": { "destination": "18587645200" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/statistics/callqueues/{callqueue}": { "get": { "summary": "Get Callqueue Statistics for a Specific Queue", "deprecated": false, "description": "", "tags": [ "Call Center/Statistics", "44.3" ], "parameters": [ { "name": "domain", "in": "path", "description": "This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. ", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "callqueue", "in": "path", "description": "When used in path the callqueue value will link to a extension id for a preconfigured callqueue.", "required": true, "example": "421", "schema": { "$ref": "#/components/schemas/CallqueuePath" } }, { "name": "datetime-start", "in": "query", "description": "This is the start of the time window for a given query. The format is based on RFC3339 but also will support additonal params for use in providing a timezone which will allow the API to give the correct range for a given set of data and will be formated in respone using the same format.\n\nSupported formats include.\n\n2023-11-27 13:00:00\n2023-11-27T13:00:00Z\n2023-11-27T13:00:00-08:00\n2023-11-27T13:00:00-08:00[US/Pacific]\n2023-11-27T13:00:00Z[America/Phoenix]", "required": true, "example": "2023-11-27T13:00:00Z[US/Pacific]", "schema": { "$ref": "#/components/schemas/DatetimeStart" } }, { "name": "datetime-end", "in": "query", "description": "This is the end of the time window for a given query. The format is based on RFC3339 but also will support additonal params for use in providing a timezone which will allow the API to give the correct range for a given set of data and will be formated in respone using the same format. Allowed values same as datetime-start.", "required": true, "example": "2023-11-27T14:00:00Z[US/Pacific]", "schema": { "$ref": "#/components/schemas/DatetimeEnd" } }, { "name": "fields", "in": "query", "description": "Fields in order to fill and get particular statistics for. Separate multiple fields with \",\". Default value is VOL,CH,ATT,AC,AWT,SL", "required": false, "example": "VOL,CH,ATT,AC,AWT,SL", "schema": { "type": "string" } }, { "name": "remove_zeros", "in": "query", "description": "Remove zeros from the results.", "required": false, "example": "true", "schema": { "type": "string" } }, { "name": "queue_list", "in": "query", "description": "Allows for a filter of certain queues. List can be comma separated for example 5202,5201", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "calls-total-count": { "type": "integer", "description": "Number of calls originating through a Call Queue. Includes answered calls, abandoned calls, forwards, and voicemail." }, "calls-answered-count": { "type": "integer", "description": "Number of calls answered by agent originating through a Call Queue. The call must also terminate with the agent to be counted as a call handled." }, "calls-presented-count": { "type": "integer", "description": "Number of calls that reached the queue to be dispatched to agents. Includes abandoned calls. Excludes forwards and voicemail." }, "calls-presented-adjusted-count": { "type": "integer", "description": "Adjusted number of calls that reached the queue. Excludes calls abandoned in less than 10 seconds." }, "calls-voicemailed-count": { "type": "integer", "description": "Number of calls handled by the automated voicemail system." }, "calls-forwarded-count": { "type": "integer", "description": "Number of calls forwarded to another queue or off-net phone number for handling. Includes forwarded calls to voicemail." }, "calls-talking-avg-duration-minutes": { "type": "number", "description": "Average number of minutes spent by agent talking per call, on calls originating through a Call Queue. Excludes hold time." }, "calls-assisted-count": { "type": "integer", "description": "Number of calls answered and then transferred to another agent. " }, "calls-after-call-work-avg-duration-seconds": { "type": "integer", "description": "Average time an agent spends between the end of a call and submitting call disposition.\n\nThis metric is only applied to agents using Single Call Mode." }, "calls-callback-requests-count": { "type": "integer", "description": "Number of calls that requested a callback rather than waiting in the queue. " }, "calls-holding-avg-duration-seconds": { "type": "number", "description": "Average time a caller spends on hold with an agent. Excludes waiting time in the Call Queue." }, "calls-service-level-percent": { "type": "number", "description": "The ratio of calls meeting the configurable service level agreement. " }, "calls-presented-percent": { "type": "number", "description": "The percentage of handled calls that an agent transferred to any destination (including another user/agent, supervisor, queue, IVR, or external number)." }, "calls-abandoned-count": { "type": "integer", "description": "Number of calls that abandoned the queue before being answered by an agent. " }, "calls-abandoned-adjusted-count": { "type": "integer", "description": "Adjusted number of calls that abandoned the queue. Excludes calls abandoned in less than 10 seconds. " }, "calls-abandoned-rate": { "type": "number", "description": "Percentage of calls offered that were abandoned before being offered to an agent. " }, "calls-abandoned-adjusted-rate": { "type": "number", "description": "Percentage of calls offered that were abandoned in under 10 seconds. " }, "calls-handling-avg-duration-minutes": { "type": "number", "description": "Average time an agent spent on a call. Includes Talk Time (TT), Hold Time (AH), and Disposition Time (ACW)." }, "calls-queueing-avg-duration-seconds": { "type": "number", "description": "Average number of seconds a caller spent in the selected queue before being dispatched to an agent. If none selected, total for all queues will be displayed." }, "sms-conversations-count": { "type": "integer", "description": "Number of SMS sessions handled through a Call Queue." }, "sms-handling-avg-duration-seconds": { "type": "number", "description": "Average time an agent spent handling an SMS session from the queue, starting from the moment they accept the message until it is terminated." } } }, "example": { "calls-total-count": 155, "calls-answered-count": 87, "calls-presented-count": 155, "calls-presented-adjusted-count": 151, "calls-voicemailed-count": 6, "calls-forwarded-count": 22, "calls-talking-avg-duration-minutes": 0.26, "calls-assisted-count": 29, "calls-after-call-work-avg-duration-seconds": 1.2, "calls-callback-requests-count": 18, "calls-holding-avg-duration-seconds": 0.55, "calls-service-level-percent": 81.29, "calls-presented-percent": 21.94, "calls-abandoned-count": 11, "calls-abandoned-adjusted-count": 8, "calls-abandoned-rate": 7.1, "calls-abandoned-adjusted-rate": 5.3, "calls-handling-avg-duration-minutes": 0.27, "calls-queueing-avg-duration-seconds": 11.88, "sms-conversations-count": 4, "sms-handling-avg-duration-seconds": 3 } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 0, "message": "string" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 0, "message": "string" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 0, "message": "string" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/statistics/callqueues/aggregate": { "get": { "summary": "Get Callqueue Statistics for all Queues Aggregated", "deprecated": false, "description": "", "tags": [ "Call Center/Statistics", "44.3" ], "parameters": [ { "name": "domain", "in": "path", "description": "This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. ", "required": true, "example": "example.com", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "datetime-start", "in": "query", "description": "This is the start of the time window for a given query. The format is based on RFC3339 but also will support additonal params for use in providing a timezone which will allow the API to give the correct range for a given set of data and will be formated in respone using the same format.\n\nSupported formats include.\n\n2023-11-27 13:00:00\n2023-11-27T13:00:00Z\n2023-11-27T13:00:00-08:00\n2023-11-27T13:00:00-08:00[US/Pacific]\n2023-11-27T13:00:00Z[America/Phoenix]", "required": true, "example": "2023-11-27T13:00:00Z[US/Pacific]", "schema": { "$ref": "#/components/schemas/DatetimeStart" } }, { "name": "datetime-end", "in": "query", "description": "This is the end of the time window for a given query. The format is based on RFC3339 but also will support additonal params for use in providing a timezone which will allow the API to give the correct range for a given set of data and will be formated in respone using the same format. Allowed values same as datetime-start.", "required": true, "example": "2023-11-27T14:00:00Z[US/Pacific]", "schema": { "$ref": "#/components/schemas/DatetimeEnd" } }, { "name": "fields", "in": "query", "description": "Fields in order to fill and get particular statistics for. Separate multiple fields with \",\". Default value is VOL,CH,ATT,AC,AWT,SL", "required": false, "example": "VOL,CH,ATT,AC,AWT,SL", "schema": { "type": "string" } }, { "name": "remove_zeros", "in": "query", "description": "Remove zeros from the results", "required": false, "example": "true", "schema": { "type": "string" } }, { "name": "queue_list", "in": "query", "description": "Allows for a filter of certain queues. List can be comma separated for example 5202,5201", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "calls-total-count": { "type": "integer", "description": "Number of calls originating through a Call Queue. Includes answered calls, abandoned calls, forwards, and voicemail." }, "calls-answered-count": { "type": "integer", "description": "Number of calls answered by agent originating through a Call Queue. The call must also terminate with the agent to be counted as a call handled." }, "calls-presented-count": { "type": "integer", "description": "Number of calls that reached the queue to be dispatched to agents. Includes abandoned calls. Excludes forwards and voicemail." }, "calls-presented-adjusted-count": { "type": "integer", "description": "Adjusted number of calls that reached the queue. Excludes calls abandoned in less than 10 seconds." }, "calls-voicemailed-count": { "type": "integer", "description": "Number of calls handled by the automated voicemail system." }, "calls-forwarded-count": { "type": "integer", "description": "Number of calls forwarded to another queue or off-net phone number for handling. Includes forwarded calls to voicemail." }, "calls-talking-avg-duration-minutes": { "type": "number", "description": "Average number of minutes spent by agent talking per call, on calls originating through a Call Queue. Excludes hold time." }, "calls-assisted-count": { "type": "integer", "description": "Number of calls answered and then transferred to another agent. " }, "calls-after-call-work-avg-duration-seconds": { "type": "integer", "description": "Average time an agent spends between the end of a call and submitting call disposition.\n\nThis metric is only applied to agents using Single Call Mode." }, "calls-callback-requests-count": { "type": "integer", "description": "Number of calls that requested a callback rather than waiting in the queue. " }, "calls-holding-avg-duration-seconds": { "type": "number", "description": "Average time a caller spends on hold with an agent. Excludes waiting time in the Call Queue." }, "calls-service-level-percent": { "type": "number", "description": "The ratio of calls meeting the configurable service level agreement. " }, "calls-presented-percent": { "type": "number", "description": "The percentage of handled calls that an agent transferred to any destination (including another user/agent, supervisor, queue, IVR, or external number)." }, "calls-abandoned-count": { "type": "integer", "description": "Number of calls that abandoned the queue before being answered by an agent. " }, "calls-abandoned-adjusted-count": { "type": "integer", "description": "Adjusted number of calls that abandoned the queue. Excludes calls abandoned in less than 10 seconds. " }, "calls-abandoned-rate": { "type": "number", "description": "Percentage of calls offered that were abandoned before being offered to an agent. " }, "calls-abandoned-adjusted-rate": { "type": "number", "description": "Percentage of calls offered that were abandoned in under 10 seconds. " }, "calls-handling-avg-duration-minutes": { "type": "number", "description": "Average time an agent spent on a call. Includes Talk Time (TT), Hold Time (AH), and Disposition Time (ACW)." }, "calls-queueing-avg-duration-seconds": { "type": "number", "description": "Average number of seconds a caller spent in the selected queue before being dispatched to an agent. If none selected, total for all queues will be displayed." }, "sms-conversations-count": { "type": "integer", "description": "Number of SMS sessions handled through a Call Queue." }, "sms-handling-avg-duration-seconds": { "type": "number", "description": "Average time an agent spent handling an SMS session from the queue, starting from the moment they accept the message until it is terminated." } } }, "example": { "calls-total-count": 155, "calls-answered-count": 87, "calls-presented-count": 155, "calls-presented-adjusted-count": 151, "calls-voicemailed-count": 6, "calls-forwarded-count": 22, "calls-talking-avg-duration-minutes": 0.26, "calls-assisted-count": 29, "calls-after-call-work-avg-duration-seconds": 1.2, "calls-callback-requests-count": 18, "calls-holding-avg-duration-seconds": 0.55, "calls-service-level-percent": 81.29, "calls-presented-percent": 21.94, "calls-abandoned-count": 11, "calls-abandoned-adjusted-count": 8, "calls-abandoned-rate": 7.1, "calls-abandoned-adjusted-rate": 5.3, "calls-handling-avg-duration-minutes": 0.27, "calls-queueing-avg-duration-seconds": 11.88, "sms-conversations-count": 4, "sms-handling-avg-duration-seconds": 3 } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 0, "message": "string" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 0, "message": "string" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 0, "message": "string" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/statistics/callqueues/per-queue": { "get": { "summary": "Get Callqueue Statistics for all Queues by Queue", "deprecated": false, "description": "", "tags": [ "Call Center/Statistics", "44.3" ], "parameters": [ { "name": "domain", "in": "path", "description": "This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. ", "required": true, "example": "example.com", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "datetime-start", "in": "query", "description": "This is the start of the time window for a given query. The format is based on RFC3339 but also will support additonal params for use in providing a timezone which will allow the API to give the correct range for a given set of data and will be formated in respone using the same format.\n\nSupported formats include.\n\n2023-11-27 13:00:00\n2023-11-27T13:00:00Z\n2023-11-27T13:00:00-08:00\n2023-11-27T13:00:00-08:00[US/Pacific]\n2023-11-27T13:00:00Z[America/Phoenix]", "required": true, "example": "2023-11-27T13:00:00Z[US/Pacific]", "schema": { "$ref": "#/components/schemas/DatetimeStart" } }, { "name": "datetime-end", "in": "query", "description": "This is the end of the time window for a given query. The format is based on RFC3339 but also will support additonal params for use in providing a timezone which will allow the API to give the correct range for a given set of data and will be formated in respone using the same format. Allowed values same as datetime-start.", "required": true, "example": "2023-11-27T14:00:00Z[US/Pacific]", "schema": { "$ref": "#/components/schemas/DatetimeEnd" } }, { "name": "fields", "in": "query", "description": "Fields in order to fill and get particular statistics for. Separate multiple fields with \",\".Default value is VOL,CH,ATT,AC,AWT,SL", "required": false, "example": "VOL,CH,ATT,AC,AWT,SL", "schema": { "type": "string" } }, { "name": "remove_zeros", "in": "query", "description": "Remove zeros from the results", "required": false, "example": "true", "schema": { "type": "string" } }, { "name": "queue_list", "in": "query", "description": "Alows for a filter of certain queues. List can be comma separated for example 421,425", "required": false, "example": "421,425", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "calls-total-count": { "type": "integer", "description": "Number of calls originating through a Call Queue. Includes answered calls, abandoned calls, forwards, and voicemail." }, "calls-answered-count": { "type": "integer", "description": "Number of calls answered by agent originating through a Call Queue. The call must also terminate with the agent to be counted as a call handled." }, "calls-presented-count": { "type": "integer", "description": "Number of calls that reached the queue to be dispatched to agents. Includes abandoned calls. Excludes forwards and voicemail." }, "calls-presented-adjusted-count": { "type": "integer", "description": "Adjusted number of calls that reached the queue. Excludes calls abandoned in less than 10 seconds." }, "calls-voicemailed-count": { "type": "integer", "description": "Number of calls handled by the automated voicemail system." }, "calls-forwarded-count": { "type": "integer", "description": "Number of calls forwarded to another queue or off-net phone number for handling. Includes forwarded calls to voicemail." }, "calls-talking-avg-duration-minutes": { "type": "number", "description": "Average number of minutes spent by agent talking per call, on calls originating through a Call Queue. Excludes hold time." }, "calls-assisted-count": { "type": "integer", "description": "Number of calls answered and then transferred to another agent. " }, "calls-after-call-work-avg-duration-seconds": { "type": "integer", "description": "Average time an agent spends between the end of a call and submitting call disposition.\n\nThis metric is only applied to agents using Single Call Mode." }, "calls-callback-requests-count": { "type": "integer", "description": "Number of calls that requested a callback rather than waiting in the queue. " }, "calls-holding-avg-duration-seconds": { "type": "number", "description": "Average time a caller spends on hold with an agent. Excludes waiting time in the Call Queue." }, "calls-service-level-percent": { "type": "number", "description": "The ratio of calls meeting the configurable service level agreement. " }, "calls-presented-percent": { "type": "number", "description": "The percentage of handled calls that an agent transferred to any destination (including another user/agent, supervisor, queue, IVR, or external number)." }, "calls-abandoned-count": { "type": "integer", "description": "Number of calls that abandoned the queue before being answered by an agent. " }, "calls-abandoned-adjusted-count": { "type": "integer", "description": "Adjusted number of calls that abandoned the queue. Excludes calls abandoned in less than 10 seconds. " }, "calls-abandoned-rate": { "type": "number", "description": "Percentage of calls offered that were abandoned before being offered to an agent. " }, "calls-abandoned-adjusted-rate": { "type": "number", "description": "Percentage of calls offered that were abandoned in under 10 seconds. " }, "calls-handling-avg-duration-minutes": { "type": "number", "description": "Average time an agent spent on a call. Includes Talk Time (TT), Hold Time (AH), and Disposition Time (ACW)." }, "calls-queueing-avg-duration-seconds": { "type": "number", "description": "Average number of seconds a caller spent in the selected queue before being dispatched to an agent. If none selected, total for all queues will be displayed." }, "sms-conversations-count": { "type": "integer", "description": "Number of SMS sessions handled through a Call Queue." }, "sms-handling-avg-duration-seconds": { "type": "number", "description": "Average time an agent spent handling an SMS session from the queue, starting from the moment they accept the message until it is terminated." }, "name": { "type": "string", "description": "Name" } } }, "example": { "421": { "name": "Call queue1", "calls-total-count": 155, "calls-answered-count": 87, "calls-presented-count": 155, "calls-presented-adjusted-count": 151, "calls-voicemailed-count": 6, "calls-forwarded-count": 22, "calls-talking-avg-duration-minutes": 0.26, "calls-assisted-count": 29, "calls-after-call-work-avg-duration-seconds": 0, "calls-callback-requests-count": 18, "calls-holding-avg-duration-seconds": 0.55, "calls-service-level-percent": 81.29, "calls-presented-percent": 21.94, "calls-abandoned-count": 11, "calls-abandoned-adjusted-count": 0, "calls-queueing-avg-duration-seconds": 11.88, "calls-abandoned-rate": 7.1, "calls-abandoned-adjusted-rate": 5.3, "calls-handling-avg-duration-minutes": 0.27, "queue-sms-conversations-count": 0, "queue-sms-handling-avg-duration-seconds": 0 }, "422": { "name": "Call Queue2", "calls-total-count": 98, "calls-answered-count": 62, "calls-presented-count": 96, "calls-presented-adjusted-count": 92, "calls-voicemailed-count": 1, "calls-forwarded-count": 3, "calls-talking-avg-duration-minutes": 0.33, "calls-assisted-count": 5, "calls-after-call-work-avg-duration-seconds": 0.27, "calls-callback-requests-count": 21, "calls-holding-avg-duration-seconds": 0.52, "calls-service-level-percent": 73.96, "calls-presented-percent": 14.58, "calls-abandoned-count": 20, "calls-abandoned-adjusted-count": 0, "calls-queueing-avg-duration-seconds": 10.52, "calls-abandoned-rate": 20.83, "calls-abandoned-adjusted-rate": 15.22, "calls-handling-avg-duration-minutes": 0.6, "queue-sms-conversations-count": 0, "queue-sms-handling-avg-duration-seconds": 0 } } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 0, "message": "string" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 0, "message": "string" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 0, "message": "string" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/statistics/agent": { "get": { "summary": "Get Agent Statistics for all Queues by Agent", "deprecated": false, "description": "", "tags": [ "Call Center/Statistics", "44.3" ], "parameters": [ { "name": "domain", "in": "path", "description": "This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. ", "required": true, "example": "example.com", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "datetime-start", "in": "query", "description": "This is the start of the time window for a given query. The format is based on RFC3339 but also will support additonal params for use in providing a timezone which will allow the API to give the correct range for a given set of data and will be formated in respone using the same format.\n\nSupported formats include.\n\n2023-11-27 13:00:00\n2023-11-27T13:00:00Z\n2023-11-27T13:00:00-08:00\n2023-11-27T13:00:00-08:00[US/Pacific]\n2023-11-27T13:00:00Z[America/Phoenix]", "required": true, "example": "2023-11-27T13:00:00Z[US/Pacific]", "schema": { "$ref": "#/components/schemas/DatetimeStart" } }, { "name": "datetime-end", "in": "query", "description": "This is the end of the time window for a given query. The format is based on RFC3339 but also will support additonal params for use in providing a timezone which will allow the API to give the correct range for a given set of data and will be formated in respone using the same format. Allowed values same as datetime-start.", "required": true, "example": "2023-11-27T14:00:00Z[US/Pacific]", "schema": { "$ref": "#/components/schemas/DatetimeEnd" } }, { "name": "fields", "in": "query", "description": "Fields in order to fill and get particular statistics for. Separate multiple fields with \",\" Default value is NAME,CH,ATT,AH,AHT,TT", "required": false, "example": "NAME,CH,ATT,AH,AHT,TT", "schema": { "type": "string" } }, { "name": "department", "in": "query", "description": "This is the depertment that queue belongs to in the domain.", "required": false, "example": "support", "schema": { "type": "string" } }, { "name": "remove_zeros", "in": "query", "description": "Remove zeros from the results", "required": false, "example": "true", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "calls-answered-count": { "type": "integer", "description": "Number of calls answered by agent originating through a Call Queue. The call must also terminate with the agent to be counted as a call handled." }, "calls-talking-avg-duration-minutes": { "type": "number", "description": "Average number of minutes spent by agent talking per call, on calls originating through a Call Queue. Excludes hold time." }, "calls-assisted-count": { "type": "integer", "description": "Number of calls answered and then transferred to another agent. " }, "calls-after-call-work-avg-duration-seconds": { "type": "integer", "description": "Average time an agent spends between the end of a call and submitting call disposition.\n\nThis metric is only applied to agents using Single Call Mode." }, "calls-holding-avg-duration-seconds": { "type": "number", "description": "Average time a caller spends on hold with an agent. Excludes waiting time in the Call Queue." }, "calls-handling-avg-duration-minutes": { "type": "number", "description": "Average time an agent spent on a call. Includes Talk Time (TT), Hold Time (AH), and Disposition Time (ACW)." }, "outbound-calls-attempted-count": { "type": "integer", "description": "Number of outbound call attempts by an agent. Excludes on-net calls and conference calls." }, "outbound-calls-answered-count": { "type": "integer", "description": "Number of outbound calls by agent answered by a remote party. Includes calls answered by voicemail. Excludes on-net calls and conference calls." }, "outbound-calls-duration-minutes": { "type": "number", "description": "Number of minutes spent by an agent on outbound calls. Includes talk and hold time. Excludes call center calls, on-net calls, and conference calls." }, "outbound-calls-avg-duration-minutes": { "type": "number", "description": "Average length of time spent by an agent on outbound calls. Excludes call center calls, on-net calls, and conference calls." }, "inbound-calls-presented-count": { "type": "integer", "description": "Number of attempted calls inbound to agent. Includes call center calls. Excludes on-net calls and conference calls." }, "inbound-calls-answered-count": { "type": "integer", "description": "Number of inbound answered calls to an agent. Includes call center calls. Excludes on-net calls and conference calls." }, "inbound-calls-duration-minutes": { "type": "number", "description": "Number of minutes spent by an agent on inbound calls. Includes call center calls. Includes talk and hold time. Excludes on-net calls and conference calls." }, "inbound-calls-avg-duration-minutes": { "type": "number", "description": "Average length of time spent by an agent on inbound calls. Includes call center calls. Excludes on-net calls and conference calls." }, "name": { "type": "string", "description": "Name" }, "calls-talking-duration-minutes": { "type": "number", "description": "The number of minutes spent by an agent on answered calls originating through a Call Queue." }, "calls-unanswered-count": { "type": "integer", "description": "Number of calls originating through a call queue offered to an agent but not answered. This includes multiple attempts if a call loops through all agents, but excludes unanswered simultaneous ring calls." } } }, "example": { "221": { "name": "Agent 1", "calls-answered-count": 31, "calls-talking-duration-minutes": 6.85, "calls-talking-avg-duration-minutes": 0.16, "calls-assisted-count": 13, "calls-after-call-work-avg-duration-seconds": 0, "calls-holding-avg-duration-seconds": 0.25, "calls-handling-avg-duration-minutes": 0.16, "calls-unanswered-count": 10, "inbound-calls-presented-count": 132, "inbound-calls-answered-count": 90, "inbound-calls-duration-minutes": 1037, "inbound-calls-avg-duration-minutes": 97.5, "outbound-calls-attempted-count": 16, "outbound-calls-answered-count": 10, "outbound-calls-duration-minutes": 44, "outbound-calls-avg-duration-minutes": 17 }, "222": { "name": "Agent 2", "calls-answered-count": 74, "calls-talking-duration-minutes": 22.85, "calls-talking-avg-duration-minutes": 0.3, "calls-assisted-count": 2, "calls-after-call-work-avg-duration-seconds": 0.21, "calls-holding-avg-duration-seconds": 0.64, "calls-handling-avg-duration-minutes": 0.52, "calls-unanswered-count": 13, "inbound-calls-presented-count": 137, "inbound-calls-answered-count": 93, "inbound-calls-duration-minutes": 1668, "inbound-calls-avg-duration-minutes": 166.67, "outbound-calls-attempted-count": 57, "outbound-calls-answered-count": 40, "outbound-calls-duration-minutes": 613, "outbound-calls-avg-duration-minutes": 79.89 }, "223": { "name": "Agent 3", "calls-answered-count": 47, "calls-talking-duration-minutes": 21.98, "calls-talking-avg-duration-minutes": 0.34, "calls-assisted-count": 17, "calls-after-call-work-avg-duration-seconds": 0.04, "calls-holding-avg-duration-seconds": 0.77, "calls-handling-avg-duration-minutes": 0.39, "calls-unanswered-count": 8, "inbound-calls-presented-count": 125, "inbound-calls-answered-count": 88, "inbound-calls-duration-minutes": 2061, "inbound-calls-avg-duration-minutes": 180.61, "outbound-calls-attempted-count": 10, "outbound-calls-answered-count": 10, "outbound-calls-duration-minutes": 377, "outbound-calls-avg-duration-minutes": 175.08 }, "226": { "name": "Agent 4", "calls-answered-count": 2, "calls-talking-duration-minutes": 2.28, "calls-talking-avg-duration-minutes": 0.33, "calls-assisted-count": 5, "calls-after-call-work-avg-duration-seconds": 0, "calls-holding-avg-duration-seconds": 0.14, "calls-handling-avg-duration-minutes": 0.33, "calls-unanswered-count": 6, "inbound-calls-presented-count": 22, "inbound-calls-answered-count": 15, "inbound-calls-duration-minutes": 226, "inbound-calls-avg-duration-minutes": 46.61, "outbound-calls-attempted-count": 1, "outbound-calls-answered-count": 1, "outbound-calls-duration-minutes": 10, "outbound-calls-avg-duration-minutes": 10 } } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 0, "message": "string" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 0, "message": "string" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 0, "message": "string" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/statistics/agent/callqueues/{callqueue}": { "get": { "summary": "Get Agent Statistics for Single Queues by Agent", "deprecated": false, "description": "", "tags": [ "Call Center/Statistics", "44.3" ], "parameters": [ { "name": "domain", "in": "path", "description": "This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. ", "required": true, "example": "example.com", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "callqueue", "in": "path", "description": "When used in path the callqueue value will link to a extension id for a preconfigured callqueue", "required": true, "example": "421", "schema": { "$ref": "#/components/schemas/CallqueuePath" } }, { "name": "datetime-start", "in": "query", "description": "This is the start of the time window for a given query. The format is based on RFC3339 but also will support additonal params for use in providing a timezone which will allow the API to give the correct range for a given set of data and will be formated in respone using the same format.\n\nSupported formats include.\n\n2023-11-27 13:00:00\n2023-11-27T13:00:00Z\n2023-11-27T13:00:00-08:00\n2023-11-27T13:00:00-08:00[US/Pacific]\n2023-11-27T13:00:00Z[America/Phoenix]", "required": true, "example": "2023-11-27T13:00:00Z[US/Pacific]", "schema": { "$ref": "#/components/schemas/DatetimeStart" } }, { "name": "datetime-end", "in": "query", "description": "This is the end of the time window for a given query. The format is based on RFC3339 but also will support additonal params for use in providing a timezone which will allow the API to give the correct range for a given set of data and will be formated in respone using the same format. Allowed values same as datetime-start.", "required": true, "example": "2023-11-27T14:00:00Z[US/Pacific]", "schema": { "$ref": "#/components/schemas/DatetimeEnd" } }, { "name": "fields", "in": "query", "description": "Fields in order to fill and get particular statistics for. Separate multiple fields with \",\" Default value is NAME,CH,ATT,AH,AHT,TT", "required": false, "example": "NAME,CH,ATT,AH,AHT,TT", "schema": { "type": "string" } }, { "name": "remove_zeros", "in": "query", "description": "Remove zeros from the results", "required": false, "example": "true", "schema": { "type": "string" } }, { "name": "department", "in": "query", "description": "This is the depertment that user belongs to in the domain. Can be any string to group users, a department is not require to be setup before in order to set it for a user.", "required": false, "example": "support", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "calls-answered-count": { "type": "integer", "description": "Number of calls answered by agent originating through a Call Queue. The call must also terminate with the agent to be counted as a call handled." }, "calls-talking-avg-duration-minutes": { "type": "number", "description": "Average number of minutes spent by agent talking per call, on calls originating through a Call Queue. Excludes hold time." }, "calls-assisted-count": { "type": "integer", "description": "Number of calls answered and then transferred to another agent. " }, "calls-after-call-work-avg-duration-seconds": { "type": "integer", "description": "Average time an agent spends between the end of a call and submitting call disposition.\n\nThis metric is only applied to agents using Single Call Mode." }, "calls-holding-avg-duration-seconds": { "type": "number", "description": "Average time a caller spends on hold with an agent. Excludes waiting time in the Call Queue." }, "calls-handling-avg-duration-minutes": { "type": "number", "description": "Average time an agent spent on a call. Includes Talk Time (TT), Hold Time (AH), and Disposition Time (ACW)." }, "outbound-calls-attempted-count": { "type": "integer", "description": "Number of outbound call attempts by an agent. Excludes on-net calls and conference calls." }, "outbound-calls-answered-count": { "type": "integer", "description": "Number of outbound calls by agent answered by a remote party. Includes calls answered by voicemail. Excludes on-net calls and conference calls." }, "outbound-calls-duration-minutes": { "type": "number", "description": "Number of minutes spent by an agent on outbound calls. Includes talk and hold time. Excludes call center calls, on-net calls, and conference calls." }, "outbound-calls-avg-duration-minutes": { "type": "number", "description": "Average length of time spent by an agent on outbound calls. Excludes call center calls, on-net calls, and conference calls." }, "inbound-calls-presented-count": { "type": "integer", "description": "Number of attempted calls inbound to agent. Includes call center calls. Excludes on-net calls and conference calls." }, "inbound-calls-answered-count": { "type": "integer", "description": "Number of inbound answered calls to an agent. Includes call center calls. Excludes on-net calls and conference calls." }, "inbound-calls-duration-minutes": { "type": "number", "description": "Number of minutes spent by an agent on inbound calls. Includes call center calls. Includes talk and hold time. Excludes on-net calls and conference calls." }, "inbound-calls-avg-duration-minutes": { "type": "number", "description": "Average length of time spent by an agent on inbound calls. Includes call center calls. Excludes on-net calls and conference calls." }, "name": { "type": "string", "description": "Name" }, "calls-talking-duration-minutes": { "type": "number", "description": "The number of minutes spent by an agent on answered calls originating through a Call Queue." }, "calls-unanswered-count": { "type": "integer", "description": "Number of calls originating through a call queue offered to an agent but not answered. This includes multiple attempts if a call loops through all agents, but excludes unanswered simultaneous ring calls." } } }, "example": { "221": { "calls-answered-count": 16, "calls-talking-duration-minutes": 4.38, "calls-talking-avg-duration-minutes": 0.16, "calls-assisted-count": 12, "calls-after-call-work-avg-duration-seconds": 0, "calls-holding-avg-duration-seconds": 0.39, "calls-handling-avg-duration-minutes": 0.16, "calls-unanswered-count": 9, "outbound-calls-attempted-count": 16, "outbound-calls-answered-count": 10, "outbound-calls-duration-minutes": 44, "outbound-calls-avg-duration-minutes": 17, "inbound-calls-presented-count": 132, "inbound-calls-answered-count": 90, "inbound-calls-duration-minutes": 1037, "inbound-calls-avg-duration-minutes": 97.5 }, "222": { "calls-answered-count": 53, "calls-talking-duration-minutes": 15.28, "calls-talking-avg-duration-minutes": 0.28, "calls-assisted-count": 1, "calls-after-call-work-avg-duration-seconds": 0, "calls-holding-avg-duration-seconds": 0.3, "calls-handling-avg-duration-minutes": 0.29, "calls-unanswered-count": 6, "outbound-calls-attempted-count": 57, "outbound-calls-answered-count": 40, "outbound-calls-duration-minutes": 613, "outbound-calls-avg-duration-minutes": 79.89, "inbound-calls-presented-count": 137, "inbound-calls-answered-count": 93, "inbound-calls-duration-minutes": 1668, "inbound-calls-avg-duration-minutes": 166.67 }, "223": { "calls-answered-count": 16, "calls-talking-duration-minutes": 8.72, "calls-talking-avg-duration-minutes": 0.32, "calls-assisted-count": 11, "calls-after-call-work-avg-duration-seconds": 0, "calls-holding-avg-duration-seconds": 1.3, "calls-handling-avg-duration-minutes": 0.34, "calls-unanswered-count": 1, "outbound-calls-attempted-count": 10, "outbound-calls-answered-count": 10, "outbound-calls-duration-minutes": 377, "outbound-calls-avg-duration-minutes": 175.08, "inbound-calls-presented-count": 126, "inbound-calls-answered-count": 89, "inbound-calls-duration-minutes": 2088, "inbound-calls-avg-duration-minutes": 207.61 }, "226": { "calls-answered-count": 1, "calls-talking-duration-minutes": 2.2, "calls-talking-avg-duration-minutes": 0.37, "calls-assisted-count": 5, "calls-after-call-work-avg-duration-seconds": 0, "calls-holding-avg-duration-seconds": 0.17, "calls-handling-avg-duration-minutes": 0.37, "calls-unanswered-count": 6, "outbound-calls-attempted-count": 1, "outbound-calls-answered-count": 1, "outbound-calls-duration-minutes": 10, "outbound-calls-avg-duration-minutes": 10, "inbound-calls-presented-count": 22, "inbound-calls-answered-count": 15, "inbound-calls-duration-minutes": 226, "inbound-calls-avg-duration-minutes": 46.61 } } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 0, "message": "string" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 0, "message": "string" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 0, "message": "string" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/statistics/agent/{agent}": { "get": { "summary": "Get Agent Statistics for Single Agent", "deprecated": false, "description": "", "tags": [ "Call Center/Statistics", "hidetemp" ], "parameters": [ { "name": "domain", "in": "path", "description": "This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. ", "required": true, "example": "example.com", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "agent", "in": "path", "description": "When used in path the agent value will link to a extension id for a call center agent.", "required": true, "example": "4502", "schema": { "type": "string" } }, { "name": "datetime-start", "in": "query", "description": "This is the start of the time window for a given query. The format is based on RFC3339 but also will support additonal params for use in providing a timezone which will allow the API to give the correct range for a given set of data and will be formated in respone using the same format.\n\nSupported formats include.\n\n2023-11-27 13:00:00\n2023-11-27T13:00:00Z\n2023-11-27T13:00:00-08:00\n2023-11-27T13:00:00-08:00[US/Pacific]\n2023-11-27T13:00:00Z[America/Phoenix]", "required": true, "example": "2023-11-27T13:00:00Z[US/Pacific]", "schema": { "$ref": "#/components/schemas/DatetimeStart" } }, { "name": "datetime-end", "in": "query", "description": "This is the end of the time window for a given query. The format is based on RFC3339 but also will support additonal params for use in providing a timezone which will allow the API to give the correct range for a given set of data and will be formated in respone using the same format. Allowed values same as datetime-start.", "required": true, "example": "2023-11-27T14:00:00Z[US/Pacific]", "schema": { "$ref": "#/components/schemas/DatetimeEnd" } }, { "name": "fields", "in": "query", "description": "Fields in order to fill and get particular statistics for. Separate multiple fields with \",\" Default value is NAME,CH,ATT,AH,AHT,TT", "required": false, "example": "NAME,CH,ATT,AH,AHT,TT", "schema": { "type": "string" } }, { "name": "remove_zeros", "in": "query", "description": "Remove zeros from the results", "required": false, "example": "true", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "calls-answered-count": { "type": "integer", "description": "Number of calls answered by agent originating through a Call Queue. The call must also terminate with the agent to be counted as a call handled." }, "calls-talking-avg-duration-minutes": { "type": "number", "description": "Average number of minutes spent by agent talking per call, on calls originating through a Call Queue. Excludes hold time." }, "calls-assisted-count": { "type": "integer", "description": "Number of calls answered and then transferred to another agent. " }, "calls-after-call-work-avg-duration-seconds": { "type": "integer", "description": "Average time an agent spends between the end of a call and submitting call disposition.\n\nThis metric is only applied to agents using Single Call Mode." }, "calls-holding-avg-duration-seconds": { "type": "number", "description": "Average time a caller spends on hold with an agent. Excludes waiting time in the Call Queue." }, "calls-handling-avg-duration-minutes": { "type": "number", "description": "Average time an agent spent on a call. Includes Talk Time (TT), Hold Time (AH), and Disposition Time (ACW)." }, "outbound-calls-attempted-count": { "type": "integer", "description": "Number of outbound call attempts by an agent. Excludes on-net calls and conference calls." }, "outbound-calls-answered-count": { "type": "integer", "description": "Number of outbound calls by agent answered by a remote party. Includes calls answered by voicemail. Excludes on-net calls and conference calls." }, "outbound-calls-duration-minutes": { "type": "number", "description": "Number of minutes spent by an agent on outbound calls. Includes talk and hold time. Excludes call center calls, on-net calls, and conference calls." }, "outbound-calls-avg-duration-minutes": { "type": "number", "description": "Average length of time spent by an agent on outbound calls. Excludes call center calls, on-net calls, and conference calls." }, "inbound-calls-presented-count": { "type": "integer", "description": "Number of attempted calls inbound to agent. Includes call center calls. Excludes on-net calls and conference calls." }, "inbound-calls-answered-count": { "type": "integer", "description": "Number of inbound answered calls to an agent. Includes call center calls. Excludes on-net calls and conference calls." }, "inbound-calls-duration-minutes": { "type": "number", "description": "Number of minutes spent by an agent on inbound calls. Includes call center calls. Includes talk and hold time. Excludes on-net calls and conference calls." }, "inbound-calls-avg-duration-minutes": { "type": "number", "description": "Average length of time spent by an agent on inbound calls. Includes call center calls. Excludes on-net calls and conference calls." }, "name": { "type": "string", "description": "Name" }, "calls-talking-duration-minutes": { "type": "number", "description": "The number of minutes spent by an agent on answered calls originating through a Call Queue." }, "calls-unanswered-count": { "type": "integer", "description": "Number of calls originating through a call queue offered to an agent but not answered. This includes multiple attempts if a call loops through all agents, but excludes unanswered simultaneous ring calls." } } }, "example": { "name": "CC Agent", "calls-answered-count": 74, "calls-talking-duration-minutes": 22.85, "calls-talking-avg-duration-minutes": 0.3, "calls-assisted-count": 2, "calls-after-call-work-avg-duration-seconds": 0.21, "calls-holding-avg-duration-seconds": 0.64, "calls-handling-avg-duration-minutes": 0.52, "calls-unanswered-count": 13, "outbound-calls-attempted-count": 57, "outbound-calls-answered-count": 40, "outbound-calls-duration-minutes": 613, "outbound-calls-avg-duration-minutes": 79.89, "inbound-calls-presented-count": 137, "inbound-calls-answered-count": 93, "inbound-calls-duration-minutes": 1668, "inbound-calls-avg-duration-minutes": 166.67 } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 0, "message": "string" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 0, "message": "string" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 0, "message": "string" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/statistics/DNIS": { "get": { "summary": "Get DNIS Statistics for all Queues", "deprecated": false, "description": "", "tags": [ "Call Center/Statistics" ], "parameters": [ { "name": "domain", "in": "path", "description": "This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. ", "required": true, "example": "example.com", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "datetime-start", "in": "query", "description": "This is the start of the time window for a given query. The format is based on RFC3339 but also will support additonal params for use in providing a timezone which will allow the API to give the correct range for a given set of data and will be formated in respone using the same format.\n\nSupported formats include.\n\n2023-11-27 13:00:00\n2023-11-27T13:00:00Z\n2023-11-27T13:00:00-08:00\n2023-11-27T13:00:00-08:00[US/Pacific]\n2023-11-27T13:00:00Z[America/Phoenix]", "required": true, "example": "2023-11-27T13:00:00Z[US/Pacific]", "schema": { "$ref": "#/components/schemas/DatetimeStart" } }, { "name": "datetime-end", "in": "query", "description": "This is the end of the time window for a given query. The format is based on RFC3339 but also will support additonal params for use in providing a timezone which will allow the API to give the correct range for a given set of data and will be formated in respone using the same format. Allowed values same as datetime-start.", "required": true, "example": "2023-11-27T14:00:00Z[US/Pacific]", "schema": { "$ref": "#/components/schemas/DatetimeEnd" } }, { "name": "fields", "in": "query", "description": "Fields in order to fill and get particular statistics for. Separate multiple fields with \",\". Default value is NAME,VOL,CH,ATT,AH", "required": false, "example": "NAME,VOL,CH,ATT,AH", "schema": { "type": "string" } }, { "name": "remove_zeros", "in": "query", "description": "Remove zeros from the results", "required": false, "example": "true", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "calls-total-count": { "type": "integer", "description": "Number of calls originating through a Call Queue. Includes answered calls, abandoned calls, forwards, and voicemail." }, "calls-answered-count": { "type": "integer", "description": "Number of calls answered by agent originating through a Call Queue. The call must also terminate with the agent to be counted as a call handled." }, "calls-presented-count": { "type": "integer", "description": "Number of calls that reached the queue to be dispatched to agents. Includes abandoned calls. Excludes forwards and voicemail." }, "calls-presented-adjusted-count": { "type": "integer", "description": "Adjusted number of calls that reached the queue. Excludes calls abandoned in less than 10 seconds." }, "calls-voicemailed-count": { "type": "integer", "description": "Number of calls handled by the automated voicemail system." }, "calls-forwarded-count": { "type": "integer", "description": "Number of calls forwarded to another queue or off-net phone number for handling. Includes forwarded calls to voicemail." }, "calls-talking-avg-duration-minutes": { "type": "number", "description": "Average number of minutes spent by agent talking per call, on calls originating through a Call Queue. Excludes hold time." }, "calls-assisted-count": { "type": "integer", "description": "Number of calls answered and then transferred to another agent. " }, "calls-after-call-work-avg-duration-seconds": { "type": "integer", "description": "Average time an agent spends between the end of a call and submitting call disposition.\n\nThis metric is only applied to agents using Single Call Mode." }, "calls-callback-requests-count": { "type": "integer", "description": "Number of calls that requested a callback rather than waiting in the queue. " }, "calls-holding-avg-duration-seconds": { "type": "number", "description": "Average time a caller spends on hold with an agent. Excludes waiting time in the Call Queue." }, "calls-service-level-percent": { "type": "number", "description": "The ratio of calls meeting the configurable service level agreement. " }, "calls-presented-percent": { "type": "number", "description": "The percentage of handled calls that an agent transferred to any destination (including another user/agent, supervisor, queue, IVR, or external number)." }, "calls-abandoned-count": { "type": "integer", "description": "Number of calls that abandoned the queue before being answered by an agent. " }, "calls-abandoned-adjusted-count": { "type": "integer", "description": "Adjusted number of calls that abandoned the queue. Excludes calls abandoned in less than 10 seconds. " }, "calls-abandoned-rate": { "type": "number", "description": "Percentage of calls offered that were abandoned before being offered to an agent. " }, "calls-abandoned-adjusted-rate": { "type": "number", "description": "Percentage of calls offered that were abandoned in under 10 seconds. " }, "calls-handling-avg-duration-minutes": { "type": "number", "description": "Average time an agent spent on a call. Includes Talk Time (TT), Hold Time (AH), and Disposition Time (ACW)." }, "calls-queueing-avg-duration-seconds": { "type": "number", "description": "Average number of seconds a caller spent in the selected queue before being dispatched to an agent. If none selected, total for all queues will be displayed." }, "sms-conversations-count": { "type": "integer", "description": "Number of SMS sessions handled through a Call Queue." }, "sms-handling-avg-duration-seconds": { "type": "number", "description": "Average time an agent spent handling an SMS session from the queue, starting from the moment they accept the message until it is terminated." } } }, "example": { "14379000000": { "calls-total-count": 138, "calls-answered-count": 89, "calls-presented-count": 138, "calls-presented-adjusted-count": 136, "calls-voicemailed-count": 3, "calls-forwarded-count": 20, "calls-talking-avg-duration-minutes": 0.24, "calls-assisted-count": 19, "calls-after-call-work-avg-duration-seconds": 0, "calls-callback-requests-count": 13, "calls-holding-avg-duration-seconds": 0.41, "calls-service-level-percent": 82.6086956521739, "calls-presented-percent": 19.565217391304348, "calls-abandoned-count": 7, "calls-abandoned-adjusted-count": 6, "calls-abandoned-rate": 5.072463768115942, "calls-abandoned-adjusted-rate": 4.411764705882353, "calls-handling-avg-duration-minutes": 0.25, "calls-queueing-avg-duration-seconds": 11.24, "queue-sms-conversations-count": 0, "queue-sms-handling-avg-duration-seconds": 0 }, "14379000001": { "calls-total-count": 8, "calls-answered-count": 3, "calls-presented-count": 8, "calls-presented-adjusted-count": 7, "calls-voicemailed-count": 1, "calls-forwarded-count": 0, "calls-talking-avg-duration-minutes": 0.2, "calls-assisted-count": 1, "calls-after-call-work-avg-duration-seconds": 0, "calls-callback-requests-count": 1, "calls-holding-avg-duration-seconds": 0, "calls-service-level-percent": 62.5, "calls-presented-percent": 12.5, "calls-abandoned-count": 3, "calls-abandoned-adjusted-count": 2, "calls-abandoned-rate": 37.5, "calls-abandoned-adjusted-rate": 28.57142857142857, "calls-handling-avg-duration-minutes": 0.2, "calls-queueing-avg-duration-seconds": 7, "queue-sms-conversations-count": 0, "queue-sms-handling-avg-duration-seconds": 0 }, "14379000002": { "calls-total-count": 21, "calls-answered-count": 8, "calls-presented-count": 21, "calls-presented-adjusted-count": 20, "calls-voicemailed-count": 3, "calls-forwarded-count": 1, "calls-talking-avg-duration-minutes": 0.41, "calls-assisted-count": 6, "calls-after-call-work-avg-duration-seconds": 0.02, "calls-callback-requests-count": 0, "calls-holding-avg-duration-seconds": 0.64, "calls-service-level-percent": 76.19047619047619, "calls-presented-percent": 0, "calls-abandoned-count": 3, "calls-abandoned-adjusted-count": 2, "calls-abandoned-rate": 14.285714285714285, "calls-abandoned-adjusted-rate": 10, "calls-handling-avg-duration-minutes": 0.44, "calls-queueing-avg-duration-seconds": 5.67, "queue-sms-conversations-count": 0, "queue-sms-handling-avg-duration-seconds": 0 } } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 0, "message": "string" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 0, "message": "string" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 0, "message": "string" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/statistics/DNIS/callqueues/{callqueue}": { "get": { "summary": "Get DNIS Statistics for Single Queue", "deprecated": false, "description": "", "tags": [ "Call Center/Statistics" ], "parameters": [ { "name": "domain", "in": "path", "description": "This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. ", "required": true, "example": "example.com", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "callqueue", "in": "path", "description": "When used in path the callqueue value will link to a extension id for a preconfigured callqueue", "required": true, "example": "421", "schema": { "$ref": "#/components/schemas/CallqueuePath" } }, { "name": "datetime-start", "in": "query", "description": "This is the start of the time window for a given query. The format is based on RFC3339 but also will support additonal params for use in providing a timezone which will allow the API to give the correct range for a given set of data and will be formated in respone using the same format.\n\nSupported formats include.\n\n2023-11-27 13:00:00\n2023-11-27T13:00:00Z\n2023-11-27T13:00:00-08:00\n2023-11-27T13:00:00-08:00[US/Pacific]\n2023-11-27T13:00:00Z[America/Phoenix]", "required": true, "example": "2023-11-27T13:00:00Z[US/Pacific]", "schema": { "$ref": "#/components/schemas/DatetimeStart" } }, { "name": "datetime-end", "in": "query", "description": "This is the end of the time window for a given query. The format is based on RFC3339 but also will support additonal params for use in providing a timezone which will allow the API to give the correct range for a given set of data and will be formated in respone using the same format. Allowed values same as datetime-start.", "required": true, "example": "2023-11-27T14:00:00Z[US/Pacific]", "schema": { "$ref": "#/components/schemas/DatetimeEnd" } }, { "name": "fields", "in": "query", "description": "Fields in order to fill and get particular statistics for. Separate multiple fields with \",\". Default value is NAME,VOL,CH,ATT,AH", "required": false, "example": "NAME,VOL,CH,ATT,AH", "schema": { "type": "string" } }, { "name": "remove_zeros", "in": "query", "description": "Remove zeros from the results", "required": false, "example": "true", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "calls-total-count": { "type": "integer", "description": "Number of calls originating through a Call Queue. Includes answered calls, abandoned calls, forwards, and voicemail." }, "calls-answered-count": { "type": "integer", "description": "Number of calls answered by agent originating through a Call Queue. The call must also terminate with the agent to be counted as a call handled." }, "calls-presented-count": { "type": "integer", "description": "Number of calls that reached the queue to be dispatched to agents. Includes abandoned calls. Excludes forwards and voicemail." }, "calls-presented-adjusted-count": { "type": "integer", "description": "Adjusted number of calls that reached the queue. Excludes calls abandoned in less than 10 seconds." }, "calls-voicemailed-count": { "type": "integer", "description": "Number of calls handled by the automated voicemail system." }, "calls-forwarded-count": { "type": "integer", "description": "Number of calls forwarded to another queue or off-net phone number for handling. Includes forwarded calls to voicemail." }, "calls-talking-avg-duration-minutes": { "type": "number", "description": "Average number of minutes spent by agent talking per call, on calls originating through a Call Queue. Excludes hold time." }, "calls-assisted-count": { "type": "integer", "description": "Number of calls answered and then transferred to another agent. " }, "calls-after-call-work-avg-duration-seconds": { "type": "integer", "description": "Average time an agent spends between the end of a call and submitting call disposition.\n\nThis metric is only applied to agents using Single Call Mode." }, "calls-callback-requests-count": { "type": "integer", "description": "Number of calls that requested a callback rather than waiting in the queue. " }, "calls-holding-avg-duration-seconds": { "type": "number", "description": "Average time a caller spends on hold with an agent. Excludes waiting time in the Call Queue." }, "calls-service-level-percent": { "type": "number", "description": "The ratio of calls meeting the configurable service level agreement. " }, "calls-presented-percent": { "type": "number", "description": "The percentage of handled calls that an agent transferred to any destination (including another user/agent, supervisor, queue, IVR, or external number)." }, "calls-abandoned-count": { "type": "integer", "description": "Number of calls that abandoned the queue before being answered by an agent. " }, "calls-abandoned-adjusted-count": { "type": "integer", "description": "Adjusted number of calls that abandoned the queue. Excludes calls abandoned in less than 10 seconds. " }, "calls-abandoned-rate": { "type": "number", "description": "Percentage of calls offered that were abandoned before being offered to an agent. " }, "calls-abandoned-adjusted-rate": { "type": "number", "description": "Percentage of calls offered that were abandoned in under 10 seconds. " }, "calls-handling-avg-duration-minutes": { "type": "number", "description": "Average time an agent spent on a call. Includes Talk Time (TT), Hold Time (AH), and Disposition Time (ACW)." }, "calls-queueing-avg-duration-seconds": { "type": "number", "description": "Average number of seconds a caller spent in the selected queue before being dispatched to an agent. If none selected, total for all queues will be displayed." }, "sms-conversations-count": { "type": "integer", "description": "Number of SMS sessions handled through a Call Queue." }, "sms-handling-avg-duration-seconds": { "type": "number", "description": "Average time an agent spent handling an SMS session from the queue, starting from the moment they accept the message until it is terminated." } } }, "example": { "14379000000": { "calls-total-count": 138, "calls-answered-count": 89, "calls-presented-count": 138, "calls-presented-adjusted-count": 136, "calls-voicemailed-count": 3, "calls-forwarded-count": 20, "calls-talking-avg-duration-minutes": 0.24, "calls-assisted-count": 19, "calls-after-call-work-avg-duration-seconds": 0, "calls-callback-requests-count": 13, "calls-holding-avg-duration-seconds": 0.41, "calls-service-level-percent": 82.6086956521739, "calls-presented-percent": 19.565217391304348, "calls-abandoned-count": 7, "calls-abandoned-adjusted-count": 6, "calls-abandoned-rate": 5.072463768115942, "calls-abandoned-adjusted-rate": 4.411764705882353, "calls-handling-avg-duration-minutes": 0.25, "calls-queueing-avg-duration-seconds": 11.24, "queue-sms-conversations-count": 0, "queue-sms-handling-avg-duration-seconds": 0 }, "14379000001": { "calls-total-count": 8, "calls-answered-count": 3, "calls-presented-count": 8, "calls-presented-adjusted-count": 7, "calls-voicemailed-count": 1, "calls-forwarded-count": 0, "calls-talking-avg-duration-minutes": 0.2, "calls-assisted-count": 1, "calls-after-call-work-avg-duration-seconds": 0, "calls-callback-requests-count": 1, "calls-holding-avg-duration-seconds": 0, "calls-service-level-percent": 62.5, "calls-presented-percent": 12.5, "calls-abandoned-count": 3, "calls-abandoned-adjusted-count": 2, "calls-abandoned-rate": 37.5, "calls-abandoned-adjusted-rate": 28.57142857142857, "calls-handling-avg-duration-minutes": 0.2, "calls-queueing-avg-duration-seconds": 7, "queue-sms-conversations-count": 0, "queue-sms-handling-avg-duration-seconds": 0 }, "14379000002": { "calls-total-count": 21, "calls-answered-count": 8, "calls-presented-count": 21, "calls-presented-adjusted-count": 20, "calls-voicemailed-count": 3, "calls-forwarded-count": 1, "calls-talking-avg-duration-minutes": 0.41, "calls-assisted-count": 6, "calls-after-call-work-avg-duration-seconds": 0.02, "calls-callback-requests-count": 0, "calls-holding-avg-duration-seconds": 0.64, "calls-service-level-percent": 76.19047619047619, "calls-presented-percent": 0, "calls-abandoned-count": 3, "calls-abandoned-adjusted-count": 2, "calls-abandoned-rate": 14.285714285714285, "calls-abandoned-adjusted-rate": 10, "calls-handling-avg-duration-minutes": 0.44, "calls-queueing-avg-duration-seconds": 5.67, "queue-sms-conversations-count": 0, "queue-sms-handling-avg-duration-seconds": 0 } } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/statistics/agentLog": { "get": { "summary": "Get Agent Log", "deprecated": false, "description": "", "tags": [ "Call Center/Statistics" ], "parameters": [ { "name": "domain", "in": "path", "description": "This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise.", "required": true, "example": "example.com", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "datetime-start", "in": "query", "description": "This is the start of the time window for a given query. The format is based on RFC3339 but also will support additonal params for use in providing a timezone which will allow the API to give the correct range for a given set of data and will be formated in respone using the same format.\n\nSupported formats include.\n\n2023-11-27 13:00:00\n2023-11-27T13:00:00Z\n2023-11-27T13:00:00-08:00\n2023-11-27T13:00:00-08:00[US/Pacific]\n2023-11-27T13:00:00Z[America/Phoenix]", "required": true, "example": "2023-11-27T13:00:00Z[US/Pacific]", "schema": { "$ref": "#/components/schemas/DatetimeStart" } }, { "name": "datetime-end", "in": "query", "description": "This is the end of the time window for a given query. The format is based on RFC3339 but also will support additonal params for use in providing a timezone which will allow the API to give the correct range for a given set of data and will be formated in respone using the same format. Allowed values same as datetime-start.", "required": true, "example": "2023-11-27T14:00:00Z[US/Pacific]", "schema": { "$ref": "#/components/schemas/DatetimeEnd" } }, { "name": "fields", "in": "query", "description": "Fields in order to fill and get particular statistics for. Separate multiple fields with \",\".Default value is AM,UM,L,B. For custom status use CUST1 to CUST8.", "required": false, "example": "AM,UM,L,B", "schema": { "type": "string" } }, { "name": "remove_zeros", "in": "query", "description": "Remove zeros from the results.", "required": false, "example": "true", "schema": { "type": "string" } }, { "name": "department", "in": "query", "description": "This is the depertment that user belongs to in the domain. Can be any string to group users, a department is not require to be setup before in order to set it for a user.", "required": false, "example": "support", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "status-login-duration-minutes": { "type": "number", "description": "This is the total time the call center agent's status was set to \"online\". Starting in v43.2, an agent has to manually change their status from offline to online when they begin their shift; logging into the portal no longer affects the LI stat." }, "status-available-duration-minutes": { "type": "number", "description": "This is the total time the call center agent was available for calls. This includes time logged in / online. It excludes statuses of unavailable such as break, lunch, meeting, web, and other. " }, "status-unavailable-duration-minutes": { "type": "number", "description": "This is the total time the call center agent was not available for calls. Includes time agent has the offline statuses, such as offline, break, lunch, meeting, web, and other. Excludes online / available. " }, "status-lunch-duration-minutes": { "type": "number", "description": "This is the total time the call center agent's status was set to \"lunch\"." }, "status-break-duration-minutes": { "type": "number", "description": "This is the total time the call center agent's status was set to \"break\"." }, "status-meeting-duration-minutes": { "type": "number", "description": "This is the total time the call center agent's status was set to \"meeting\"." }, "status-other-duration-minutes": { "type": "number", "description": "This is the total time the call center agent's status is not set to available, break, lunch, meeting, or web. Excludes unavailable status." }, "status-web-duration-minutes": { "type": "number", "description": "This is the total time the call center agent's status was set to \"web\". " }, "status-custom1-duration-minutes": { "type": "number", "description": "This is the total time the call center agent's status was set to \"CUST1\". " }, "status-custom2-duration-minutes": { "type": "number", "description": "This is the total time the call center agent's status was set to \"CUST2\". " }, "status-custom3-duration-minutes": { "type": "number", "description": "This is the total time the call center agent's status was set to \"CUST3\". " }, "status-custom4-duration-minutes": { "type": "number", "description": "This is the total time the call center agent's status was set to \"CUST4\". " }, "status-custom5-duration-minutes": { "type": "number", "description": "This is the total time the call center agent's status was set to \"CUST5\". " }, "status-custom6-duration-minutes": { "type": "number", "description": "This is the total time the call center agent's status was set to \"CUST6\". " }, "status-custom7-duration-minutes": { "type": "number", "description": "This is the total time the call center agent's status was set to \"CUST7\". " }, "status-custom8-duration-minutes": { "type": "number", "description": "This is the total time the call center agent's status was set to \"CUST8\". " } } }, "example": { "221": { "status-login-duration-minutes": 464071.60003333335, "status-available-duration-minutes": 40445.125003333334, "status-unavailable-duration-minutes": 59911.55, "status-lunch-duration-minutes": 44.5, "status-break-duration-minutes": 5997.1, "status-meeting-duration-minutes": 65.3333, "status-other-duration-minutes": 0.7333, "status-web-duration-minutes": 1.2833, "status-custom1-duration-minutes": 1392.75, "status-custom2-duration-minutes": 44684.35, "status-custom3-duration-minutes": 0.2333, "status-custom4-duration-minutes": 6867.1167, "status-custom5-duration-minutes": 4, "status-custom6-duration-minutes": 0.4833, "status-custom7-duration-minutes": 2, "status-custom8-duration-minutes": 0.4333 }, "222": { "status-login-duration-minutes": 464071.60003333335, "status-available-duration-minutes": 40445.125003333334, "status-unavailable-duration-minutes": 59911.55, "status-lunch-duration-minutes": 44.5, "status-break-duration-minutes": 5997.1, "status-meeting-duration-minutes": 65.3333, "status-other-duration-minutes": 0.7333, "status-web-duration-minutes": 1.2833, "status-custom1-duration-minutes": 1392.75, "status-custom2-duration-minutes": 44684.35, "status-custom3-duration-minutes": 0.2333, "status-custom4-duration-minutes": 6867.1167, "status-custom5-duration-minutes": 4, "status-custom6-duration-minutes": 0.4833, "status-custom7-duration-minutes": 2, "status-custom8-duration-minutes": 0.4333 } } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 0, "message": "string" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 0, "message": "string" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 0, "message": "string" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/email": { "post": { "summary": "Send Email using Template", "deprecated": false, "description": "This API will send a email to a specific user usign their email address configured on the account and obtained from the domain and user provided. A example email would be a welcome email with links to setup the new account. ", "operationId": "SendEmail", "tags": [ "Email" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/UserNamePath" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailCreate" }, "example": { "template": "welcome_email.php", "subject": "New Account Setup" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/callqueuereport/abandoned": { "get": { "summary": "Get Abandoned Calls for all Queues", "deprecated": false, "description": "", "tags": [ "Call Center/Statistics" ], "parameters": [ { "name": "domain", "in": "path", "description": "This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise.", "required": true, "example": "example.com", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "datetime-start", "in": "query", "description": "This is the start of the time window for a given query. The format is based on RFC3339 but also will support additonal params for use in providing a timezone which will allow the API to give the correct range for a given set of data and will be formated in respone using the same format.\n\nSupported formats include.\n\n2023-11-27 13:00:00\n2023-11-27T13:00:00Z\n2023-11-27T13:00:00-08:00\n2023-11-27T13:00:00-08:00[US/Pacific]\n2023-11-27T13:00:00Z[America/Phoenix]", "required": true, "example": "2023-11-27T13:00:00Z[US/Pacific]", "schema": { "$ref": "#/components/schemas/DatetimeStart" } }, { "name": "datetime-end", "in": "query", "description": "This is the end of the time window for a given query. The format is based on RFC3339 but also will support additonal params for use in providing a timezone which will allow the API to give the correct range for a given set of data and will be formated in respone using the same format. Allowed values same as datetime-start.", "required": true, "example": "2023-11-27T14:00:00Z[US/Pacific]", "schema": { "$ref": "#/components/schemas/DatetimeEnd" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AbandondedCallStat" } }, "example": [ { "domain": "acme", "call-orig-call-id": "20250904195742013011-8f1338ed949ac632d4840cd552b6f381", "agent-term-uri": "sip:222@acme", "agent-term-user": 222, "agent-term-domain": "acme", "agent-name-first-name": "CC", "agent-name-last-name": "Agent", "callqueue": "421", "call-dialed-number": 14379000000, "agent-talking-duration-seconds": 0, "agent-call-duration-seconds": 0, "queue-duration-seconds": 10, "agent-holding-duration-seconds": 0, "dispatch-duration-seconds": 0, "agent-call-start-datetime": "2025-09-04T19:57:53+00:00", "queue-call-start-datetime": "2025-09-04T19:57:42+00:00", "queue-call-disconnect-datetime": "2025-09-04T19:57:53+00:00", "agent-call-disconnect-datetime": "2025-09-04T19:57:53+00:00", "agent-call-answer-datetime": "0000-00-00T00:00:00+00:00", "agent-call-disconnect-reason-text": "Abandoned", "queue-call-disconnect-reason-text": "Abandoned", "call-orig-from-name": 17055500000, "call-orig-from-user": 17055500000, "call-orig-from-uri": "sip:17055500000@sbc.acme.com" }, { "domain": "acme", "call-orig-call-id": "20250904195742013011-8f1338ed949ac632d4840cd552b6f381", "agent-term-uri": "sip:222@acme", "agent-term-user": 222, "agent-term-domain": "acme", "agent-name-first-name": "CC", "agent-name-last-name": "Agent", "callqueue": "421", "call-dialed-number": 14379000000, "agent-talking-duration-seconds": 0, "agent-call-duration-seconds": 0, "queue-duration-seconds": 10, "agent-holding-duration-seconds": 0, "dispatch-duration-seconds": 0, "agent-call-start-datetime": "2025-09-04T19:57:53+00:00", "queue-call-start-datetime": "2025-09-04T19:57:42+00:00", "queue-call-disconnect-datetime": "2025-09-04T19:57:53+00:00", "agent-call-disconnect-datetime": "2025-09-04T19:57:53+00:00", "agent-call-answer-datetime": "0000-00-00T00:00:00+00:00", "agent-call-disconnect-reason-text": "Abandoned", "queue-call-disconnect-reason-text": "Abandoned", "call-orig-from-name": 17055500000, "call-orig-from-user": 17055500000, "call-orig-from-uri": "sip:17055500000@sbc.acme.com" } ] } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 0, "message": "string" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 0, "message": "string" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 0, "message": "string" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/callqueuereport/abandoned/{callqueue}": { "get": { "summary": "Get Abandoned Calls for a Specific Queue", "deprecated": false, "description": "", "tags": [ "Call Center/Statistics" ], "parameters": [ { "name": "domain", "in": "path", "description": "This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise.", "required": true, "example": "example.com", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "callqueue", "in": "path", "description": "When used in path the callqueue value will link to a extension id for a preconfigured callqueue.", "required": true, "example": "421", "schema": { "$ref": "#/components/schemas/CallqueuePath" } }, { "name": "datetime-start", "in": "query", "description": "This is the start of the time window for a given query. The format is based on RFC3339 but also will support additonal params for use in providing a timezone which will allow the API to give the correct range for a given set of data and will be formated in respone using the same format.\n\nSupported formats include.\n\n2023-11-27 13:00:00\n2023-11-27T13:00:00Z\n2023-11-27T13:00:00-08:00\n2023-11-27T13:00:00-08:00[US/Pacific]\n2023-11-27T13:00:00Z[America/Phoenix]", "required": true, "example": "2023-11-27T13:00:00Z[US/Pacific]", "schema": { "$ref": "#/components/schemas/DatetimeStart" } }, { "name": "datetime-end", "in": "query", "description": "This is the end of the time window for a given query. The format is based on RFC3339 but also will support additonal params for use in providing a timezone which will allow the API to give the correct range for a given set of data and will be formated in respone using the same format. Allowed values same as datetime-start.", "required": true, "example": "2023-11-27T14:00:00Z[US/Pacific]", "schema": { "$ref": "#/components/schemas/DatetimeEnd" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AbandondedCallStat" } }, "example": [ { "domain": "acme", "call-orig-call-id": "20250904195742013011-8f1338ed949ac632d4840cd552b6f381", "agent-term-uri": "sip:222@acme", "agent-term-user": 222, "agent-term-domain": "acme", "agent-name-first-name": "CC", "agent-name-last-name": "Agent", "callqueue": "421", "call-dialed-number": 14379000000, "agent-talking-duration-seconds": 0, "agent-call-duration-seconds": 0, "queue-duration-seconds": 10, "agent-holding-duration-seconds": 0, "dispatch-duration-seconds": 0, "agent-call-start-datetime": "2025-09-04T19:57:53+00:00", "queue-call-start-datetime": "2025-09-04T19:57:42+00:00", "queue-call-disconnect-datetime": "2025-09-04T19:57:53+00:00", "agent-call-disconnect-datetime": "2025-09-04T19:57:53+00:00", "agent-call-answer-datetime": "0000-00-00T00:00:00+00:00", "agent-call-disconnect-reason-text": "Abandoned", "queue-call-disconnect-reason-text": "Abandoned", "call-orig-from-name": 17055500000, "call-orig-from-user": 17055500000, "call-orig-from-uri": "sip:17055500000@sbc.acme.com" }, { "domain": "acme", "call-orig-call-id": "20250904195742013011-8f1338ed949ac632d4840cd552b6f381", "agent-term-uri": "sip:222@acme", "agent-term-user": 222, "agent-term-domain": "acme", "agent-name-first-name": "CC", "agent-name-last-name": "Agent", "callqueue": "421", "call-dialed-number": 14379000000, "agent-talking-duration-seconds": 0, "agent-call-duration-seconds": 0, "queue-duration-seconds": 10, "agent-holding-duration-seconds": 0, "dispatch-duration-seconds": 0, "agent-call-start-datetime": "2025-09-04T19:57:53+00:00", "queue-call-start-datetime": "2025-09-04T19:57:42+00:00", "queue-call-disconnect-datetime": "2025-09-04T19:57:53+00:00", "agent-call-disconnect-datetime": "2025-09-04T19:57:53+00:00", "agent-call-answer-datetime": "0000-00-00T00:00:00+00:00", "agent-call-disconnect-reason-text": "Abandoned", "queue-call-disconnect-reason-text": "Abandoned", "call-orig-from-name": 17055500000, "call-orig-from-user": 17055500000, "call-orig-from-uri": "sip:17055500000@sbc.acme.com" } ] } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 0, "message": "string" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 0, "message": "string" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 0, "message": "string" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/answerrules": { "get": { "summary": "Read Answerrules for a User", "deprecated": false, "description": "", "tags": [ "Answer Rules" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Answerrule" } } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "post": { "summary": "Add a Answerrule for a User", "deprecated": false, "description": "", "tags": [ "Answer Rules" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "synchronous": { "$ref": "#/components/schemas/Synchronous" }, "time-frame": { "type": "string", "description": "This is the timeframe that also is needed to make this set of answer rules unique. * is teh default and if no timeframes are setup this is is how to set anserrules. " }, "enabled": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "is-active": { "type": "boolean", "readOnly": true, "description": "This is read only option that will be true if this timeframe is active for this user when taking into account current settings, date/time and all timeframes. " }, "order": { "type": "integer", "description": "This is to allow for a priority based order of different timeframes. The default is to add it in value higher (lower priority) than the lowest priority timeframe. Timeframe * will get 99 if not already set. ", "minimum": 0, "default": 99, "readOnly": true }, "simultaneous-ring": { "description": "This is a feature that will allow multiple phones or remote extensions to be called at the same time. ", "$ref": "#/components/schemas/AnswerruleFeatureSimRing" }, "do-not-disturb": { "description": "When enabled this feature will block all inbound ringing and send the call to voicemails if enabled. ", "type": "object", "properties": { "enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" } }, "required": [ "enabled" ] }, "forward-always": { "$ref": "#/components/schemas/AnswerruleFeature" }, "forward-on-active": { "$ref": "#/components/schemas/AnswerruleFeature" }, "forward-on-busy": { "$ref": "#/components/schemas/AnswerruleFeature" }, "forward-no-answer": { "$ref": "#/components/schemas/AnswerruleFeature" }, "forward-when-unregistered": { "$ref": "#/components/schemas/AnswerruleFeature" }, "forward-on-dnd": { "$ref": "#/components/schemas/AnswerruleFeature" }, "forward-on-spam-call": { "$ref": "#/components/schemas/AnswerruleFeature" }, "call-screening": { "description": "When enabled this feature will enable the call screening application asking the caller to record their name before attempting the connection based on other answer rules. ", "type": "object", "properties": { "enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" } }, "required": [ "enabled" ] }, "phone-numbers-to-allow": { "description": "This is a list of numbers that would be allowed bypassing features like do-not-disturb and call-screening.", "$ref": "#/components/schemas/AnswerruleFeatureWithRemove" }, "new-position": { "type": "string", "writeOnly": true, "enum": [ "top", "bottom" ], "examples": [ "top", "bottom" ], "description": "This will move the answerrule to the top or bottom in the priority list. Top having the most priority, and bottom having the least priority" }, "phone-numbers-to-reject": { "description": "This is a list of numbers that would be allowed bypassing features like do-not-disturb and call-screening.", "$ref": "#/components/schemas/AnswerruleFeatureWithRemove" } }, "required": [ "synchronous", "time-frame", "enabled", "is-active" ] }, "example": { "time-frame": "Vacation", "enabled": "yes", "forward-always": { "enabled": "no", "parameters": [ 18587645226 ] }, "forward-on-busy": { "enabled": "no", "parameters": [] }, "do-not-disturb": { "enabled": "no" }, "forward-when-unregistered": { "enabled": "yes", "parameters": [ 18585551354 ] }, "phone-numbers-to-reject": { "enabled": "yes", "parameters": [ "anonymous", "unknown" ] }, "forward-on-active": { "enabled": "no", "parameters": [ 12545666, "id adipisicing est veniam", "ad" ] }, "forward-no-answer": { "enabled": "no", "parameters": [ 6154343 ] }, "forward-on-spam-call": { "enabled": "yes", "parameters": [ "vmail_1000" ] }, "call-screening": { "enabled": "no" }, "simultaneous-ring": { "enabled": "no", "parameters": [ 1234, 3245, "1231wp", 18587645200 ] } } } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/answerrules/count": { "get": { "summary": "Count Answerrules for a User", "deprecated": false, "description": "", "tags": [ "Answer Rules" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Count" } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 403, "message": "Domain not found or access denied" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 404, "message": "Domain domain does not exist" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/~/users/~/answerrules": { "get": { "summary": "Read Answerrules for my User", "deprecated": false, "description": "", "tags": [ "Answer Rules" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Answerrule" } } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/answerrules/{timeframe}": { "get": { "summary": "Read Specifc Timeframe Answerrule for User", "deprecated": false, "description": "", "tags": [ "Answer Rules" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "timeframe", "in": "path", "description": "", "required": true, "example": "*", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Answerrule" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "delete": { "summary": "Delete a Answerrule for a User ", "deprecated": false, "description": "", "tags": [ "Answer Rules" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "timeframe", "in": "path", "description": "", "required": true, "example": "", "schema": { "type": "string" } } ], "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "put": { "summary": "Update a Answerrule for a User", "deprecated": false, "description": "", "tags": [ "Answer Rules" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "timeframe", "in": "path", "description": "", "required": true, "example": "", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "enabled": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "is-active": { "type": "boolean", "readOnly": true, "description": "This is read only option that will be true if this timeframe is active for this user when taking into account current settings, date/time and all timeframes. " }, "order": { "type": "integer", "description": "This is to allow for a priority based order of different timeframes. The default is to add it in value higher (lower priority) than the lowest priority timeframe. Timeframe * will get 99 if not already set. ", "minimum": 0, "default": 99, "readOnly": true }, "simultaneous-ring": { "description": "This is a feature that will allow multiple phones or remote extensions to be called at the same time. ", "$ref": "#/components/schemas/AnswerruleFeatureSimRing" }, "do-not-disturb": { "description": "When enabled this feature will block all inbound ringing and send the call to voicemails if enabled. ", "type": "object", "properties": { "enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" } }, "required": [ "enabled" ] }, "forward-always": { "$ref": "#/components/schemas/AnswerruleFeature" }, "forward-on-active": { "$ref": "#/components/schemas/AnswerruleFeature" }, "forward-on-busy": { "$ref": "#/components/schemas/AnswerruleFeature" }, "forward-no-answer": { "$ref": "#/components/schemas/AnswerruleFeature" }, "forward-when-unregistered": { "$ref": "#/components/schemas/AnswerruleFeature" }, "forward-on-dnd": { "$ref": "#/components/schemas/AnswerruleFeature" }, "forward-on-spam-call": { "$ref": "#/components/schemas/AnswerruleFeature" }, "call-screening": { "description": "When enabled this feature will enable the call screening application asking the caller to record their name before attempting the connection based on other answer rules. ", "type": "object", "properties": { "enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" } }, "required": [ "enabled" ] }, "phone-numbers-to-allow": { "description": "This is a list of numbers that would be allowed bypassing features like do-not-disturb and call-screening.", "$ref": "#/components/schemas/AnswerruleFeatureWithRemove" }, "new-position": { "type": "string", "writeOnly": true, "enum": [ "top", "bottom" ], "examples": [ "top", "bottom" ], "description": "This will move the answerrule to the top or bottom in the priority list. Top having the most priority, and bottom having the least priority" }, "phone-numbers-to-reject": { "description": "This is a list of numbers that would be allowed bypassing features like do-not-disturb and call-screening.", "$ref": "#/components/schemas/AnswerruleFeatureWithRemove" } }, "required": [ "enabled", "is-active" ] }, "example": { "time_frame": "Vacation", "enable": "yes", "do-not-disturb": { "enable": "yes" }, "forward-always": { "enable": "yes" } } } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/answerrules/reorder": { "put": { "summary": "Reorder Answerrules for my User", "deprecated": false, "description": "To reorder the answerrules, give an array of time frames used in the user's current answerrules in the order desired. Please be sure to include all time frames and no extraneous ones. Be sure to include \"Default\" when necessary which is named \"*\".", "tags": [ "Answer Rules" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "time-frame": { "type": "string", "description": "Contains the name of the Time Frame to be reordered. \"Default\" time frame is named \"*\"" } }, "required": [ "time-frame" ] } }, "example": [ { "time-frame": "my-time-frame-b" }, { "time-frame": "my-timeframe-a" }, { "time-frame": "my-timeframe-c" } ] } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] }, "examples": { "1": { "summary": "Success", "value": { "code": 202, "message": "Accepted" } }, "2": { "summary": "Success", "value": { "code": 404, "message": "Not Found. Timeframe input was not found." } } } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] }, "example": { "code": 400, "message": "Please provide all timeframes in the new order." } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] }, "example": { "code": 404, "message": "Not Found. Timeframe input was not found." } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/number-filters": { "get": { "summary": "Read blocked numbers for a Domain", "deprecated": false, "description": "", "tags": [ "Call Blocking", "44.3" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "domain": { "$ref": "#/components/schemas/DomainName" }, "time-frame": { "type": "string", "description": "This is the timeframe that also is needed to make this set of answer rules unique. * is teh default and if no timeframes are setup this is is how to set anserrules. " }, "enabled": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "is-active": { "type": "boolean", "readOnly": true, "description": "This is read only option that will be true if this timeframe is active for this user when taking into account current settings, date/time and all timeframes. " }, "phone-numbers-to-reject": { "description": "This is a list of numbers that would be blocked and rejected before any forward or sim ring features are attempted. ", "type": "object", "properties": { "enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "parameters": { "type": "array", "items": { "anyOf": [ { "type": "string", "examples": [ "park_1234" ] }, { "type": "number", "examples": [ 18005551234 ] } ] }, "description": "This field will provide the values needed to configure the parent feature. These values could be multiple strings or numbers. " } } } }, "required": [ "domain", "time-frame", "enabled", "is-active" ] } }, "example": [ { "time-frame": "*", "domain": "string", "enabled": "yes", "is-active": true, "phone-numbers-to-reject": { "enabled": "yes", "parameters": [ "5555555555" ] } } ] } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "post": { "summary": "Add blocked numbers for a Domain", "deprecated": false, "description": "", "tags": [ "Call Blocking", "44.3" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "", "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "phone-numbers-to-reject": { "description": "This is a list of numbers that would be blocked and rejected before any forward or sim ring features are attempted. ", "type": "object", "properties": { "parameters": { "type": "array", "items": { "anyOf": [ { "type": "string", "examples": [ "park_1234" ] }, { "type": "number", "examples": [ 18005551234 ] } ] }, "description": "This field will provide the values needed to configure the parent feature. These values could be multiple strings or numbers. " } }, "required": [ "parameters" ] } }, "required": [ "phone-numbers-to-reject" ] }, "example": { "phone-numbers-to-reject": { "parameters": [ "5555555555" ] } } } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] }, "example": { "code": 202, "message": "Accepted" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "delete": { "summary": "Delete blocked numbers for a Domain", "deprecated": false, "description": "", "tags": [ "Call Blocking", "44.3" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "", "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "phone-numbers-to-reject": { "description": "This is a list of numbers that would be blocked and rejected before any forward or sim ring features are attempted. ", "type": "object", "properties": { "parameters": { "type": "array", "items": { "anyOf": [ { "type": "string", "examples": [ "park_1234" ] }, { "type": "number", "examples": [ 18005551234 ] } ] }, "description": "This field will provide the values needed to configure the parent feature. These values could be multiple strings or numbers. " } }, "required": [ "parameters" ] } }, "required": [ "phone-numbers-to-reject" ] }, "example": { "phone-numbers-to-reject": { "parameters": [ "5555555555" ] } } } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] }, "example": { "code": 202, "message": "Accepted" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}number-filters": { "get": { "summary": "Read blocked numbers for a User", "deprecated": false, "description": "", "tags": [ "Call Blocking", "44.3" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/UserNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "domain": { "$ref": "#/components/schemas/DomainName" }, "time-frame": { "type": "string", "description": "This is the timeframe that also is needed to make this set of answer rules unique. * is teh default and if no timeframes are setup this is is how to set anserrules. " }, "enabled": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "is-active": { "type": "boolean", "readOnly": true, "description": "This is read only option that will be true if this timeframe is active for this user when taking into account current settings, date/time and all timeframes. " }, "phone-numbers-to-reject": { "description": "This is a list of numbers that would be blocked and rejected before any forward or sim ring features are attempted. ", "type": "object", "properties": { "enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "parameters": { "type": "array", "items": { "anyOf": [ { "type": "string", "examples": [ "park_1234" ] }, { "type": "number", "examples": [ 18005551234 ] } ] }, "description": "This field will provide the values needed to configure the parent feature. These values could be multiple strings or numbers. " } } } }, "required": [ "domain", "time-frame", "enabled", "is-active" ] } }, "example": [ { "time-frame": "*", "domain": "string", "enabled": "yes", "is-active": true, "phone-numbers-to-reject": { "enabled": "yes", "parameters": [ "5555555555" ] } } ] } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/number-filters": { "post": { "summary": "Add blocked numbers for a User", "deprecated": false, "description": "", "tags": [ "Call Blocking", "44.3" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/UserNamePath" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "phone-numbers-to-reject": { "description": "This is a list of numbers that would be blocked and rejected before any forward or sim ring features are attempted. ", "type": "object", "properties": { "parameters": { "type": "array", "items": { "anyOf": [ { "type": "string", "examples": [ "park_1234" ] }, { "type": "number", "examples": [ 18005551234 ] } ] }, "description": "This field will provide the values needed to configure the parent feature. These values could be multiple strings or numbers. " } }, "required": [ "parameters" ] } }, "required": [ "phone-numbers-to-reject" ] }, "example": { "phone-numbers-to-reject": { "parameters": [ "5555555555" ] } } } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] }, "example": { "code": 202, "message": "Accepted" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "delete": { "summary": "Delete blocked numbers for a User", "deprecated": false, "description": "", "tags": [ "Call Blocking", "44.3" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/UserNamePath" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "phone-numbers-to-reject": { "description": "This is a list of numbers that would be blocked and rejected before any forward or sim ring features are attempted. ", "type": "object", "properties": { "parameters": { "type": "array", "items": { "anyOf": [ { "type": "string", "examples": [ "park_1234" ] }, { "type": "number", "examples": [ 18005551234 ] } ] }, "description": "This field will provide the values needed to configure the parent feature. These values could be multiple strings or numbers. " } }, "required": [ "parameters" ] } }, "required": [ "phone-numbers-to-reject" ] }, "example": { "phone-numbers-to-reject": { "parameters": [ "5555555555" ] } } } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] }, "example": { "code": 202, "message": "Accepted" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/autoattendants": { "post": { "summary": "Create Auto Attendant", "deprecated": false, "description": "", "tags": [ "Auto Attendant" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "attendant-name": { "type": "string", "description": "This is the main name for the auto attendant. Should be used to explain the main purpose for the auto attendant. " }, "user": { "type": "string" }, "time-frame": { "type": "string" }, "auto-attendant": { "$ref": "#/components/schemas/AutoAttendantTier" } }, "required": [ "attendant-name", "user" ] }, "example": null } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "attendant-name": { "type": "string", "description": "This is the main name for the auto attendant. Should be used to explain the main purpose for the auto attendant. " }, "user": { "type": "string" }, "time-frame": { "type": "string" }, "auto-attendant": { "$ref": "#/components/schemas/AutoAttendantTier" } }, "required": [ "attendant-name", "user" ] } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "get": { "summary": "Read Auto Attendants", "deprecated": false, "description": "", "tags": [ "Auto Attendant" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AutoAttendant" } }, "example": [ { "attendant-name": "Main AA Example", "user": "3008", "starting-prompt": "Prompt_100", "read-path": "/api/v2/domains/apidog.ApiReseller/attendants/3008/Prompt_100" }, { "attendant-name": "Main AA Example", "user": "3009", "starting-prompt": "Prompt_100", "read-path": "/api/v2/domains/apidog.ApiReseller/attendants/3009/Prompt_100" }, { "attendant-name": "from portal test", "user": "3100", "starting-prompt": "Prompt_310001", "read-path": "/api/v2/domains/apidog.ApiReseller/attendants/3100/Prompt_310001" } ] } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/autoattendants/{prompt}": { "get": { "summary": "Read Specific Auto Attendant", "deprecated": false, "description": "", "tags": [ "Auto Attendant" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "3008", "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "prompt", "in": "path", "description": "", "required": true, "example": "Prompt_100", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "attendant-name": { "type": "string", "description": "This is the main name for the auto attendant. Should be used to explain the main purpose for the auto attendant. " }, "user": { "type": "string" }, "time-frame": { "type": "string" }, "starting-prompt": { "type": "string", "description": "This is a \"id\" of sorts making this auto attendant unique in terms of this user and dial plan. Will be needed when reading details on a specific AA or making any modifications including removal. " }, "auto-attendant": { "$ref": "#/components/schemas/AutoAttendantTier" } }, "required": [ "attendant-name", "user" ] }, "example": { "attendant-name": "Main AA Example", "user": "3008", "starting-prompt": "Prompt_100", "time-frame": "*", "audio": { "filename": "greeting-100.wav", "ordinal-order": 100, "file-duration-seconds": 3, "file-size-kilobytes": "22.74 KB", "created-datetime": "2023-09-18 21:48:43", "file-access-url ": "https://vb.example.com/api/?object=audio&action=play&domain=apidog.ApiReseller&user=3008&type=greeting&time=20230919034530&auth=87683b37a074545aebb0f5eb9ea45f6d&file=greeting-100.wav", "file-script-text": "Hello! Please press 1 2 or 3. ", "file-source": "", "text-to-speech-voice-id": "en-US-Wavenet-C", "text-to-speech-language": "en-US" }, "auto-attendant": { "3-digit-dial-by-extension": "no", "4-digit-dial-by-extension": "yes", "5-digit-dial-by-extension": "yes", "no-key-press": "option-1", "unassigned-key-press": "repeat", "option-1": { "description": "API AA Builder: Press 1 to go to user 1000", "destination-application": "to-user", "destination-user": "1000" }, "option-2": { "description": "API AA Builder: Press 2 to go to user 1001", "destination-application": "to-user", "destination-user": "1001" }, "option-3": { "description": "API AA Builder: Press 3 to go to queue 1001", "destination-application": "to-callqueue", "destination-user": "2000" }, "option-4": { "description": "API AA Builder: Press 4 to go to queue 1001", "destination-application": "to-callqueue", "destination-user": "2001" }, "option-5": { "description": "API AA Builder: Press 4 to go to queue 1001", "auto-attendant": { "3-digit-dial-by-extension": "yes", "4-digit-dial-by-extension": "no", "5-digit-dial-by-extension": "no", "no-key-press": "repeat", "unassigned-key-press": "option-3", "option-1": { "description": "API AA Builder: Press 1 to go to user 1000", "destination-application": "to-user", "destination-user": "1000" }, "option-2": { "description": "API AA Builder: Press 2 to go to user 1001", "destination-application": "to-user", "destination-user": "2003" }, "option-3": { "description": "API AA Builder: Press 3 to go to user 1001", "auto-attendant": { "3-digit-dial-by-extension": "no", "4-digit-dial-by-extension": "no", "5-digit-dial-by-extension": "no", "no-key-press": "", "unassigned-key-press": "", "option-3": { "description": "API AA Builder: Press 3 to go to user 1001", "destination-application": "to-user", "destination-user": "1001" } }, "audio": { "filename": "greeting-108.wav", "ordinal-order": 108, "file-duration-seconds": 3, "file-size-kilobytes": "25.37 KB", "created-datetime": "2023-09-18 21:48:53", "file-access-url ": "https://vb.example.com/api/?object=audio&action=play&domain=apidog.ApiReseller&user=3008&type=greeting&time=20230919034530&auth=d66d443f35fbaae62537267eeebfaa44&file=greeting-108.wav", "file-script-text": "This is a third tier message. Press some digits. ", "file-source": "", "text-to-speech-voice-id": "en-US-Wavenet-C", "text-to-speech-language": "en-US" } } }, "audio": { "filename": "greeting-105.wav", "ordinal-order": 105, "file-duration-seconds": 3, "file-size-kilobytes": "25.56 KB", "created-datetime": "2023-09-18 21:48:50", "file-access-url ": "https://vb.example.com/api/?object=audio&action=play&domain=apidog.ApiReseller&user=3008&type=greeting&time=20230919034530&auth=9aa4e65d79cb0455428c04385a456f4e&file=greeting-105.wav", "file-script-text": "This is a second tier message. Press some digits. ", "file-source": "", "text-to-speech-voice-id": "en-US-Wavenet-C", "text-to-speech-language": "en-US" } }, "option-6": { "description": "API AA Builder: Press 6 to go to queue 1001", "auto-attendant": { "3-digit-dial-by-extension": "no", "4-digit-dial-by-extension": "no", "5-digit-dial-by-extension": "no", "no-key-press": "", "unassigned-key-press": "", "option-1": { "description": "API AA Builder: Press 1 to go to user 1000", "destination-application": "to-user", "destination-user": "1000" } }, "audio": { "filename": "greeting-106.wav", "ordinal-order": 106, "file-duration-seconds": 4, "file-size-kilobytes": "28.37 KB", "created-datetime": "2023-09-18 21:48:58", "file-access-url ": "https://vb.example.com/api/?object=audio&action=play&domain=apidog.ApiReseller&user=3008&type=greeting&time=20230919034530&auth=6a9f228f27140d3a336a9ff262e0c222&file=greeting-106.wav", "file-script-text": "This is a second second tier message. Press some digits. ", "file-source": "", "text-to-speech-voice-id": "en-US-Wavenet-C", "text-to-speech-language": "en-US" } } } } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "put": { "summary": "Update Specific Auto Attendant", "deprecated": false, "description": "", "tags": [ "Auto Attendant" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "3008", "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "prompt", "in": "path", "description": "", "required": true, "example": "Prompt_100", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "attendant-name": { "type": "string", "description": "This is the main name for the auto attendant. Should be used to explain the main purpose for the auto attendant. " }, "auto-attendant": { "$ref": "#/components/schemas/AutoAttendantTier" } }, "required": [ "attendant-name" ] }, "example": null } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "attendant-name": { "type": "string", "description": "This is the main name for the auto attendant. Should be used to explain the main purpose for the auto attendant. " }, "user": { "type": "string" }, "time-frame": { "type": "string" }, "starting-prompt": { "type": "string", "description": "This is a \"id\" of sorts making this auto attendant unique in terms of this user and dial plan. Will be needed when reading details on a specific AA or making any modifications including removal. " }, "auto-attendant": { "$ref": "#/components/schemas/AutoAttendantTier" } }, "required": [ "attendant-name", "user" ] }, "example": { "attendant-name": "Main AA Example", "user": "3008", "starting-prompt": "Prompt_100", "time-frame": "*", "audio": { "filename": "greeting-100.wav", "ordinal-order": 100, "file-duration-seconds": 3, "file-size-kilobytes": "22.74 KB", "created-datetime": "2023-09-18 21:48:43", "file-access-url ": "https://vb.example.com/api/?object=audio&action=play&domain=apidog.ApiReseller&user=3008&type=greeting&time=20230919034530&auth=87683b37a074545aebb0f5eb9ea45f6d&file=greeting-100.wav", "file-script-text": "Hello! Please press 1 2 or 3. ", "file-source": "", "text-to-speech-voice-id": "en-US-Wavenet-C", "text-to-speech-language": "en-US" }, "auto-attendant": { "3-digit-dial-by-extension": "no", "4-digit-dial-by-extension": "yes", "5-digit-dial-by-extension": "yes", "no-key-press": "option-1", "unassigned-key-press": "repeat", "option-1": { "description": "API AA Builder: Press 1 to go to user 1000", "destination-application": "to-user", "destination-user": "1000" }, "option-2": { "description": "API AA Builder: Press 2 to go to user 1001", "destination-application": "to-user", "destination-user": "1001" }, "option-3": { "description": "API AA Builder: Press 3 to go to queue 1001", "destination-application": "to-callqueue", "destination-user": "2000" }, "option-4": { "description": "API AA Builder: Press 4 to go to queue 1001", "destination-application": "to-callqueue", "destination-user": "2001" }, "option-5": { "description": "API AA Builder: Press 4 to go to queue 1001", "auto-attendant": { "3-digit-dial-by-extension": "yes", "4-digit-dial-by-extension": "no", "5-digit-dial-by-extension": "no", "no-key-press": "repeat", "unassigned-key-press": "option-3", "option-1": { "description": "API AA Builder: Press 1 to go to user 1000", "destination-application": "to-user", "destination-user": "1000" }, "option-2": { "description": "API AA Builder: Press 2 to go to user 1001", "destination-application": "to-user", "destination-user": "2003" }, "option-3": { "description": "API AA Builder: Press 3 to go to user 1001", "auto-attendant": { "3-digit-dial-by-extension": "no", "4-digit-dial-by-extension": "no", "5-digit-dial-by-extension": "no", "no-key-press": "", "unassigned-key-press": "", "option-3": { "description": "API AA Builder: Press 3 to go to user 1001", "destination-application": "to-user", "destination-user": "1001" } }, "audio": { "filename": "greeting-108.wav", "ordinal-order": 108, "file-duration-seconds": 3, "file-size-kilobytes": "25.37 KB", "created-datetime": "2023-09-18 21:48:53", "file-access-url ": "https://vb.example.com/api/?object=audio&action=play&domain=apidog.ApiReseller&user=3008&type=greeting&time=20230919034530&auth=d66d443f35fbaae62537267eeebfaa44&file=greeting-108.wav", "file-script-text": "This is a third tier message. Press some digits. ", "file-source": "", "text-to-speech-voice-id": "en-US-Wavenet-C", "text-to-speech-language": "en-US" } } }, "audio": { "filename": "greeting-105.wav", "ordinal-order": 105, "file-duration-seconds": 3, "file-size-kilobytes": "25.56 KB", "created-datetime": "2023-09-18 21:48:50", "file-access-url ": "https://vb.example.com/api/?object=audio&action=play&domain=apidog.ApiReseller&user=3008&type=greeting&time=20230919034530&auth=9aa4e65d79cb0455428c04385a456f4e&file=greeting-105.wav", "file-script-text": "This is a second tier message. Press some digits. ", "file-source": "", "text-to-speech-voice-id": "en-US-Wavenet-C", "text-to-speech-language": "en-US" } }, "option-6": { "description": "API AA Builder: Press 6 to go to queue 1001", "auto-attendant": { "3-digit-dial-by-extension": "no", "4-digit-dial-by-extension": "no", "5-digit-dial-by-extension": "no", "no-key-press": "", "unassigned-key-press": "", "option-1": { "description": "API AA Builder: Press 1 to go to user 1000", "destination-application": "to-user", "destination-user": "1000" } }, "audio": { "filename": "greeting-106.wav", "ordinal-order": 106, "file-duration-seconds": 4, "file-size-kilobytes": "28.37 KB", "created-datetime": "2023-09-18 21:48:58", "file-access-url ": "https://vb.example.com/api/?object=audio&action=play&domain=apidog.ApiReseller&user=3008&type=greeting&time=20230919034530&auth=6a9f228f27140d3a336a9ff262e0c222&file=greeting-106.wav", "file-script-text": "This is a second second tier message. Press some digits. ", "file-source": "", "text-to-speech-voice-id": "en-US-Wavenet-C", "text-to-speech-language": "en-US" } } } } } }, "headers": {} }, "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "delete": { "summary": "Delete Specific Auto Attendant", "deprecated": false, "description": "", "tags": [ "Auto Attendant" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "3008", "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "prompt", "in": "path", "description": "", "required": true, "example": "Prompt_100", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "attendant-name": { "type": "string", "description": "This is the main name for the auto attendant. Should be used to explain the main purpose for the auto attendant. " }, "user": { "type": "string" }, "time-frame": { "type": "string" }, "starting-prompt": { "type": "string", "description": "This is a \"id\" of sorts making this auto attendant unique in terms of this user and dial plan. Will be needed when reading details on a specific AA or making any modifications including removal. " }, "auto-attendant": { "$ref": "#/components/schemas/AutoAttendantTier" } }, "required": [ "attendant-name", "user" ] }, "example": { "attendant-name": "Main AA Example", "user": "3008", "starting-prompt": "Prompt_100", "time-frame": "*", "audio": { "filename": "greeting-100.wav", "ordinal-order": 100, "file-duration-seconds": 3, "file-size-kilobytes": "22.74 KB", "created-datetime": "2023-09-18 21:48:43", "file-access-url ": "https://vb.example.com/api/?object=audio&action=play&domain=apidog.ApiReseller&user=3008&type=greeting&time=20230919034530&auth=87683b37a074545aebb0f5eb9ea45f6d&file=greeting-100.wav", "file-script-text": "Hello! Please press 1 2 or 3. ", "file-source": "", "text-to-speech-voice-id": "en-US-Wavenet-C", "text-to-speech-language": "en-US" }, "auto-attendant": { "3-digit-dial-by-extension": "no", "4-digit-dial-by-extension": "yes", "5-digit-dial-by-extension": "yes", "no-key-press": "option-1", "unassigned-key-press": "repeat", "option-1": { "description": "API AA Builder: Press 1 to go to user 1000", "destination-application": "to-user", "destination-user": "1000" }, "option-2": { "description": "API AA Builder: Press 2 to go to user 1001", "destination-application": "to-user", "destination-user": "1001" }, "option-3": { "description": "API AA Builder: Press 3 to go to queue 1001", "destination-application": "to-callqueue", "destination-user": "2000" }, "option-4": { "description": "API AA Builder: Press 4 to go to queue 1001", "destination-application": "to-callqueue", "destination-user": "2001" }, "option-5": { "description": "API AA Builder: Press 4 to go to queue 1001", "auto-attendant": { "3-digit-dial-by-extension": "yes", "4-digit-dial-by-extension": "no", "5-digit-dial-by-extension": "no", "no-key-press": "repeat", "unassigned-key-press": "option-3", "option-1": { "description": "API AA Builder: Press 1 to go to user 1000", "destination-application": "to-user", "destination-user": "1000" }, "option-2": { "description": "API AA Builder: Press 2 to go to user 1001", "destination-application": "to-user", "destination-user": "2003" }, "option-3": { "description": "API AA Builder: Press 3 to go to user 1001", "auto-attendant": { "3-digit-dial-by-extension": "no", "4-digit-dial-by-extension": "no", "5-digit-dial-by-extension": "no", "no-key-press": "", "unassigned-key-press": "", "option-3": { "description": "API AA Builder: Press 3 to go to user 1001", "destination-application": "to-user", "destination-user": "1001" } }, "audio": { "filename": "greeting-108.wav", "ordinal-order": 108, "file-duration-seconds": 3, "file-size-kilobytes": "25.37 KB", "created-datetime": "2023-09-18 21:48:53", "file-access-url ": "https://vb.example.com/api/?object=audio&action=play&domain=apidog.ApiReseller&user=3008&type=greeting&time=20230919034530&auth=d66d443f35fbaae62537267eeebfaa44&file=greeting-108.wav", "file-script-text": "This is a third tier message. Press some digits. ", "file-source": "", "text-to-speech-voice-id": "en-US-Wavenet-C", "text-to-speech-language": "en-US" } } }, "audio": { "filename": "greeting-105.wav", "ordinal-order": 105, "file-duration-seconds": 3, "file-size-kilobytes": "25.56 KB", "created-datetime": "2023-09-18 21:48:50", "file-access-url ": "https://vb.example.com/api/?object=audio&action=play&domain=apidog.ApiReseller&user=3008&type=greeting&time=20230919034530&auth=9aa4e65d79cb0455428c04385a456f4e&file=greeting-105.wav", "file-script-text": "This is a second tier message. Press some digits. ", "file-source": "", "text-to-speech-voice-id": "en-US-Wavenet-C", "text-to-speech-language": "en-US" } }, "option-6": { "description": "API AA Builder: Press 6 to go to queue 1001", "auto-attendant": { "3-digit-dial-by-extension": "no", "4-digit-dial-by-extension": "no", "5-digit-dial-by-extension": "no", "no-key-press": "", "unassigned-key-press": "", "option-1": { "description": "API AA Builder: Press 1 to go to user 1000", "destination-application": "to-user", "destination-user": "1000" } }, "audio": { "filename": "greeting-106.wav", "ordinal-order": 106, "file-duration-seconds": 4, "file-size-kilobytes": "28.37 KB", "created-datetime": "2023-09-18 21:48:58", "file-access-url ": "https://vb.example.com/api/?object=audio&action=play&domain=apidog.ApiReseller&user=3008&type=greeting&time=20230919034530&auth=6a9f228f27140d3a336a9ff262e0c222&file=greeting-106.wav", "file-script-text": "This is a second second tier message. Press some digits. ", "file-source": "", "text-to-speech-voice-id": "en-US-Wavenet-C", "text-to-speech-language": "en-US" } } } } } }, "headers": {} }, "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/voicemails/{folder}": { "get": { "summary": "Read Voicemail for User by Folder", "deprecated": false, "description": "", "operationId": "ReadVoicemails", "tags": [ "Media/Voicemail" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "folder", "in": "path", "description": "Options include new, save, and trash", "required": true, "example": "save", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Audiofile" } }, "example": [ { "filename": "vm-20230306200014008354-6cc082866aafdc5dee7a480c2d339c76.wav", "index": "vm-20230306200014008354-6cc082866aafdc5dee7a480c2d339c76", "length": "19", "filesize": "145.67 KB", "filedate": "2023-05-16 23:31:54", "remotepath": "https://vb.example.com/api/?object=audio&action=play&domain=portal&user=2000&type=vmail&time=20230725164140&auth=0b42df426f8e0b56713e7353a5a4e160&file=vm-20230306200014008354-6cc082866aafdc5dee7a480c2d339c76.wav", "moh_script": "", "source_type": "", "voice_id": "", "voice_language": "", "FromName": "Site Manager", "FromUser": "1005", "FromHost": "portal", "NmsAni": "1005wp", "RecordTime": "2023-03-06 20:00:34", "NmsRecStartTime": "2023-03-06 20:00:22", "NmsRecDuration": "9", "TimeZone": "US/Pacific", "transcription": "Hello. This is Chris. This is a test message. Please give me a callback. 8 5 8 7 6 4 5 2 2 6. Thank you. " } ] } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/voicemails/{folder}/count": { "get": { "summary": "Count Voicemail for User by Folder", "deprecated": false, "description": "", "tags": [ "Media/Voicemail" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "folder", "in": "path", "description": "Options include new, save, and trash", "required": true, "example": "save", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": { "count": 2, "size": 64728 } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 403, "message": "Domain not found or access denied" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/voicemails/{folder}/{filename}": { "get": { "summary": "Read Specific Voicemail for User ", "deprecated": false, "description": "", "operationId": "ReadVoicemail", "tags": [ "Media/Voicemail" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "folder", "in": "path", "description": "Options include new, save, and trash", "required": true, "example": "save", "schema": { "type": "string" } }, { "name": "filename", "in": "path", "description": "", "required": true, "example": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Audiofile" } }, "example": [ { "filename": "vm-20230306200014008354-6cc082866aafdc5dee7a480c2d339c76.wav", "index": "vm-20230306200014008354-6cc082866aafdc5dee7a480c2d339c76", "length": "19", "filesize": "145.67 KB", "filedate": "2023-05-16 23:31:54", "remotepath": "https://vb.example.com/api/?object=audio&action=play&domain=portal&user=2000&type=vmail&time=20230725164140&auth=0b42df426f8e0b56713e7353a5a4e160&file=vm-20230306200014008354-6cc082866aafdc5dee7a480c2d339c76.wav", "moh_script": "", "source_type": "", "voice_id": "", "voice_language": "", "FromName": "Site Manager", "FromUser": "1005", "FromHost": "portal", "NmsAni": "1005wp", "RecordTime": "2023-03-06 20:00:34", "NmsRecStartTime": "2023-03-06 20:00:22", "NmsRecDuration": "9", "TimeZone": "US/Pacific", "transcription": "Hello. This is Chris. This is a test message. Please give me a callback. 8 5 8 7 6 4 5 2 2 6. Thank you. " } ] } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "delete": { "summary": "Delete Voicemail ", "deprecated": false, "description": "", "operationId": "DeleteVoicemail", "tags": [ "Media/Voicemail" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "folder", "in": "path", "description": "Options include new, save, and trash", "required": true, "example": "save", "schema": { "type": "string" } }, { "name": "filename", "in": "path", "description": "", "required": true, "example": "vm-20230829235740031843-d739b1936a66eff93de3878ecfbceffa.wav", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Audiofile" } }, "example": [ { "filename": "vm-20230306200014008354-6cc082866aafdc5dee7a480c2d339c76.wav", "index": "vm-20230306200014008354-6cc082866aafdc5dee7a480c2d339c76", "length": "19", "filesize": "145.67 KB", "filedate": "2023-05-16 23:31:54", "remotepath": "https://vb.example.com/api/?object=audio&action=play&domain=portal&user=2000&type=vmail&time=20230725164140&auth=0b42df426f8e0b56713e7353a5a4e160&file=vm-20230306200014008354-6cc082866aafdc5dee7a480c2d339c76.wav", "moh_script": "", "source_type": "", "voice_id": "", "voice_language": "", "FromName": "Site Manager", "FromUser": "1005", "FromHost": "portal", "NmsAni": "1005wp", "RecordTime": "2023-03-06 20:00:34", "NmsRecStartTime": "2023-03-06 20:00:22", "NmsRecDuration": "9", "TimeZone": "US/Pacific", "transcription": "Hello. This is Chris. This is a test message. Please give me a callback. 8 5 8 7 6 4 5 2 2 6. Thank you. " } ] } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/voicemails/{folder}/{filename}/save": { "patch": { "summary": "Move Voicemail to save folder", "deprecated": false, "description": "", "operationId": "SaveVoicemail", "tags": [ "Media/Voicemail" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "folder", "in": "path", "description": "Options include new, save, and trash", "required": true, "example": "save", "schema": { "type": "string" } }, { "name": "filename", "in": "path", "description": "", "required": true, "example": "vm-20230829235740031843-d739b1936a66eff93de3878ecfbceffa.wav", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Audiofile" } }, "example": [ { "filename": "vm-20230306200014008354-6cc082866aafdc5dee7a480c2d339c76.wav", "index": "vm-20230306200014008354-6cc082866aafdc5dee7a480c2d339c76", "length": "19", "filesize": "145.67 KB", "filedate": "2023-05-16 23:31:54", "remotepath": "https://vb.example.com/api/?object=audio&action=play&domain=portal&user=2000&type=vmail&time=20230725164140&auth=0b42df426f8e0b56713e7353a5a4e160&file=vm-20230306200014008354-6cc082866aafdc5dee7a480c2d339c76.wav", "moh_script": "", "source_type": "", "voice_id": "", "voice_language": "", "FromName": "Site Manager", "FromUser": "1005", "FromHost": "portal", "NmsAni": "1005wp", "RecordTime": "2023-03-06 20:00:34", "NmsRecStartTime": "2023-03-06 20:00:22", "NmsRecDuration": "9", "TimeZone": "US/Pacific", "transcription": "Hello. This is Chris. This is a test message. Please give me a callback. 8 5 8 7 6 4 5 2 2 6. Thank you. " } ] } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/voicemails/{folder}/{filename}/forward": { "patch": { "summary": "Forward Voicemail to another user", "deprecated": false, "description": "", "operationId": "ForwardVoicemail", "tags": [ "Media/Voicemail" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "folder", "in": "path", "description": "Options include new, save, and trash", "required": true, "example": "save", "schema": { "type": "string" } }, { "name": "filename", "in": "path", "description": "", "required": true, "example": "vm-20230829235740031843-d739b1936a66eff93de3878ecfbceffa.wav", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "voicemail-forward-new-destination": { "type": "string", "description": "Should be a user extension where there voicemail will be moved that user's voicemail as a new message. " } }, "required": [ "voicemail-forward-new-destination" ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Audiofile" } }, "example": [ { "filename": "vm-20230306200014008354-6cc082866aafdc5dee7a480c2d339c76.wav", "index": "vm-20230306200014008354-6cc082866aafdc5dee7a480c2d339c76", "length": "19", "filesize": "145.67 KB", "filedate": "2023-05-16 23:31:54", "remotepath": "https://vb.example.com/api/?object=audio&action=play&domain=portal&user=2000&type=vmail&time=20230725164140&auth=0b42df426f8e0b56713e7353a5a4e160&file=vm-20230306200014008354-6cc082866aafdc5dee7a480c2d339c76.wav", "moh_script": "", "source_type": "", "voice_id": "", "voice_language": "", "FromName": "Site Manager", "FromUser": "1005", "FromHost": "portal", "NmsAni": "1005wp", "RecordTime": "2023-03-06 20:00:34", "NmsRecStartTime": "2023-03-06 20:00:22", "NmsRecDuration": "9", "TimeZone": "US/Pacific", "transcription": "Hello. This is Chris. This is a test message. Please give me a callback. 8 5 8 7 6 4 5 2 2 6. Thank you. " } ] } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/greetings": { "get": { "summary": "Read Greetings for User", "deprecated": false, "description": "", "operationId": "ReadGreetings", "tags": [ "Media/Greetings" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Audiofile" } }, "example": [ { "filename": "vm-20230306200014008354-6cc082866aafdc5dee7a480c2d339c76.wav", "index": "vm-20230306200014008354-6cc082866aafdc5dee7a480c2d339c76", "length": "19", "filesize": "145.67 KB", "filedate": "2023-05-16 23:31:54", "remotepath": "https://vb.example.com/api/?object=audio&action=play&domain=portal&user=2000&type=vmail&time=20230725164140&auth=0b42df426f8e0b56713e7353a5a4e160&file=vm-20230306200014008354-6cc082866aafdc5dee7a480c2d339c76.wav", "moh_script": "", "source_type": "", "voice_id": "", "voice_language": "", "FromName": "Site Manager", "FromUser": "1005", "FromHost": "portal", "NmsAni": "1005wp", "RecordTime": "2023-03-06 20:00:34", "NmsRecStartTime": "2023-03-06 20:00:22", "NmsRecDuration": "9", "TimeZone": "US/Pacific", "transcription": "Hello. This is Chris. This is a test message. Please give me a callback. 8 5 8 7 6 4 5 2 2 6. Thank you. " } ] } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "post": { "summary": "Create a new Greeting from TTS", "deprecated": false, "description": "", "operationId": "CreateGreetingTTS", "tags": [ "Media/Greetings" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "synchronous": { "$ref": "#/components/schemas/Synchronous" }, "index": { "type": "integer", "description": "The index of the file, Example \"2\" for greeting 2. In create (POST) requests index cab be omitted and the API will select a new index automatically. " }, "script": { "type": "string", "description": "This is a simple explanation of what the audio is and can include what is said in the audio file for explanation. " }, "voice_language": { "type": "string", "default": "en-US", "examples": [ "en-US", "es-MX", "fr-CA" ], "description": "This is the language that can be requested when using TTS feature. Leave of to have API lookup configs from the defaults or domain specific configs. " }, "voice_id": { "type": "string", "description": "This value will allow you to select the voice to be used for TTS applications. Value must be valid or will cause errors. leave off request to have the API lookup defaults from system and/or domain. ", "default": "en-US-Wavenet-C" } }, "required": [ "synchronous", "script" ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/greetings/count": { "get": { "summary": "Count Greetings for User", "deprecated": false, "description": "", "tags": [ "Media/Greetings" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": { "count": 1, "size": 41146 } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 403, "message": "Domain not found or access denied" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/greetings/{index}": { "get": { "summary": "Read Specific Greeting for User", "deprecated": false, "description": "", "operationId": "ReadGreeting", "tags": [ "Media/Greetings" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "index", "in": "path", "description": "", "required": true, "example": "1", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Audiofile" }, "example": [ { "filename": "vm-20230306200014008354-6cc082866aafdc5dee7a480c2d339c76.wav", "index": "vm-20230306200014008354-6cc082866aafdc5dee7a480c2d339c76", "length": "19", "filesize": "145.67 KB", "filedate": "2023-05-16 23:31:54", "remotepath": "https://vb.example.com/api/?object=audio&action=play&domain=portal&user=2000&type=vmail&time=20230725164140&auth=0b42df426f8e0b56713e7353a5a4e160&file=vm-20230306200014008354-6cc082866aafdc5dee7a480c2d339c76.wav", "moh_script": "", "source_type": "", "voice_id": "", "voice_language": "", "FromName": "Site Manager", "FromUser": "1005", "FromHost": "portal", "NmsAni": "1005wp", "RecordTime": "2023-03-06 20:00:34", "NmsRecStartTime": "2023-03-06 20:00:22", "NmsRecDuration": "9", "TimeZone": "US/Pacific", "transcription": "Hello. This is Chris. This is a test message. Please give me a callback. 8 5 8 7 6 4 5 2 2 6. Thank you. " } ] } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "delete": { "summary": "Delete Specific Greeting for User", "deprecated": false, "description": "", "operationId": "DeleteGreeting", "tags": [ "Media/Greetings" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "index", "in": "path", "description": "", "required": true, "example": "4", "schema": { "type": "string" } } ], "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "put": { "summary": "Update Greeting with TTS script", "deprecated": false, "description": "", "operationId": "UpdateGreetingTTS", "tags": [ "Media/Greetings" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "index", "in": "path", "description": "", "required": true, "example": "1", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "synchronous": { "$ref": "#/components/schemas/Synchronous" }, "script": { "type": "string", "description": "This is a simple explanation of what the audio is and can include what is said in the audio file for explanation. " }, "convert": { "type": "string", "enum": [ "yes", "no" ], "default": "no", "description": "Setting yes will allow the API to attempt to convert the file from accepted formats into the correct format for media playback" }, "encoding": { "type": "string", "description": "Used when providing base64 encoded data to give the content tupe of the file. ", "examples": [ "audio/wav", "audio/mp3" ] }, "base64_file": { "type": "string", "description": "This is a base64 encoded string formated without line breaks or spaces. " }, "voice_language": { "type": "string", "default": "en-US", "examples": [ "en-US", "es-MX", "fr-CA" ], "description": "This is the language that can be requested when using TTS feature. Leave of to have API lookup configs from the defaults or domain specific configs. " }, "voice_id": { "type": "string", "description": "This value will allow you to select the voice to be used for TTS applications. Value must be valid or will cause errors. leave off request to have the API lookup defaults from system and/or domain. ", "default": "en-US-Wavenet-C" } }, "required": [ "synchronous", "script" ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/moh": { "get": { "summary": "Read MOH for Domain", "deprecated": false, "description": "", "operationId": "ReadMohDomain", "tags": [ "Media/Music on Hold/Domain" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Audiofile" } }, "example": [ { "filename": "vm-20230306200014008354-6cc082866aafdc5dee7a480c2d339c76.wav", "index": "vm-20230306200014008354-6cc082866aafdc5dee7a480c2d339c76", "length": "19", "filesize": "145.67 KB", "filedate": "2023-05-16 23:31:54", "remotepath": "https://vb.example.com/api/?object=audio&action=play&domain=portal&user=2000&type=vmail&time=20230725164140&auth=0b42df426f8e0b56713e7353a5a4e160&file=vm-20230306200014008354-6cc082866aafdc5dee7a480c2d339c76.wav", "moh_script": "", "source_type": "", "voice_id": "", "voice_language": "", "FromName": "Site Manager", "FromUser": "1005", "FromHost": "portal", "NmsAni": "1005wp", "RecordTime": "2023-03-06 20:00:34", "NmsRecStartTime": "2023-03-06 20:00:22", "NmsRecDuration": "9", "TimeZone": "US/Pacific", "transcription": "Hello. This is Chris. This is a test message. Please give me a callback. 8 5 8 7 6 4 5 2 2 6. Thank you. " } ] } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "post": { "summary": "Create a new MOH for Domain from TTS", "deprecated": false, "description": "", "operationId": "CreateMohDomainTTS", "tags": [ "Media/Music on Hold/Domain" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "synchronous": { "$ref": "#/components/schemas/Synchronous" }, "index": { "type": "integer", "description": "The index of the file, Example \"2\" for greeting 2. In create (POST) requests index cab be omitted and the API will select a new index automatically. " }, "script": { "type": "string", "description": "This is a simple explanation of what the audio is and can include what is said in the audio file for explanation. " }, "voice_language": { "type": "string", "default": "en-US", "examples": [ "en-US", "es-MX", "fr-CA" ], "description": "This is the language that can be requested when using TTS feature. Leave of to have API lookup configs from the defaults or domain specific configs. " }, "voice_id": { "type": "string", "description": "This value will allow you to select the voice to be used for TTS applications. Value must be valid or will cause errors. leave off request to have the API lookup defaults from system and/or domain. ", "default": "en-US-Wavenet-C" } }, "required": [ "synchronous", "script" ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Audiofile" } } }, "headers": {} }, "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/moh/count": { "get": { "summary": "Count MOH for Domain", "deprecated": false, "description": "", "tags": [ "Media/Music on Hold/Domain" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": { "count": 1, "size": 32832 } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 403, "message": "Domain not found or access denied" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/moh/{index}": { "put": { "summary": "Update MOH for Domain from TTS", "deprecated": false, "description": "", "operationId": "UpdateMohDomainTTS", "tags": [ "Media/Music on Hold/Domain" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "index", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "synchronous": { "$ref": "#/components/schemas/Synchronous" }, "script": { "type": "string", "description": "This is a simple explanation of what the audio is and can include what is said in the audio file for explanation. " }, "voice_language": { "type": "string", "default": "en-US", "examples": [ "en-US", "es-MX", "fr-CA" ], "description": "This is the language that can be requested when using TTS feature. Leave of to have API lookup configs from the defaults or domain specific configs. " }, "voice_id": { "type": "string", "description": "This value will allow you to select the voice to be used for TTS applications. Value must be valid or will cause errors. leave off request to have the API lookup defaults from system and/or domain. ", "default": "en-US-Wavenet-C" } }, "required": [ "synchronous", "script" ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Audiofile" } } }, "headers": {} }, "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "delete": { "summary": "Delete MOH for Domain", "deprecated": false, "description": "", "operationId": "DeleteMohDomain", "tags": [ "Media/Music on Hold/Domain" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "index", "in": "path", "description": "", "required": true, "example": "1", "schema": { "type": "string" } } ], "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/moh": { "get": { "summary": "Read MOH for User", "deprecated": false, "description": "", "operationId": "ReadMohUser", "tags": [ "Media/Music on Hold/User" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Audiofile" } }, "example": [ { "filename": "vm-20230306200014008354-6cc082866aafdc5dee7a480c2d339c76.wav", "index": "vm-20230306200014008354-6cc082866aafdc5dee7a480c2d339c76", "length": "19", "filesize": "145.67 KB", "filedate": "2023-05-16 23:31:54", "remotepath": "https://vb.example.com/api/?object=audio&action=play&domain=portal&user=2000&type=vmail&time=20230725164140&auth=0b42df426f8e0b56713e7353a5a4e160&file=vm-20230306200014008354-6cc082866aafdc5dee7a480c2d339c76.wav", "moh_script": "", "source_type": "", "voice_id": "", "voice_language": "", "FromName": "Site Manager", "FromUser": "1005", "FromHost": "portal", "NmsAni": "1005wp", "RecordTime": "2023-03-06 20:00:34", "NmsRecStartTime": "2023-03-06 20:00:22", "NmsRecDuration": "9", "TimeZone": "US/Pacific", "transcription": "Hello. This is Chris. This is a test message. Please give me a callback. 8 5 8 7 6 4 5 2 2 6. Thank you. " } ] } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "post": { "summary": "Create a new MOH for Domain from TTS", "deprecated": false, "description": "", "operationId": "CreateMohUserTTS", "tags": [ "Media/Music on Hold/User" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/UserNamePath" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "synchronous": { "$ref": "#/components/schemas/Synchronous" }, "index": { "type": "integer", "description": "The index of the file, Example \"2\" for greeting 2. In create (POST) requests index cab be omitted and the API will select a new index automatically. " }, "script": { "type": "string", "description": "This is a simple explanation of what the audio is and can include what is said in the audio file for explanation. " }, "voice_language": { "type": "string", "default": "en-US", "examples": [ "en-US", "es-MX", "fr-CA" ], "description": "This is the language that can be requested when using TTS feature. Leave of to have API lookup configs from the defaults or domain specific configs. " }, "voice_id": { "type": "string", "description": "This value will allow you to select the voice to be used for TTS applications. Value must be valid or will cause errors. leave off request to have the API lookup defaults from system and/or domain. ", "default": "en-US-Wavenet-C" } }, "required": [ "synchronous", "script" ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Audiofile" } } }, "headers": {} }, "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/moh/count": { "get": { "summary": "Count MOH for User", "deprecated": false, "description": "", "tags": [ "Media/Music on Hold/User" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": { "count": 1, "size": 32832 } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "403": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": { "code": 403, "message": "Domain not found or access denied" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/moh/{index}": { "put": { "summary": "Update MOH for Domain from TTS", "deprecated": false, "description": "", "operationId": "UpdateMohUserTTS", "tags": [ "Media/Music on Hold/User" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "index", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "synchronous": { "$ref": "#/components/schemas/Synchronous" }, "script": { "type": "string", "description": "This is a simple explanation of what the audio is and can include what is said in the audio file for explanation. " }, "voice_language": { "type": "string", "default": "en-US", "examples": [ "en-US", "es-MX", "fr-CA" ], "description": "This is the language that can be requested when using TTS feature. Leave of to have API lookup configs from the defaults or domain specific configs. " }, "voice_id": { "type": "string", "description": "This value will allow you to select the voice to be used for TTS applications. Value must be valid or will cause errors. leave off request to have the API lookup defaults from system and/or domain. ", "default": "en-US-Wavenet-C" } }, "required": [ "synchronous", "script" ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Audiofile" } } }, "headers": {} }, "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "delete": { "summary": "Delete MOH for User ", "deprecated": false, "description": "", "operationId": "DeleteMohUser", "tags": [ "Media/Music on Hold/User" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "index", "in": "path", "description": "", "required": true, "example": "2", "schema": { "type": "string" } } ], "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/msg": { "get": { "summary": "Read Hold Messages for Domain", "deprecated": false, "description": "", "operationId": "ReadMsgDomain", "tags": [ "Media/Hold Messages/Domain" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Audiofile" } }, "example": [ { "filename": "vm-20230306200014008354-6cc082866aafdc5dee7a480c2d339c76.wav", "index": "vm-20230306200014008354-6cc082866aafdc5dee7a480c2d339c76", "length": "19", "filesize": "145.67 KB", "filedate": "2023-05-16 23:31:54", "remotepath": "https://vb.example.com/api/?object=audio&action=play&domain=portal&user=2000&type=vmail&time=20230725164140&auth=0b42df426f8e0b56713e7353a5a4e160&file=vm-20230306200014008354-6cc082866aafdc5dee7a480c2d339c76.wav", "moh_script": "", "source_type": "", "voice_id": "", "voice_language": "", "FromName": "Site Manager", "FromUser": "1005", "FromHost": "portal", "NmsAni": "1005wp", "RecordTime": "2023-03-06 20:00:34", "NmsRecStartTime": "2023-03-06 20:00:22", "NmsRecDuration": "9", "TimeZone": "US/Pacific", "transcription": "Hello. This is Chris. This is a test message. Please give me a callback. 8 5 8 7 6 4 5 2 2 6. Thank you. " } ] } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "post": { "summary": "Create a new Hold Messge for Domain from Upload (Multipart/Mixed Post)", "deprecated": false, "description": "", "operationId": "CreateMsgDomainFileUpload", "tags": [ "Media/Hold Messages/Domain" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "script": { "description": "This is a simple explanation of what the audio is and can include what is said in the audio file for explanation. ", "example": "This is a generic song.", "type": "string" }, "File": { "description": "This is a \"File\" type parameter that needs to include the audio file in question using a file post method. ", "example": "file:///Users/caaker/Downloads/Ding-Dong.wav", "type": "string", "format": "binary" }, "index": { "description": "The index of the file, Example \"2\" for greeting 2.", "example": 2, "type": "integer" }, "convert": { "description": "Setting yes will allow the API to attempt to convert the file from accepted formats into the correct format for media playback", "example": "yes", "type": "string" }, "synchronous": { "description": "When synchronous is requested with \"yes\" the response will be a 200 on success and will contain a valid JSON representiation of the new resource. If no or left off request a 202 \"Accepted\" will be given in a success case and this can be considered a success. Synchronous responses will be a little slower as the API will process the geo replication request and wait till the local copy has been written and can be read back berfore sending a response. ", "example": "yes", "type": "string" } }, "required": [ "synchronous" ] }, "example": null } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/msg/count": { "get": { "summary": "Count Hold Messages for Domain", "deprecated": false, "description": "", "tags": [ "Media/Hold Messages/Domain" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": { "count": 1, "size": 7164 } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 403, "message": "Domain not found or access denied" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/msg/{index}": { "put": { "summary": "Update Hold Messge for Domain from Upload (Multipart/Mixed Post)", "deprecated": false, "description": "", "operationId": "UpdateMsgDomainFileUpload", "tags": [ "Media/Hold Messages/Domain" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "index", "in": "path", "description": "", "required": true, "example": "2", "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "script": { "description": "This is a simple explanation of what the audio is and can include what is said in the audio file for explanation. ", "example": "This is a generic song.", "type": "string" }, "File": { "description": "This is a \"File\" type parameter that needs to include the audio file in question using a file post method. ", "example": "file:///Users/caaker/Downloads/Ding-Dong.wav", "type": "string", "format": "binary" }, "convert": { "description": "Setting yes will allow the API to attempt to convert the file from accepted formats into the correct format for media playback", "example": "yes", "type": "string" }, "synchronous": { "description": "When synchronous is requested with \"yes\" the response will be a 200 on success and will contain a valid JSON representiation of the new resource. If no or left off request a 202 \"Accepted\" will be given in a success case and this can be considered a success. Synchronous responses will be a little slower as the API will process the geo replication request and wait till the local copy has been written and can be read back berfore sending a response. ", "example": "yes", "type": "string" } }, "required": [ "synchronous" ] }, "example": null } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "delete": { "summary": "Delete Hold Messge for Domain", "deprecated": false, "description": "", "operationId": "DeleteMsgDomain", "tags": [ "Media/Hold Messages/Domain" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "index", "in": "path", "description": "", "required": true, "example": "2", "schema": { "type": "string" } } ], "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/msg": { "get": { "summary": "Read Hold Messages for User", "deprecated": false, "description": "", "operationId": "ReadMsgUser", "tags": [ "Media/Hold Messages/User" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Audiofile" } }, "example": [ { "filename": "vm-20230306200014008354-6cc082866aafdc5dee7a480c2d339c76.wav", "index": "vm-20230306200014008354-6cc082866aafdc5dee7a480c2d339c76", "length": "19", "filesize": "145.67 KB", "filedate": "2023-05-16 23:31:54", "remotepath": "https://vb.example.com/api/?object=audio&action=play&domain=portal&user=2000&type=vmail&time=20230725164140&auth=0b42df426f8e0b56713e7353a5a4e160&file=vm-20230306200014008354-6cc082866aafdc5dee7a480c2d339c76.wav", "moh_script": "", "source_type": "", "voice_id": "", "voice_language": "", "FromName": "Site Manager", "FromUser": "1005", "FromHost": "portal", "NmsAni": "1005wp", "RecordTime": "2023-03-06 20:00:34", "NmsRecStartTime": "2023-03-06 20:00:22", "NmsRecDuration": "9", "TimeZone": "US/Pacific", "transcription": "Hello. This is Chris. This is a test message. Please give me a callback. 8 5 8 7 6 4 5 2 2 6. Thank you. " } ] } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "post": { "summary": "Create a new Hold Messge for User from Upload (Multipart/Mixed Post)", "deprecated": false, "description": "", "tags": [ "Media/Hold Messages/User" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "script": { "description": "This is a simple explanation of what the audio is and can include what is said in the audio file for explanation. ", "example": "This is a generic song.", "type": "string" }, "File": { "description": "This is a \"File\" type parameter that needs to include the audio file in question using a file post method. ", "example": "file:///Users/caaker/Downloads/Ding-Dong.wav", "type": "string", "format": "binary" }, "index": { "description": "The index of the file, Example \"2\" for greeting 2.", "example": 2, "type": "integer" }, "convert": { "description": "Setting yes will allow the API to attempt to convert the file from accepted formats into the correct format for media playback", "example": "yes", "type": "string" }, "synchronous": { "description": "When synchronous is requested with \"yes\" the response will be a 200 on success and will contain a valid JSON representiation of the new resource. If no or left off request a 202 \"Accepted\" will be given in a success case and this can be considered a success. Synchronous responses will be a little slower as the API will process the geo replication request and wait till the local copy has been written and can be read back berfore sending a response. ", "example": "yes", "type": "string" } }, "required": [ "synchronous" ] }, "example": null } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/msg/count": { "get": { "summary": "Count Hold Messages for User", "deprecated": false, "description": "", "operationId": "CountMsgUser", "tags": [ "Media/Hold Messages/User" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": { "count": 1, "size": 18874 } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 403, "message": "Domain not found or access denied" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/msg/{index}": { "put": { "summary": "Update Hold Messge for User from Upload (Multipart/Mixed Post)", "deprecated": false, "description": "", "operationId": "UpdateMsgUserFileUpload", "tags": [ "Media/Hold Messages/User" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "index", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "script": { "description": "This is a simple explanation of what the audio is and can include what is said in the audio file for explanation. ", "example": "This is a generic song.", "type": "string" }, "File": { "description": "This is a \"File\" type parameter that needs to include the audio file in question using a file post method. ", "example": "file:///Users/caaker/Downloads/Ding-Dong.wav", "type": "string", "format": "binary" }, "convert": { "description": "Setting yes will allow the API to attempt to convert the file from accepted formats into the correct format for media playback", "example": "yes", "type": "string" }, "synchronous": { "description": "When synchronous is requested with \"yes\" the response will be a 200 on success and will contain a valid JSON representiation of the new resource. If no or left off request a 202 \"Accepted\" will be given in a success case and this can be considered a success. Synchronous responses will be a little slower as the API will process the geo replication request and wait till the local copy has been written and can be read back berfore sending a response. ", "example": "yes", "type": "string" } }, "required": [ "synchronous" ] }, "example": null } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "delete": { "summary": "Delete Hold Messge for User ", "deprecated": false, "description": "", "operationId": "DeleteMsgUser", "tags": [ "Media/Hold Messages/User" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "index", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/voices/{language}": { "get": { "summary": "Get Available Voices", "deprecated": false, "description": "", "tags": [ "Media/Text to Speech" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "", "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "language", "in": "path", "description": "", "required": true, "example": "en-US", "schema": { "type": "string" } }, { "name": "gender", "in": "query", "description": "", "required": false, "example": "", "schema": { "type": "string" } }, { "name": "vendor", "in": "query", "description": "", "required": false, "example": "", "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "", "required": false, "example": "", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "", "required": false, "example": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TtsVoice" } } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/voices": { "post": { "summary": "Synthesize Voice (Text to Speech) ", "deprecated": false, "description": "", "tags": [ "Media/Text to Speech" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "", "schema": { "$ref": "#/components/schemas/UserNamePath" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "script": { "type": "string", "description": "This is a simple explanation of what the audio is and can include what is said in the audio file for explanation. " }, "voice_language": { "type": "string", "default": "en-US", "examples": [ "en-US", "es-MX", "fr-CA" ], "description": "This is the language that can be requested when using TTS feature. Leave of to have API lookup configs from the defaults or domain specific configs. " }, "voice_id": { "type": "string", "description": "This value will allow you to select the voice to be used for TTS applications. Value must be valid or will cause errors. leave off request to have the API lookup defaults from system and/or domain. ", "default": "en-US-Wavenet-C" } }, "required": [ "script" ] } } } }, "responses": { "200": { "description": "", "content": { "*/*": { "schema": { "type": [ "string", "integer", "boolean", "array", "object", "number", "null" ] } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "get": { "summary": "Synthesize Voice (Text to Speech) via GET", "deprecated": false, "description": "", "tags": [ "Media/Text to Speech" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "script", "in": "query", "description": "", "required": false, "example": "This is a script. ", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": [ "string", "integer", "boolean", "array", "object", "number", "null" ] } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/cdrs": { "get": { "summary": "Read CDRs", "deprecated": false, "description": "", "tags": [ "CDR (Call History)" ], "parameters": [ { "name": "datetime-start", "in": "query", "description": "", "required": true, "example": "2023-11-27T13:00:00Z[US/Pacific]", "schema": { "$ref": "#/components/schemas/DatetimeStart" } }, { "name": "datetime-end", "in": "query", "description": "", "required": true, "example": "2023-11-27T13:00:00Z[US/Pacific]", "schema": { "$ref": "#/components/schemas/DatetimeEnd" } }, { "name": "start", "in": "query", "description": "Offset of the first record to return, starting at 0. Increase by `limit` for each page.", "required": false, "example": 0, "schema": { "$ref": "#/components/schemas/Start", "type": "integer", "minimum": 0 } }, { "name": "limit", "in": "query", "description": "Records per page. Defaults to 100, maximum 100. Higher values, or more than one `limit` parameter, are rejected with 400. Page through results with `start`.", "required": false, "schema": { "$ref": "#/components/schemas/Limit", "type": "integer", "minimum": 1, "maximum": 100, "default": 100 }, "example": 100 }, { "name": "type", "in": "query", "description": "Options include Inbound, Outbound, On-net, Off-net, Missed, Received, or integer type 0,1,2,3", "required": false, "example": "Off-net", "schema": { "type": "string" } }, { "name": "orig_callid", "in": "query", "description": "Optional and legacy ability to lookup a specific call by orig_callid . Only available for top level without specific domain set. \n", "required": false, "schema": { "type": "string" } }, { "name": "term_callid", "in": "query", "description": "Optional and legacy ability to lookup a specific call by term_callid. Only available for top level without specific domain set. ", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CdrD" } } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/cdrs": { "get": { "summary": "Read CDRs for Domain", "deprecated": false, "description": "", "tags": [ "CDR (Call History)" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "datetime-start", "in": "query", "description": "", "required": true, "example": "2023-11-27T13:00:00Z[US/Pacific]", "schema": { "$ref": "#/components/schemas/DatetimeStart" } }, { "name": "datetime-end", "in": "query", "description": "", "required": true, "example": "2023-11-27T13:00:00Z[US/Pacific]", "schema": { "$ref": "#/components/schemas/DatetimeEnd" } }, { "name": "start", "in": "query", "description": "Offset of the first record to return, starting at 0. Increase by `limit` for each page.", "required": false, "example": 0, "schema": { "$ref": "#/components/schemas/Start", "type": "integer", "minimum": 0 } }, { "name": "limit", "in": "query", "description": "Records per page. Defaults to 100, maximum 100. Higher values, or more than one `limit` parameter, are rejected with 400. Page through results with `start`.", "required": false, "schema": { "$ref": "#/components/schemas/Limit", "type": "integer", "minimum": 1, "maximum": 100, "default": 100 }, "example": 100 }, { "name": "type", "in": "query", "description": "Options include Inbound, Outbound, On-net, Off-net, Missed, Received, or integer type 0,1,2,3", "required": false, "example": "Off-net", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CdrD" } } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/cdrs": { "get": { "summary": " Read CDRs for Specific User", "deprecated": false, "description": "", "tags": [ "CDR (Call History)" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "datetime-start", "in": "query", "description": "", "required": true, "example": "2023-11-27T13:00:00Z[US/Pacific]", "schema": { "$ref": "#/components/schemas/DatetimeStart" } }, { "name": "datetime-end", "in": "query", "description": "", "required": true, "example": "2023-11-27T13:00:00Z[US/Pacific]", "schema": { "$ref": "#/components/schemas/DatetimeEnd" } }, { "name": "start", "in": "query", "description": "Offset of the first record to return, starting at 0. Increase by `limit` for each page.", "required": false, "example": 0, "schema": { "$ref": "#/components/schemas/Start", "type": "integer", "minimum": 0 } }, { "name": "limit", "in": "query", "description": "Records per page. Defaults to 100, maximum 100. Higher values, or more than one `limit` parameter, are rejected with 400. Page through results with `start`.", "required": false, "schema": { "$ref": "#/components/schemas/Limit", "type": "integer", "minimum": 1, "maximum": 100, "default": 100 }, "example": 100 }, { "name": "type", "in": "query", "description": "Options include Inbound, Outbound, On-net, Off-net, Missed, Received, or integer type 0,1,2,3", "required": false, "example": "Off-net", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CdrU" } } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/cdrs/count": { "get": { "summary": "Count CDRs and SUM minutes", "deprecated": false, "description": "", "tags": [ "CDR (Call History)" ], "parameters": [ { "name": "datetime-start", "in": "query", "description": "", "required": true, "example": "2023-11-27T13:00:00Z[US/Pacific]", "schema": { "$ref": "#/components/schemas/DatetimeStart" } }, { "name": "datetime-end", "in": "query", "description": "", "required": true, "example": "2023-11-27T13:00:00Z[US/Pacific]", "schema": { "$ref": "#/components/schemas/DatetimeEnd" } }, { "name": "type", "in": "query", "description": "Options include Inbound, Outbound, On-net, Off-net, Missed, Received, or integer type 0,1,2,3", "required": false, "example": "3", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Count" }, "example": { "total": 1767066, "minutes": 806111, "seconds": 48366615 } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/cdrs/count": { "get": { "summary": "Count CDRs and SUM minutes for Domain", "deprecated": false, "description": "", "tags": [ "CDR (Call History)" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "datetime-start", "in": "query", "description": "", "required": true, "example": "2023-11-27T13:00:00Z[US/Pacific]", "schema": { "$ref": "#/components/schemas/DatetimeStart" } }, { "name": "datetime-end", "in": "query", "description": "", "required": true, "example": "2023-11-27T14:00:00Z[US/Pacific]", "schema": { "$ref": "#/components/schemas/DatetimeEnd" } }, { "name": "type", "in": "query", "description": "Options include Inbound, Outbound, On-net, Off-net, Missed, Received, or integer type 0,1,2,3", "required": false, "example": "3", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Count" }, "example": { "total": 1768153, "minutes": 806496, "seconds": 48389714 } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/cdrs/count": { "get": { "summary": "Count CDRs and SUM minutes for Specifc User", "deprecated": false, "description": "", "tags": [ "CDR (Call History)" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "datetime-start", "in": "query", "description": "", "required": true, "example": "2023-11-27T13:00:00Z[US/Pacific]", "schema": { "$ref": "#/components/schemas/DatetimeStart" } }, { "name": "datetime-end", "in": "query", "description": "", "required": true, "example": "2023-11-27T13:00:00Z[US/Pacific]", "schema": { "$ref": "#/components/schemas/DatetimeEnd" } }, { "name": "type", "in": "query", "description": "Options include Inbound, Outbound, On-net, Off-net, Missed, Received, or integer type 0,1,2,3", "required": false, "example": "3", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Count" }, "example": { "total": 12, "minutes": 120, "seconds": 7176 } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/schedule/count": { "get": { "summary": "Count CDR Schedules for Domain", "deprecated": false, "description": "", "tags": [ "CDR Schedule" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Count" }, "example": { "total": 3 } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 403, "message": "Domain not found or access denied" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 404, "message": "Domain domain does not exist" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/schedule/{schedule_name}/count": { "get": { "summary": "Count CDR Schedules by Name", "deprecated": false, "description": "", "tags": [ "CDR Schedule" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "schedule_name", "in": "path", "description": "", "required": true, "example": "{{schedule}}", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Count" }, "example": { "total": 1 } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 403, "message": "Domain not found or access denied" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 404, "message": "Domain domain does not exist" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/sipflow": { "get": { "summary": "Get Call Trace (SIPFlow) For Call", "deprecated": false, "description": "", "operationId": "GetSipFlow", "tags": [ "Call Traces & Cradle to Grave" ], "parameters": [ { "name": "start_time", "in": "query", "description": "", "required": false, "example": "", "schema": { "type": "string" } }, { "name": "end_time", "in": "query", "description": "", "required": false, "example": "", "schema": { "type": "string" } }, { "name": "callids", "in": "query", "description": "", "required": false, "example": "", "schema": { "type": "string" } }, { "name": "servers", "in": "query", "description": "", "required": true, "example": "eng0-san.example.com", "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "call_trace,cradle_to_grave,csv", "required": true, "example": "call_trace", "schema": { "type": "string" } }, { "name": "download", "in": "query", "description": "Set to yes to download the file instead of getting base64 data in JSON. ", "required": false, "example": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": [ { "sql": [ "my-random-unique-callid", "20230727222818052294-6cc082866aafdc5dee7a480c2d339c76", "20230727222212051631-6cc082866aafdc5dee7a480c2d339c76", "20230727222205051625-6cc082866aafdc5dee7a480c2d339c76", "20230727222812052284-6cc082866aafdc5dee7a480c2d339c76" ], "svg": "<svg width="100%" xmlns="http://www.w3.org/2000/svg" id="nsflow_ea98c1da65ce01046c5ca2b574be33ea" style="min-height:100vh;max-height: 1885px;"><title>Callflow</title><style>@import url("https://vb.netsapiens.com/portal/nsflow/bundle.css");</style><foreignObject class="flow" width="100%" height="100%"><div xmlns="http://www.w3.org/1999/xhtml" class="flow-svg-wrapper" style="max-height: 100vh;"></div></foreignObject><script><![CDATA[
var nsflow_ea98c1da65ce01046c5ca2b574be33ea = { "devices" : {"eng0-san.netsapiens.com":{"index":1,"last":57,"name":""},"192.81.236.31:5060":{"index":2,"last":57,"name":"srv.lcr.thinq.com","match":"sip:*@srv.lcr.thinq.com","number":"19168475801"}},  "msgs" : [{"msg":["gSBusRcvCallControl - \n\t(action):(call)\n\t(auto):(no)\n\t(callid):(my-random-unique-callid)\n\t(destination):(sip:18587645200@portal)\n\t(object):(call)\n\t(origination):(19168475801)\n\t(uid):(2000@portal)","CB2BProxyAgent::GetNewSession by (CB2BProxyAgent::MakeCall)- SessionKey=&lt;20230727222205051624&gt;(3) - created","ProxyAgent::MakeCall(20230727222205051624)\n\tRequest=&#039;Call-To-Talk&#039;\n\tUID=&lt;2000@portal&gt;\n\tCallId=&#039;my-random-unique-callid&#039;\n\tAni=&#039;&#039;\n\tCbAni=&#039;&#039;\n\tOrigination=&#039;19168475801&#039;\n\tDestination=&#039;sip:18587645200@portal&#039;","CNmsUaSessionStateIdle(20230727222205051624)::SetPreTalkTimeout to 1800s at &#039;2023-07-27 22:52:05&#039;","CNmsUaSessionStateCallBack(20230727222205051624)::LookupResponder(Call-To-Talk)\n\t- Found mode=(playback)","CNmsUaSessionStateCallBack(20230727222205051624)::CheckTimeout\n\tcallID        =&#039;20230727222205051625-6cc082866aafdc5dee7a480c2d339c76&#039;\n\tresponder      &lt;Call-To-Talk&gt;\n\tmatch         =&lt;Call-To-Talk&gt;\n\tcallback      =&lt;19168475801&gt;\n\tby            =&lt;2000@portal&gt;\n\trequestID     =&#039;my-random-unique-callid&#039;\n\trequestName   =&#039;&#039;\n\tparameter     =&#039;&#039;\n\tmessage       =&#039;&#039;\n\tbcfrmRequired =false\n\t#retry        =0\n\tretryPeriod   =0","CNmsUaSessionStateCallBack(20230727222205051624)::CheckTimeout - Lookup Origination Subscriber\n\torigUid         &lt;2000@portal&gt;\n\torigName       =&quot;Pete TheReseller&quot;\n\torigSrvCode    =()","CNmsUaSessionStateCallBack(20230727222205051624)::CheckTimeout - Lookup Destination Subscriber\n\tcallbackAddr   =&lt;19168475801&gt;\n\tmatchDest by   =(callbackAddr)&lt;19168475801&gt;\n\t- Destination User not found","CNmsUaSessionStateCallBack(20230727222205051624)::CheckTimeout - construct Destinations\n\tcallback        &lt;19168475801&gt;\n\tfromUri        =&lt;sip:8587645200@portal&gt;\n\trspMatch       =(Call-To-Talk)\n\t - Ring to &lt;19168475801&gt;","CNmsUaSessionStateCallBack(20230727222205051624)::ApplyDialPlan(0,1024) Last Plan &lt;portal&gt;\n\towner       &lt;2000@portal&gt;\n\tcaller      &lt;2000@portal&gt;\n\tsearchedBy  (from=&lt;sip:8587645200@portal&gt;, to=&lt;19168475801&gt;, date=&#039;2023-07-27&#039;,dow=&#039;4&#039;,tod=&#039;15:22&#039;)\n\tmatchedFrom (*)\n\tmatchedTo   (*)\n\tselectedRule(chain to default)\n\tapps       =&lt;&lt;Default&gt;&lt;Cloud PBX Features&gt;&gt;\n\tTranslate\n\t\t  To-URI from (19168475801) by ([*])([*]) to (19168475801@)\n\t\tFrom-URI from (sip:8587645200@portal) by ([*])([*])([*]) to (sip:8587645200@portal)","CNmsUaSessionStateCallBack(20230727222205051624)::ApplyDialPlan(1,1023) &lt;Default&gt;\n\towner       &lt;2000@portal&gt;\n\tcaller      &lt;2000@portal&gt;\n\tsearchedBy  (from=&lt;sip:8587645200@portal&gt;, to=&lt;19168475801&gt;, date=&#039;2023-07-27&#039;,dow=&#039;4&#039;,tod=&#039;15:22&#039;)\n\tmatchedFrom (*)\n\tmatchedTo   (1[2-9][0-9][0-9][1-9][0-9][0-9][0-9][0-9][0-9][0-9])\n\tselectedRule(Forward to Domestic 11-Digit)\n\tapps       =&lt;sip:start@to-device&gt;\n\tTranslate\n\t\t  To-URI from (19168475801@) by ([*])(&lt;OwnDomain&gt;) to (sip:19168475801@portal)\n\t\tFrom-URI from (sip:8587645200@portal) by ([*])([*])([*]) to (sip:8587645200@portal)","CNmsUaSessionStateCallBack(20230727222205051624)::CheckDialPolicy(0)&lt;US and Canada&gt;\n\tagainst (sip:19168475801@portal)\n\t match &lt;*&gt;(Permit All) - (permit)","CNmsUaSessionStateOInvitingSetup(20230727222205051624)::LoadRoute\n\tbtn          =(8587645200)\n\t- found route for\n\t\tfrom         =&lt;sip:8587645200@portal&gt;\n\t\tto           =&lt;sip:19168475801@portal&gt;\n\t\ttoUri        =&lt;sip:19168475801@portal&gt;\n\t\tat            &lt;eng0-san.netsapiens.com&gt;\n\t\tselect        &lt;US Domestic Call&gt; (*)(sip:1??????????@*)\n\t\twith          3 fixed connections.","CNmsUaSessionStateOInvitingSetup(20230727222205051624)::LookupRegisteredUA(sip:19168475801@srv.lcr.thinq.com)\n\tFromUri      =&lt;&lt;sip:8587645200@portal&gt;&gt;\n\tbSRing       =false\n\t- found no match","CNmsUaSessionStateOInvitingSetup(20230727222205051624)::LookupGateway for User &lt;2000@portal&gt;(sip:19168475801@srv.lcr.thinq.com)\n\tfound        &lt;sip:*@srv.lcr.thinq.com&gt;(srv.lcr.thinq.com)\n\tbWanGW      =true\n\tbIsNcs      =false\n\t- PidfLo not required\n\tOrigDomain  =&lt;portal&gt;\n\tTermDomain  =&lt;*&gt;\n\tByDomain    =&lt;portal&gt;\n\tBySessionKey=(eng0-san.netsapiens.com:2000@portal:20230727222205051624)\n\tdomain&lt;portal&gt;, external=true - no limit\n\tforceCidRplc=false\n\tbIsAnonymous=false - SRV returned 3 records.","CNmsUaSessionStateOInvitingSetup(20230727222205051624)::LookupRoute\n\tto            (sip:19168475801@portal)\n\tfrom          &lt;sip:8587645200@portal&gt;\n\tbSRing       =false\n\tselect        (1) Chain(1,3) Route(US Domestic Call) Connection(1):&lt;[*]@srv.lcr.thinq.com&gt; To &lt;sip:19168475801@srv.lcr.thinq.com&gt;","CNmsUaSessionStateOInvitingSetup(20230727222205051624)::LookupRegisteredUA(sip:19168475801@srv.lcr.thinq.com)\n\tFromUri      =&lt;&lt;sip:8587645200@portal&gt;&gt;\n\tbSRing       =false\n\t- found no match","CNmsUaSessionStateOInvitingSetup(20230727222205051624)::LookupGateway::SetSipTransport(sip:19168475801@srv.lcr.thinq.com)\n\tto           (UdpV4) &lt;10.200.1.11:5060&gt;","CNmsUaSessionStateOInvitingSetup(20230727222205051624)::LookupGateway from Contact\n\tinsertAddress  (192.81.236.31)\n\ttrimmed        (192.81.236.31)\n\tto Leg for  GW=&lt;sip:19168475801@srv.lcr.thinq.com&gt;","CNmsUaSessionStateOInvitingSetup(20230727222205051624)::UpdateRtpRelay fwrd=&lt;sip:19168475801@srv.lcr.thinq.com&gt; orig=&lt;sip:19168475801@srv.lcr.thinq.com&gt; bNoPortChange=false - requested forward Audio Relay (25496)","CNmsUaSessionStateOInvitingSetup(20230727222205051624)::LookupGateway for User &lt;2000@portal&gt;(sip:19168475801@srv.lcr.thinq.com)\n\tfound        &lt;sip:*@srv.lcr.thinq.com&gt;(srv.lcr.thinq.com)\n\tbWanGW      =true\n\tbIsNcs      =false\n\t- PidfLo not required\n\tOrigDomain  =&lt;portal&gt;\n\tTermDomain  =&lt;*&gt;\n\tByDomain    =&lt;portal&gt;\n\tBySessionKey=(eng0-san.netsapiens.com:2000@portal:20230727222205051624)\n\tdomain&lt;portal&gt;, session already exist but not external - no limit\n\tforceCidRplc=false\n\tbIsAnonymous=false\n\t(Host from SRV): lcr-lb01.rdu.thinq.com:5060\n\tat FQDN      &lt;lcr-lb01.rdu.thinq.com&gt; (v4)\n\tresolved to  &lt;192.81.236.31&gt; and port (5060)\n\ttranslate\n\t\tTo-URI   from (19168475801@srv.lcr.thinq.com) by ([*]@srv.lcr.thinq.com) to (sip:19168475801@srv.lcr.thinq.com)\n\t\tFrom-URI from (&lt;sip:8587645200@portal&gt;) by ([*]@netsapiens.com) to (&lt;sip:8587645200@netsapiens.com&gt;)\n\tfwrdFromUri =(&lt;sip:8587645200@netsapiens.com&gt;)","CNmsUaSessionStateOInvitingSetup(20230727222205051624)::LookupRoute\n\tto            (sip:19168475801@portal)\n\tfrom          &lt;sip:8587645200@portal&gt;\n\tbSRing       =false\n\tselect        (2) Chain(1,5) Route(US Domestic Call) Connection(1):&lt;[*]@srv.lcr.thinq.com&gt; To &lt;sip:19168475801@srv.lcr.thinq.com&gt;","CNmsUaSessionStateOInvitingSetup(20230727222205051624)::SetRouteTimeout to 9s at &#039;2023-07-27 22:22:14&#039;","CNmsUaSessionStateOInvitingSetup(20230727222205051624)::OnEntry\n\tbRegistrationExpired=false\n\tbFoundRegisteredUA  =false\n\tbPendingRegistration=false\n\tbDndExceptionPending=false\n\tFromUri             =(&lt;sip:8587645200@portal&gt;)\n\tisPushedAndPending  =false","CSipSessionLeg(sip:19168475801@srv.lcr.thinq.com)::IsPendingFulfilled\n\t- not pending","CNmsUaSessionStateOInvitingSetup(20230727222205051624)::CheckTimeout\n\t- change state to OInviting","CNmsUaSessionStateOInviting(20230727222205051624)::MakeOriginalInvite\n\turiFrom       =(&lt;sip:8587645200@netsapiens.com&gt;)\n\turiTo         =(&lt;sip:19168475801@srv.lcr.thinq.com&gt;)\n\tcallId        =(my-random-unique-callid)\n\tcseq          =200","CNmsUaSessionStateOInviting(20230727222205051624)::SendOriginalInvite\n\ttowards        &lt;sip:19168475801@srv.lcr.thinq.com&gt;\n\tat             (192.81.236.31:5060)\n\tcallID        =&lt;my-random-unique-callid&gt;\n\torigFromUri   =&lt;sip:19168475801@srv.lcr.thinq.com&gt;\n\tfrwdFromUri   =&lt;sip:19168475801@srv.lcr.thinq.com&gt;\n\torigReqFromUri=&lt;&lt;sip:8587645200@netsapiens.com&gt;&gt;","CNmsUaSessionStateOInviting(20230727222205051624)::SendRequest\n\tto                &lt;sip:19168475801@srv.lcr.thinq.com&gt;\n\tat                (192.81.236.31:5060) (UdpV4)\n\tviaTag           =(6AqWdhMpQe7kNBg31A5EEF)\n\tkey              =(6AqWdhMpQe7kNBg31A5EEF)\n\tCB2BProxyUACStateCalling(z9hG4bK6AqWdhMpQe7kNBg31A5EEFINVITE200)::SendInviteRequest\n\tto   192.81.236.31\n\tvia  (UDP)\n\t- sent","CNmsUaSessionStateOInviting(20230727222205051624)::SetAnswerTimeout by System Ring TO to 60s at &#039;2023-07-27 22:23:05&#039;","CNmsUaSessionStateOInviting(20230727222205051624)::SetRouteTimeout to 6s at &#039;2023-07-27 22:22:11&#039;"],"core":1,"edge":null,"method":"","ts_ms":"1690496525370","ts_text":"2023-07-27_22:22:05"},{"msg":"Sending to 192.81.236.31:5060 (UdpV4)\nINVITE sip:19168475801@srv.lcr.thinq.com SIP\/2.0\r\nVia: SIP\/2.0\/UDP 4.30.7.38:5060;branch=z9hG4bK6AqWdhMpQe7kNBg31A5EEF\r\nFrom: &lt;sip:8587645200@netsapiens.com&gt;;tag=6AqWdhMpQe7kNBg31A5EEF\r\nTo: &lt;sip:19168475801@srv.lcr.thinq.com&gt;\r\nCall-ID: my-random-unique-callid\r\nCSeq: 200 INVITE\r\nMax-Forwards: 20\r\nContact: &lt;sip:sdf@4.30.7.38:5060;transport=udp&gt;\r\nServer: NetSapiens SiPBx v43-4-0x15\r\nContent-Type: application\/sdp\r\nContent-Length: 284\r\n\r\nv=0\r\no=NetSapiens_Nms 1690496525 1690496525031 IN IP4 4.30.7.38\r\ns=SIP Media Description\r\nc=IN IP4 4.30.7.38\r\nt=0 0\r\nm=audio 25496 RTP\/AVP 0 8 13 101\r\na=rtpmap:0 PCMU\/8000\/1\r\na=rtpmap:8 PCMA\/8000\/1\r\na=rtpmap:13 CN\/8000\r\na=rtpmap:101 telephone-event\/8000\r\na=fmtp:101 0-15\r\na=sendrecv","core":1,"edge":2,"method":"INVITE","ts_ms":"1690496525532","ts_text":"2023-07-27_22:22:05"},{"msg":"Received Packet from 192.81.236.31:5060\nSIP\/2.0 100 Giving a try\r\nVia: SIP\/2.0\/UDP 10.200.1.11:5060;branch=z9hG4bK6AqWdhMpQe7kNBg31A5EEF\r\nFrom: &lt;sip:8587645200@netsapiens.com&gt;;tag=6AqWdhMpQe7kNBg31A5EEF\r\nTo: &lt;sip:19168475801@srv.lcr.thinq.com&gt;\r\nCall-ID: my-random-unique-callid\r\nCSeq: 200 INVITE\r\nServer: thinQ LB\r\nContent-Length: 0","core":1,"edge":2,"method":"100","ts_ms":"1690496525621","ts_text":"2023-07-27_22:22:05"},{"msg":["CNmsUaSessionStateOInviting::Receive (100) Response from 192.81.236.31 - turn off Route T\/O."],"core":1,"edge":null,"method":"","ts_ms":"1690496525624","ts_text":"2023-07-27_22:22:05"},{"msg":"Received Packet from 192.81.236.31:5060\nSIP\/2.0 183 Session Progress\r\nVia: SIP\/2.0\/UDP 10.200.1.11:5060;branch=z9hG4bK6AqWdhMpQe7kNBg31A5EEF\r\nCall-ID: my-random-unique-callid\r\nCSeq: 200 INVITE\r\nFrom: &lt;sip:8587645200@netsapiens.com&gt;;tag=6AqWdhMpQe7kNBg31A5EEF\r\nTo: &lt;sip:19168475801@srv.lcr.thinq.com&gt;;tag=sip+1+4f79007e+f68b740b\r\nServer: SIP\/2.0\r\nContent-Length: 216\r\nContact: &lt;sip:192.81.236.31;met=c34.b9e0e6a5&gt;\r\nContent-Type: application\/sdp\r\nAllow: INVITE,ACK,CANCEL,BYE,REFER,OPTIONS,NOTIFY,SUBSCRIBE,PRACK,INFO\r\nUser-Agent: ENSR3.0.66.72-IS1-RMRG40386-RG2216-CPO22754\r\n\r\nv=0\r\no=- 112369873742026 112369873742026 IN IP4 40.139.11.149\r\ns=-\r\nc=IN IP4 40.139.11.149\r\nt=0 0\r\nm=audio 53084 RTP\/AVP 0 101\r\na=sendrecv\r\na=rtpmap:0 PCMU\/8000\/1\r\na=rtpmap:101 telephone-event\/8000\r\na=fmtp:101 0-15","core":1,"edge":2,"method":"183","ts_ms":"1690496527618","ts_text":"2023-07-27_22:22:07"},{"msg":["CNmsUaSessionStateOInviting::Receive (183) Response from 192.81.236.31 - turn off Route T\/O."],"core":1,"edge":null,"method":"","ts_ms":"1690496527625","ts_text":"2023-07-27_22:22:07"},{"msg":"Received Packet from 192.81.236.31:5060\nSIP\/2.0 180 Ringing\r\nVia: SIP\/2.0\/UDP 10.200.1.11:5060;branch=z9hG4bK6AqWdhMpQe7kNBg31A5EEF\r\nCall-ID: my-random-unique-callid\r\nCSeq: 200 INVITE\r\nFrom: &lt;sip:8587645200@netsapiens.com&gt;;tag=6AqWdhMpQe7kNBg31A5EEF\r\nTo: &lt;sip:19168475801@srv.lcr.thinq.com&gt;;tag=sip+1+4f79007e+f68b740b\r\nServer: SIP\/2.0\r\nContent-Length: 216\r\nContact: &lt;sip:192.81.236.31;met=c34.b9e0e6a5&gt;\r\nContent-Type: application\/sdp\r\nAllow: INVITE,ACK,CANCEL,BYE,REFER,OPTIONS,NOTIFY,SUBSCRIBE,PRACK,INFO\r\nUser-Agent: ENSR3.0.66.72-IS1-RMRG40386-RG2216-CPO22754\r\n\r\nv=0\r\no=- 112369873742026 112369873742026 IN IP4 40.139.11.149\r\ns=-\r\nc=IN IP4 40.139.11.149\r\nt=0 0\r\nm=audio 53084 RTP\/AVP 0 101\r\na=sendrecv\r\na=rtpmap:0 PCMU\/8000\/1\r\na=rtpmap:101 telephone-event\/8000\r\na=fmtp:101 0-15","core":1,"edge":2,"method":"180","ts_ms":"1690496529114","ts_text":"2023-07-27_22:22:09"},{"msg":["CNmsUaSessionStateOInviting::Receive (180) Response from 192.81.236.31 - turn off Route T\/O."],"core":1,"edge":null,"method":"","ts_ms":"1690496529125","ts_text":"2023-07-27_22:22:09"},{"msg":"Received Packet from 192.81.236.31:5060\nSIP\/2.0 200 OK\r\nVia: SIP\/2.0\/UDP 10.200.1.11:5060;branch=z9hG4bK6AqWdhMpQe7kNBg31A5EEF\r\nCall-ID: my-random-unique-callid\r\nCSeq: 200 INVITE\r\nFrom: &lt;sip:8587645200@netsapiens.com&gt;;tag=6AqWdhMpQe7kNBg31A5EEF\r\nTo: &lt;sip:19168475801@srv.lcr.thinq.com&gt;;tag=sip+1+4f79007e+f68b740b\r\nServer: SIP\/2.0\r\nContent-Length: 216\r\nContact: &lt;sip:192.81.236.31;met=c34.b9e0e6a5&gt;\r\nContent-Type: application\/sdp\r\nAllow: INVITE,ACK,CANCEL,BYE,REFER,OPTIONS,NOTIFY,SUBSCRIBE,PRACK,INFO\r\nUser-Agent: ENSR3.0.66.72-IS1-RMRG40386-RG2216-CPO22754\r\n\r\nv=0\r\no=- 112369873742026 112369873742026 IN IP4 40.139.11.149\r\ns=-\r\nc=IN IP4 40.139.11.149\r\nt=0 0\r\nm=audio 53084 RTP\/AVP 0 101\r\na=sendrecv\r\na=rtpmap:0 PCMU\/8000\/1\r\na=rtpmap:101 telephone-event\/8000\r\na=fmtp:101 0-15","core":1,"edge":2,"method":"200","ts_ms":"1690496532117","ts_text":"2023-07-27_22:22:12"},{"msg":["CNmsUaSessionStateOInviting(20230727222205051624)::Process 200 OK\n\tTo           :&lt;sip:19168475801@srv.lcr.thinq.com&gt;;tag=sip+1+4f79007e+f68b740b\n\tfrom          &lt;192.81.236.31:5060&gt;","CNmsUaSessionStateOInviting(20230727222205051624)::ReconcileRtpPayloadList(21140)\n\tpcmOnly           =false)\n\tLocal  Media       (PCMU PCMA)\n\tRemote addr        (192.81.236.31:5060)\n\tRemote CSeq        (200 INVITE)\n\tRemote RTP Map     :\n\t\t (0 PCMU\/8000\/1) payloadType=0 media=(PCMU) timestampRate=(8000) channel=(1)\n\t\t (101 telephone-event\/8000) payloadType=101 media=(telephone-event) timestampRate=(8000) channel=(0)\n\n\tRemote Payload     (0 101)\n\tRemote Media       (PCMU telephone-event)\n\tMatching           :\n\t\t(PCMU) : (0)(8000) from RTP Map\n\t\t(PCMA) : not in remote map\n\tReconciled Payload (0)\n\t- Select           (PCMU) : (0) : (8000)","CNmsUaSessionStateOInviting(20230727222205051624)::UpdateCdrMedia from (200) Response Media=&#039;PCMU&#039; &lt;0 101&gt; Old=&#039;&#039; - update CDR","CNmsUaSessionStateOInviting(20230727222205051624) from SDP\n\tinsertAddress  (40.139.11.149)\n\ttrimmed        (40.139.11.149)\n\tto Leg for  GW=&lt;sip:19168475801@srv.lcr.thinq.com&gt;","CNmsUaSessionStateOInviting(20230727222205051624)::LookupResponder(sip:init@call-to-talk)\n\t- Found mode=(set_cdr)","CNmsUaSessionStateOInviting(20230727222205051624)::LookupNextResponder case(1)\n\tTranslate\n\t\tfrom &lt;19168475801@portal&gt;\n\t\tby   (init)(call-to-talk)\n\t\tto   (sip:init@call-to-talk)(sip:init@call-to-talk)\n\t- found responder\n\tName       =(Call To Talk - Init)\n\tMatch      =(sip:init@call-to-talk)\n\tMediaMode  =(set_cdr)\n\tP0         =(CdrOrigFromUri)\n\tP1         =(Call-To-Talk)\n\tNextUser0  =(n\/a)\n\tNextHost0  =(n\/a)\n\tNextUser1  =(init2)\n\tNextHost1  =(call-to-talk)","CNmsUaSessionStateSetCdr(20230727222205051624)::LookupResponder(sip:init2@call-to-talk)\n\t- Found mode=(set_cdr)","CNmsUaSessionStateSetCdr(20230727222205051624)::LookupNextResponder case(1)\n\tTranslate\n\t\tfrom &lt;init@call-to-talk&gt;\n\t\tby   (init2)(call-to-talk)\n\t\tto   (sip:init2@call-to-talk)(sip:init2@call-to-talk)\n\t- found responder\n\tName       =(Call To Talk - Init)\n\tMatch      =(sip:init2@call-to-talk)\n\tMediaMode  =(set_cdr)\n\tP0         =(CdrOrigToUser)\n\tP1         =(CallDestAddress)\n\tNextUser0  =(n\/a)\n\tNextHost0  =(n\/a)\n\tNextUser1  =(init3)\n\tNextHost1  =(call-to-talk)","CLiDfLic(Recording-Server2)::SendCdcTerminationAttempt(2000@portal)\n\t(AccessingElementId) : (sip:eng1-dfw@netsapiens.com)\n\t(Aor0) : (sip:19168475801@srv.lcr.thinq.com)\n\t(CallId) : (my-random-unique-callid)\n\t(CalledPartyId) : (sip:19168475801@srv.lcr.thinq.com)\n\t(CallingPartyId) : (Call-To-Talk)\n\t(CccId) : (125B)\n\t(Domain0) : (portal)\n\t(EventTime) : (2023-07-27 22:22:12)\n\t(Territory0) : (NetSapiens2)\n\t - for &lt;2000@portal&gt;","CLiDfLic(Recording-Server)::SendCdcTerminationAttempt(2000@portal)\n\t(AccessingElementId) : (sip:eng1-dfw@netsapiens.com)\n\t(Aor0) : (sip:19168475801@srv.lcr.thinq.com)\n\t(CallId) : (my-random-unique-callid)\n\t(CalledPartyId) : (sip:19168475801@srv.lcr.thinq.com)\n\t(CallingPartyId) : (Call-To-Talk)\n\t(CccId) : (125B)\n\t(Domain0) : (portal)\n\t(EventTime) : (2023-07-27 22:22:12)\n\t(Territory0) : (NetSapiens2)\n\t - for &lt;2000@portal&gt;","CLiDfLic(Recording-Server2)::SendCdcCCOpen(2000@portal)\n\t(AccessingElementId) : (sip:eng1-dfw@netsapiens.com)\n\t(Aor0) : (sip:19168475801@srv.lcr.thinq.com)\n\t(CallId) : (my-random-unique-callid)\n\t(CccId) : (125B)\n\t(Domain0) : (portal)\n\t(EventTime) : (2023-07-27 22:22:12)\n\t(RtpMap) : (a=rtpmap:0 PCMU\/8000\/1\na=rtpmap:101 telephone-event\/8000\na=fmtp:101 0-15\n)\n\t(Territory0) : (NetSapiens2)\n\t - for &lt;2000@portal&gt;","CLiDfLic(Recording-Server)::SendCdcCCOpen(2000@portal)\n\t(AccessingElementId) : (sip:eng1-dfw@netsapiens.com)\n\t(Aor0) : (sip:19168475801@srv.lcr.thinq.com)\n\t(CallId) : (my-random-unique-callid)\n\t(CccId) : (125B)\n\t(Domain0) : (portal)\n\t(EventTime) : (2023-07-27 22:22:12)\n\t(RtpMap) : (a=rtpmap:0 PCMU\/8000\/1\na=rtpmap:101 telephone-event\/8000\na=fmtp:101 0-15\n)\n\t(Territory0) : (NetSapiens2)\n\t - for &lt;2000@portal&gt;","CLiDfLic(Recording-Server2)::SendCdcAnswer(2000@portal)\n\t(AccessingElementId) : (sip:eng1-dfw@netsapiens.com)\n\t(AnsweringPartyId) : (sip:19168475801@srv.lcr.thinq.com)\n\t(Aor0) : (sip:19168475801@srv.lcr.thinq.com)\n\t(CallId) : (my-random-unique-callid)\n\t(CccId) : (125B)\n\t(Domain0) : (portal)\n\t(EventTime) : (2023-07-27 22:22:12)\n\t(Territory0) : (NetSapiens2)\n\t - for &lt;2000@portal&gt;","CLiDfLic(Recording-Server)::SendCdcAnswer(2000@portal)\n\t(AccessingElementId) : (sip:eng1-dfw@netsapiens.com)\n\t(AnsweringPartyId) : (sip:19168475801@srv.lcr.thinq.com)\n\t(Aor0) : (sip:19168475801@srv.lcr.thinq.com)\n\t(CallId) : (my-random-unique-callid)\n\t(CccId) : (125B)\n\t(Domain0) : (portal)\n\t(EventTime) : (2023-07-27 22:22:12)\n\t(Territory0) : (NetSapiens2)\n\t - for &lt;2000@portal&gt;","CLiDfLic(Recording-Server2)::SendCdcAnswer(2000@portal)\n\t(AccessingElementId) : (sip:eng1-dfw@netsapiens.com)\n\t(AnsweringPartyId) : (sip:19168475801@srv.lcr.thinq.com)\n\t(Aor0) : (sip:19168475801@srv.lcr.thinq.com)\n\t(CallId) : (my-random-unique-callid)\n\t(CccId) : (125B)\n\t(Domain0) : (portal)\n\t(EventTime) : (2023-07-27 22:22:12)\n\t(Territory0) : (NetSapiens2)\n\t - for &lt;2000@portal&gt;","CLiDfLic(Recording-Server)::SendCdcAnswer(2000@portal)\n\t(AccessingElementId) : (sip:eng1-dfw@netsapiens.com)\n\t(AnsweringPartyId) : (sip:19168475801@srv.lcr.thinq.com)\n\t(Aor0) : (sip:19168475801@srv.lcr.thinq.com)\n\t(CallId) : (my-random-unique-callid)\n\t(CccId) : (125B)\n\t(Domain0) : (portal)\n\t(EventTime) : (2023-07-27 22:22:12)\n\t(Territory0) : (NetSapiens2)\n\t - for &lt;2000@portal&gt;","CNmsUaSessionStateSetCdr(20230727222205051624)::CheckTimeout(CdrOrigToUser,CallDestAddress) - Dialed Number set to &lt;sip:18587645200@portal&gt;","CNmsUaSessionStateSetCdr(20230727222205051624)::LookupResponder(sip:init3@call-to-talk)\n\t- Found mode=(set_parameter)","CNmsUaSessionStateSetCdr(20230727222205051624)::LookupNextResponder case(1)\n\tTranslate\n\t\tfrom &lt;init2@call-to-talk&gt;\n\t\tby   (init3)(call-to-talk)\n\t\tto   (sip:init3@call-to-talk)(sip:init3@call-to-talk)\n\t- found responder\n\tName       =(Call To Talk - init)\n\tMatch      =(sip:init3@call-to-talk)\n\tMediaMode  =(set_parameter)\n\tP0         =(AccountUser)\n\tP1         =(CallReqAddress)\n\tNextUser0  =(n\/a)\n\tNextHost0  =(n\/a)\n\tNextUser1  =(start)\n\tNextHost1  =(call-to-talk)"],"core":1,"edge":null,"method":"","ts_ms":"1690496532135","ts_text":"2023-07-27_22:22:12"},{"msg":"Sending to 192.81.236.31:5060 (UdpV4)\nACK sip:192.81.236.31 SIP\/2.0\r\nVia: SIP\/2.0\/UDP 4.30.7.38:5060;branch=z9hG4bKyunC9pljoUtURhnx1A5EF0\r\nFrom: &lt;sip:8587645200@netsapiens.com&gt;;tag=6AqWdhMpQe7kNBg31A5EEF\r\nTo: &lt;sip:19168475801@srv.lcr.thinq.com&gt;;tag=sip+1+4f79007e+f68b740b\r\nCall-ID: my-random-unique-callid\r\nCSeq: 200 ACK\r\nMax-Forwards: 20\r\nContent-Length: 0","core":1,"edge":2,"method":"ACK","ts_ms":"1690496532175","ts_text":"2023-07-27_22:22:12"},{"msg":["SetParameter - User &lt;2000@portal&gt; entered.","CNmsUaSessionStateSetParameter(20230727222205051624)::LookupResponder(sip:start@call-to-talk)\n\t- Found mode=(forward_call)","CNmsUaSessionStateSetParameter(20230727222205051624)::LookupNextResponder case(1)\n\tTranslate\n\t\tfrom &lt;2000@portal&gt;\n\t\tby   (start)(call-to-talk)\n\t\tto   (sip:start@call-to-talk)(sip:start@call-to-talk)\n\t- found responder\n\tName       =(Call To Talk - Forward Call)\n\tMatch      =(sip:start@call-to-talk)\n\tMediaMode  =(forward_call)\n\tP0         =(AccountUser)\n\tP1         =(CallDestAddress)\n\tNextUser0  =(n\/a)\n\tNextHost0  =(n\/a)\n\tNextUser1  =(n\/a)\n\tNextHost1  =(n\/a)","CNmsUaSessionStateForwardCall(20230727222205051624)::ApplyDialPlan(0,1022) Last Plan &lt;portal&gt;\n\towner       &lt;2000@portal&gt;\n\tcaller      &lt;2000@portal&gt;\n\tsearchedBy  (from=&lt;sip:19168475801@srv.lcr.thinq.com&gt;, to=&lt;sip:18587645200@portal&gt;, date=&#039;2023-07-27&#039;,dow=&#039;4&#039;,tod=&#039;15:22&#039;)\n\tmatchedFrom (*)\n\tmatchedTo   (*)\n\tselectedRule(chain to default)\n\tapps       =&lt;&lt;Default&gt;&lt;Cloud PBX Features&gt;&gt;\n\tTranslate\n\t\t  To-URI from (sip:18587645200@portal) by ([*])([*]) to (sip:18587645200@portal)\n\t\tFrom-URI from (sip:19168475801@srv.lcr.thinq.com) by ([*])([*])([*]) to (sip:19168475801@srv.lcr.thinq.com)","CNmsUaSessionStateForwardCall(20230727222205051624)::ApplyDialPlan(1,1021) &lt;Default&gt;\n\towner       &lt;2000@portal&gt;\n\tcaller      &lt;2000@portal&gt;\n\tsearchedBy  (from=&lt;sip:19168475801@srv.lcr.thinq.com&gt;, to=&lt;sip:18587645200@portal&gt;, date=&#039;2023-07-27&#039;,dow=&#039;4&#039;,tod=&#039;15:22&#039;)\n\tmatchedFrom (*)\n\tmatchedTo   (sip:1[2-9][0-9][0-9][1-9][0-9][0-9][0-9][0-9][0-9][0-9]@*)\n\tselectedRule(11-Digit DID)\n\tapps       =&lt;&lt;DID Table&gt; &lt;To Connection&gt;&gt;\n\tTranslate\n\t\t  To-URI from (sip:18587645200@portal) by ([*])(&lt;OwnDomain&gt;) to (sip:18587645200@portal)\n\t\tFrom-URI from (sip:19168475801@srv.lcr.thinq.com) by (&lt;OwnCidName&gt;)(&lt;OwnCidNmbr&gt;)(&lt;OwnDomain&gt;) to (&quot;netsapiens&quot; &lt;sip:8587645200@portal&gt;)","CNmsUaSessionStateForwardCall(20230727222205051624)::ApplyDialPlan(2,1020) &lt;DID Table&gt;\n\t(from=&lt;sip:8587645200@portal&gt;, to=&lt;sip:18587645200@portal&gt;, date=&#039;2023-07-27&#039;,dow=&#039;4&#039;,tod=&#039;15:22&#039;)\n\t - does not match any rule","CNmsUaSessionStateForwardCall(20230727222205051624)::ApplyDialPlan(3,1019) &lt;To Connection&gt;\n\towner       &lt;2000@portal&gt;\n\tcaller      &lt;2000@portal&gt;\n\tsearchedBy  (from=&lt;sip:8587645200@portal&gt;, to=&lt;sip:18587645200@portal&gt;, date=&#039;2023-07-27&#039;,dow=&#039;4&#039;,tod=&#039;15:22&#039;)\n\tmatchedFrom (*)\n\tmatchedTo   (*)\n\tselectedRule(To Connection)\n\tapps       =&lt;sip:start@to-connection&gt;\n\tTranslate\n\t\t  To-URI from (sip:18587645200@portal) by ([*])([*]) to (sip:18587645200@portal)\n\t\tFrom-URI from (&quot;netsapiens&quot; &lt;sip:8587645200@portal&gt;) by ([*])([*])([*]) to (&quot;netsapiens&quot; &lt;sip:8587645200@portal&gt;)","CNmsUaSessionStateForwardCall(20230727222205051624)::CheckDialPolicy(0)&lt;US and Canada&gt;\n\tagainst (sip:18587645200@portal)\n\t match &lt;*&gt;(Permit All) - (permit)","CNmsUaSessionStateForwardCall(20230727222205051624)::CheckTimeout (AccountUser,CallDestAddress)\n\tdialPlanFor=&lt;2000@portal&gt;\n\tdialPlan   =&lt;portal&gt;\n\tdestination=&lt;sip:18587645200@portal&gt;\n\t- new OutInvCdr\n\tforwardUri =&lt;sip:18587645200@portal&gt;","CNmsUaSessionStateForwardCall(20230727222205051624)::LookupResponder(sip:start@to-connection)\n\t- Found mode=(invite_call)","CNmsUaSessionStateForwardCall(20230727222205051624)::SwitchToApplication(sip:start@to-connection)\n\t- found responder\n\tName       =(To Connection)\n\tMatch      =(sip:start@to-connection)\n\tMediaMode  =(invite_call)\n\tP0         =(CallOutbound)\n\tP1         =(n\/a)\n\tNextUser0  =(chk-next-call)\n\tNextHost0  =(talk-return)\n\tNextUser1  =([*])\n\tNextHost1  =(talking)","CNmsUaSessionStateConnectDevice(20230727222205051624)::LoadRoute\n\tbtn          =(8587645200)\n\t- found route for\n\t\tfrom         =&lt;sip:8587645200@portal&gt;\n\t\tto           =&lt;sip:18587645200@portal&gt;\n\t\ttoUri        =&lt;sip:18587645200@portal&gt;\n\t\tat            &lt;eng0-san.netsapiens.com&gt;\n\t\tselect        &lt;US Domestic Call&gt; (*)(sip:1??????????@*)\n\t\twith          3 fixed connections.","CNmsUaSessionStateConnectDevice(20230727222205051624)::LookupRegisteredUA(sip:18587645200@srv.lcr.thinq.com)\n\tFromUri      =&lt;&quot;netsapiens&quot; &lt;sip:8587645200@portal&gt;&gt;\n\tbSRing       =false\n\t- found no match","CNmsUaSessionStateConnectDevice(20230727222205051624)::LookupGateway(sip:18587645200@srv.lcr.thinq.com)\n\tfound        &lt;sip:*@srv.lcr.thinq.com&gt;(srv.lcr.thinq.com)\n\tbWanGW      =true\n\tbIsNcs      =false\n\t- PidfLo not required\n\tOrigDomain  =&lt;portal&gt;\n\tTermDomain  =&lt;*&gt;\n\tByDomain    =&lt;portal&gt;\n\tBySessionKey=(eng0-san.netsapiens.com:2000@portal:20230727222205051624)\n\tdomain&lt;portal&gt;, session already exist but not external - no limit\n\tforceCidRplc=false\n\tbIsAnonymous=false - SRV returned 3 records.","CNmsUaSessionStateConnectDevice(20230727222205051624)::LookupRoute\n\tto            (sip:18587645200@portal)\n\tfrom          &lt;sip:8587645200@portal&gt;\n\tbSRing       =false\n\tselect        (1) Chain(1,3) Route(US Domestic Call) Connection(1):&lt;[*]@srv.lcr.thinq.com&gt; To &lt;sip:18587645200@srv.lcr.thinq.com&gt;","CNmsUaSessionStateConnectDevice(20230727222205051624)::LookupRegisteredUA(sip:18587645200@srv.lcr.thinq.com)\n\tFromUri      =&lt;&quot;netsapiens&quot; &lt;sip:8587645200@portal&gt;&gt;\n\tbSRing       =false\n\t- found no match","CNmsUaSessionStateConnectDevice(20230727222205051624)::LookupGateway::SetSipTransport(sip:18587645200@srv.lcr.thinq.com)\n\tto           (UdpV4) &lt;10.200.1.11:5060&gt;","CNmsUaSessionStateConnectDevice(20230727222205051624)::LookupGateway from Contact\n\tinsertAddress  (192.81.236.31)\n\ttrimmed        (192.81.236.31)\n\tto Leg for  GW=&lt;sip:18587645200@srv.lcr.thinq.com&gt;","CNmsUaSessionStateConnectDevice(20230727222205051624)::UpdateRtpRelay fwrd=&lt;sip:18587645200@srv.lcr.thinq.com&gt; orig=&lt;sip:19168475801@srv.lcr.thinq.com&gt;\/(25496) bNoPortChange=false - requested forward Audio Relay (25000)","CNmsUaSessionStateConnectDevice(20230727222205051624)::LookupGateway(sip:18587645200@srv.lcr.thinq.com)\n\tfound        &lt;sip:*@srv.lcr.thinq.com&gt;(srv.lcr.thinq.com)\n\tbWanGW      =true\n\tbIsNcs      =false\n\t- PidfLo not required\n\tOrigDomain  =&lt;portal&gt;\n\tTermDomain  =&lt;*&gt;\n\tByDomain    =&lt;portal&gt;\n\tBySessionKey=(eng0-san.netsapiens.com:2000@portal:20230727222205051624)\n\tdomain&lt;portal&gt;, session already exist but not external - no limit\n\tforceCidRplc=false\n\tbIsAnonymous=false\n\t(Host from SRV): lcr-lb01.rdu.thinq.com:5060\n\tat FQDN      &lt;lcr-lb01.rdu.thinq.com&gt; (v4)\n\tresolved to  &lt;192.81.236.31&gt; and port (5060)\n\ttranslate\n\t\tTo-URI   from (18587645200@srv.lcr.thinq.com) by ([*]@srv.lcr.thinq.com) to (sip:18587645200@srv.lcr.thinq.com)\n\t\tFrom-URI from (&quot;netsapiens&quot; &lt;sip:8587645200@portal&gt;) by ([*]@netsapiens.com) to (&quot;netsapiens&quot; &lt;sip:8587645200@netsapiens.com&gt;)\n\tfwrdFromUri =(&quot;netsapiens&quot; &lt;sip:8587645200@netsapiens.com&gt;)","CNmsUaSessionStateConnectDevice(20230727222205051624)::LookupRoute\n\tto            (sip:18587645200@portal)\n\tfrom          &lt;sip:8587645200@portal&gt;\n\tbSRing       =false\n\tselect        (2) Chain(1,5) Route(US Domestic Call) Connection(1):&lt;[*]@srv.lcr.thinq.com&gt; To &lt;sip:18587645200@srv.lcr.thinq.com&gt;","CNmsUaSessionStateConnectDevice(20230727222205051624)::SetupForwardLeg(0) &lt;sip:18587645200@portal&gt;\n\torigAor          =&lt;sip:19168475801@srv.lcr.thinq.com&gt;\n\tcallID           =(20230727222212051631-6cc082866aafdc5dee7a480c2d339c76)\n\tfromUri          =(&quot;netsapiens&quot; &lt;sip:8587645200@portal&gt;) from Original Leg","CNmsUaSessionStateConnectDevice(20230727222205051624)::SetRouteTimeout to 9s at &#039;2023-07-27 22:22:21&#039;","CNmsUaSessionStateConnectDevice(20230727222205051624)::OnEntry\n\tbRegistrationExpired=false\n\tbFoundRegisteredUA  =false\n\tbPendingRegistration=false\n\tbDndExceptionPending=false\n\tbLoopDetected       =false\n\tvia Connection       (srv.lcr.thinq.com)\/(sip*@srv.lcr.thinq.com)\n\tbIsPushedAndPending =false","CSipSessionLeg(sip:18587645200@srv.lcr.thinq.com)::IsPendingFulfilled\n\t- not pending","CNmsUaSessionStateConnectDevice(20230727222205051624)::CheckTimeout\n\t- change state to Connecting","CNmsUaSessionStateConnecting(20230727222205051624)::SendForwardInvite\n\tbForceUnHold     = true\n\tuDeltaSecond     = 0\n\tuUacTimeOutSec   = 0\n\tbIsOrigGeo       =false\n\tbIsOrigGw        =true\n\tbIsTermNcs       =false\n\tbIsStateInviting =(false)\n\tbBlockAlertInfo  =(true)\n\t- make Invite from pOriginalLeg&lt;sip:19168475801@srv.lcr.thinq.com&gt;&#039;s Response\n\tbIsWanUA         = true\n\ttowards           &lt;sip:18587645200@srv.lcr.thinq.com&gt;\n\tat                (192.81.236.31:5060)","CNmsUaSessionStateConnecting(20230727222205051624)::SendRequest\n\tto                &lt;sip:18587645200@srv.lcr.thinq.com&gt;\n\tat                (192.81.236.31:5060) (UdpV4)\n\tviaTag           =(Pw2TBlHnzKo93E1a1A5EF2)\n\tkey              =(e4GIPxrDg48YXznf1A5EF1)\n\tCB2BProxyUACStateCalling(z9hG4bKPw2TBlHnzKo93E1a1A5EF2INVITE201)::SendInviteRequest\n\tto   192.81.236.31\n\tvia  (UDP)\n\t- sent","CNmsUaSessionStateConnecting(20230727222205051624)::SetAnswerTimeout by System Ring TO to 60s at &#039;2023-07-27 22:23:12&#039;","CNmsUaSessionStateConnecting(20230727222205051624)::SetRouteTimeout to 6s at &#039;2023-07-27 22:22:18&#039;","CMediaPlayback(21140)::Initialize\n\tRfc2833 Type=101\n\tpayloadType =(0)\n\tmediaName   =(PCMU)\n\tto           &lt;10.200.1.11:25498&gt;\n\tfrom         &lt;\/usr\/local\/NetSapiens\/SiPbx\/data\/portal\/domain\/audio\/&gt; (phrase-call-is-being-forwarded.wav)"],"core":1,"edge":null,"method":"","ts_ms":"1690496532179","ts_text":"2023-07-27_22:22:12"},{"msg":"Sending to 192.81.236.31:5060 (UdpV4)\nINVITE sip:18587645200@srv.lcr.thinq.com SIP\/2.0\r\nVia: SIP\/2.0\/UDP 4.30.7.38:5060;branch=z9hG4bKPw2TBlHnzKo93E1a1A5EF2\r\nFrom: &quot;netsapiens&quot; &lt;sip:8587645200@netsapiens.com&gt;;tag=e4GIPxrDg48YXznf1A5EF1\r\nTo: &lt;sip:18587645200@srv.lcr.thinq.com&gt;\r\nCall-ID: 20230727222212051631-6cc082866aafdc5dee7a480c2d339c76\r\nCSeq: 201 INVITE\r\nMax-Forwards: 20\r\nContact: &lt;sip:sdf@4.30.7.38:5060;transport=udp&gt;\r\nServer: NetSapiens SiPBx v43-4-0x15\r\nContent-Type: application\/sdp\r\nContent-Length: 238\r\n\r\nv=0\r\no=NetSapiens_Nms 1690496532 1690496532032 IN IP4 4.30.7.38\r\ns=-\r\nc=IN IP4 4.30.7.38\r\nt=0 0\r\nm=audio 25000 RTP\/AVP 0 101 13\r\na=sendrecv\r\na=rtpmap:0 PCMU\/8000\/1\r\na=rtpmap:101 telephone-event\/8000\r\na=fmtp:101 0-15\r\na=rtpmap:13 CN\/8000","core":1,"edge":2,"method":"INVITE","ts_ms":"1690496532256","ts_text":"2023-07-27_22:22:12"},{"msg":"Received Packet from 192.81.236.31:5060\nSIP\/2.0 100 Giving a try\r\nVia: SIP\/2.0\/UDP 10.200.1.11:5060;branch=z9hG4bKPw2TBlHnzKo93E1a1A5EF2\r\nFrom: &quot;netsapiens&quot; &lt;sip:8587645200@netsapiens.com&gt;;tag=e4GIPxrDg48YXznf1A5EF1\r\nTo: &lt;sip:18587645200@srv.lcr.thinq.com&gt;\r\nCall-ID: 20230727222212051631-6cc082866aafdc5dee7a480c2d339c76\r\nCSeq: 201 INVITE\r\nServer: thinQ LB\r\nContent-Length: 0","core":1,"edge":2,"method":"100","ts_ms":"1690496532340","ts_text":"2023-07-27_22:22:12"},{"msg":["CNmsUaSessionStateConnecting(20230727222205051624)::Process (100) Response\n\tfrom        &lt;192.81.236.31&gt;\n\tcallID     =&lt;20230727222212051631-6cc082866aafdc5dee7a480c2d339c76&gt;\n\tCSeq       =(201 INVITE)"],"core":1,"edge":null,"method":"","ts_ms":"1690496532348","ts_text":"2023-07-27_22:22:12"},{"msg":"Received Packet from 192.81.236.31:5060\nSIP\/2.0 200 OK\r\nVia: SIP\/2.0\/UDP 10.200.1.11:5060;branch=z9hG4bKPw2TBlHnzKo93E1a1A5EF2\r\nCall-ID: 20230727222212051631-6cc082866aafdc5dee7a480c2d339c76\r\nCSeq: 201 INVITE\r\nFrom: &quot;netsapiens&quot; &lt;sip:8587645200@netsapiens.com&gt;;tag=e4GIPxrDg48YXznf1A5EF1\r\nTo: &lt;sip:18587645200@srv.lcr.thinq.com&gt;;tag=sip+3+4b9b0013+39352400\r\nServer: SIP\/2.0\r\nContent-Length: 231\r\nContact: &lt;sip:192.81.236.31;met=339.c00a7475&gt;\r\nContent-Type: application\/sdp\r\nAllow: INVITE,ACK,CANCEL,BYE,REFER,OPTIONS,NOTIFY,SUBSCRIBE,PRACK,INFO\r\nUser-Agent: ENSR3.0.66.72-IS1-RMRG40100-RG2216-CPO15566\r\n\r\nv=0\r\no=- 133642846765094 133642846765094 IN IP4 40.139.11.143\r\ns=-\r\nc=IN IP4 40.139.11.143\r\nt=0 0\r\nm=audio 25974 RTP\/AVP 0 101\r\na=sendrecv\r\na=rtpmap:0 PCMU\/8000\/1\r\na=rtpmap:101 telephone-event\/8000\r\na=maxptime:20\r\na=fmtp:101 0-15","core":1,"edge":2,"method":"200","ts_ms":"1690496533593","ts_text":"2023-07-27_22:22:13"},{"msg":["CNmsUaSessionStateConnecting(20230727222205051624)::UpdateRtpRelay fwrd=&lt;sip:18587645200@srv.lcr.thinq.com&gt;\/(25000) orig=&lt;sip:19168475801@srv.lcr.thinq.com&gt;\/(25496) bNoPortChange=false Rfc2833=101","CNmsUaSessionStateConnecting(20230727222205051624) from SDP\n\tinsertAddress  (40.139.11.143)\n\ttrimmed        (40.139.11.143)\n\tto Leg for  GW=&lt;sip:18587645200@srv.lcr.thinq.com&gt;","CNmsUaSessionStateConnecting(20230727222205051624)::UpdateCdrMedia from (200) Response Media=&#039;PCMU&#039; &lt;0 101&gt; Old=&#039;PCMU&#039;","CNmsUaSessionStateConnecting(20230727222205051624)::Process (200) Response\n\tfrom        &lt;192.81.236.31:5060&gt;\n\tcallID     =&lt;20230727222212051631-6cc082866aafdc5dee7a480c2d339c76&gt;\n\tCSeq       =(201 INVITE)","CNmsUaSessionStateConnecting(20230727222205051624)::SendRequest\n\tto                &lt;sip:19168475801@srv.lcr.thinq.com&gt;\n\tat                (192.81.236.31:5060) (UdpV4)\n\tviaTag           =(9fN4X3Edo4DbYUza1A5EF3)\n\tkey              =(6AqWdhMpQe7kNBg31A5EEF)\n\tCB2BProxyUACStateCalling(z9hG4bK9fN4X3Edo4DbYUza1A5EF3INVITE201)::SendInviteRequest\n\tto   192.81.236.31\n\tvia  (UDP)\n\t- sent","CNmsUaSessionStateReinviting(20230727222205051624)::OnEntry"],"core":1,"edge":null,"method":"","ts_ms":"1690496533604","ts_text":"2023-07-27_22:22:13"},{"msg":"Sending to 192.81.236.31:5060 (UdpV4)\nINVITE sip:192.81.236.31 SIP\/2.0\r\nVia: SIP\/2.0\/UDP 4.30.7.38:5060;branch=z9hG4bK9fN4X3Edo4DbYUza1A5EF3\r\nFrom: &lt;sip:8587645200@netsapiens.com&gt;;tag=6AqWdhMpQe7kNBg31A5EEF\r\nTo: &lt;sip:19168475801@srv.lcr.thinq.com&gt;;tag=sip+1+4f79007e+f68b740b\r\nCall-ID: my-random-unique-callid\r\nCSeq: 201 INVITE\r\nMax-Forwards: 20\r\nContact: &lt;sip:sdf@4.30.7.38:5060;transport=udp&gt;\r\nServer: NetSapiens SiPBx v43-4-0x15\r\nContent-Type: application\/sdp\r\nContent-Length: 253\r\n\r\nv=0\r\no=NetSapiens_Nms 1690496525 1690496533033 IN IP4 4.30.7.38\r\ns=-\r\nc=IN IP4 4.30.7.38\r\nt=0 0\r\nm=audio 25002 RTP\/AVP 0 101 13\r\na=sendrecv\r\na=rtpmap:0 PCMU\/8000\/1\r\na=rtpmap:101 telephone-event\/8000\r\na=maxptime:20\r\na=fmtp:101 0-15\r\na=rtpmap:13 CN\/8000","core":1,"edge":2,"method":"INVITE","ts_ms":"1690496533630","ts_text":"2023-07-27_22:22:13"},{"msg":["CLiDfLic(Recording-Server2)::SendCdcAnswer(2000@portal)\n\t(AccessingElementId) : (sip:eng1-dfw@netsapiens.com)\n\t(AnsweringPartyId) : (sip:18587645200@srv.lcr.thinq.com)\n\t(Aor0) : (sip:18587645200@srv.lcr.thinq.com)\n\t(Aor1) : (sip:19168475801@srv.lcr.thinq.com)\n\t(CallId) : (my-random-unique-callid)\n\t(CccId) : (125B)\n\t(Domain1) : (portal)\n\t(EventTime) : (2023-07-27 22:22:13)\n\t(Territory1) : (NetSapiens2)\n\t - for &lt;2000@portal&gt;","CLiDfLic(Recording-Server)::SendCdcAnswer(2000@portal)\n\t(AccessingElementId) : (sip:eng1-dfw@netsapiens.com)\n\t(AnsweringPartyId) : (sip:18587645200@srv.lcr.thinq.com)\n\t(Aor0) : (sip:18587645200@srv.lcr.thinq.com)\n\t(Aor1) : (sip:19168475801@srv.lcr.thinq.com)\n\t(CallId) : (my-random-unique-callid)\n\t(CccId) : (125B)\n\t(Domain1) : (portal)\n\t(EventTime) : (2023-07-27 22:22:13)\n\t(Territory1) : (NetSapiens2)\n\t - for &lt;2000@portal&gt;"],"core":1,"edge":null,"method":"","ts_ms":"1690496533630","ts_text":"2023-07-27_22:22:13"},{"msg":"Received Packet from 192.81.236.31:5060\nSIP\/2.0 100 Giving a try\r\nVia: SIP\/2.0\/UDP 10.200.1.11:5060;branch=z9hG4bK9fN4X3Edo4DbYUza1A5EF3\r\nFrom: &lt;sip:8587645200@netsapiens.com&gt;;tag=6AqWdhMpQe7kNBg31A5EEF\r\nTo: &lt;sip:19168475801@srv.lcr.thinq.com&gt;;tag=sip+1+4f79007e+f68b740b\r\nCall-ID: my-random-unique-callid\r\nCSeq: 201 INVITE\r\nServer: thinQ LB\r\nContent-Length: 0","core":1,"edge":2,"method":"100","ts_ms":"1690496533714","ts_text":"2023-07-27_22:22:13"},{"msg":["CNmsUaSessionStateReinviting(20230727222205051624)::Process (100) Response\n\tTo-URI   : &lt;sip:19168475801@srv.lcr.thinq.com&gt;;tag=sip+1+4f79007e+f68b740b\n\tFrom-URI : &lt;sip:8587645200@netsapiens.com&gt;;tag=6AqWdhMpQe7kNBg31A5EEF from 192.81.236.31:5060\n\tCallID   : &lt;my-random-unique-callid&gt;\n\tCSeq     : 201 INVITE\n\t - Response from OriginalLeg. Turn Off Route T\/O&lt;sip:19168475801@srv.lcr.thinq.com&gt;"],"core":1,"edge":null,"method":"","ts_ms":"1690496533727","ts_text":"2023-07-27_22:22:13"},{"msg":"Received Packet from 192.81.236.31:5060\nSIP\/2.0 200 OK\r\nVia: SIP\/2.0\/UDP 10.200.1.11:5060;branch=z9hG4bK9fN4X3Edo4DbYUza1A5EF3\r\nCall-ID: my-random-unique-callid\r\nCSeq: 201 INVITE\r\nFrom: &lt;sip:8587645200@netsapiens.com&gt;;tag=6AqWdhMpQe7kNBg31A5EEF\r\nTo: &lt;sip:19168475801@srv.lcr.thinq.com&gt;;tag=sip+1+4f79007e+f68b740b\r\nServer: SIP\/2.0\r\nContent-Length: 231\r\nContact: &lt;sip:192.81.236.31;met=c34.b9e0e6a5&gt;\r\nContent-Type: application\/sdp\r\nAllow: INVITE,ACK,CANCEL,BYE,REFER,OPTIONS,NOTIFY,SUBSCRIBE,PRACK,INFO\r\nUser-Agent: ENSR3.0.66.72-IS1-RMRG40386-RG2216-CPO22754\r\n\r\nv=0\r\no=- 112369873742026 112369873742027 IN IP4 40.139.11.149\r\ns=-\r\nc=IN IP4 40.139.11.149\r\nt=0 0\r\nm=audio 53084 RTP\/AVP 0 101\r\na=sendrecv\r\na=rtpmap:0 PCMU\/8000\/1\r\na=rtpmap:101 telephone-event\/8000\r\na=maxptime:20\r\na=fmtp:101 0-15","core":1,"edge":2,"method":"200","ts_ms":"1690496533896","ts_text":"2023-07-27_22:22:13"},{"msg":["CNmsUaSessionStateReinviting(20230727222205051624)::Process 200 OK\n\tTo-URI   : &lt;sip:19168475801@srv.lcr.thinq.com&gt;;tag=sip+1+4f79007e+f68b740b\n\tFrom-URI : &lt;sip:8587645200@netsapiens.com&gt;;tag=6AqWdhMpQe7kNBg31A5EEF from 192.81.236.31:5060\n\tCallID   : &lt;my-random-unique-callid&gt;\n\tCSeq     : 201 INVITE\n\t- from OriginalLeg&lt;sip:19168475801@srv.lcr.thinq.com&gt;","CNmsUaSessionStateReinviting(20230727222205051624)::LookupResponder(sip:start@talking)\n\t- Found mode=(talking)","CNmsUaSessionStateReinviting(20230727222205051624)::LookupNextResponder case(1)\n\tTranslate\n\t\tfrom &lt;start@to-connection&gt;\n\t\tby   ([*])(talking)\n\t\tto   (sip:start@talking)(sip:start@talking)\n\t- found responder\n\tName       =(Talking)\n\tMatch      =(sip:*@talking)\n\tMediaMode  =(talking)\n\tP0         =(n\/a)\n\tP1         =(n\/a)\n\tNextUser0  =(chk-orig-bye)\n\tNextHost0  =(talk-return)\n\tNextUser1  =([*])\n\tNextHost1  =(transfer)","CNmsUaSessionStateTalking(20230727222205051624)::OnEntry\n\t#leg             =2","CNmsUaSessionStateTalking(20230727222205051624)::UpdateCdrMedia from (200) Response Media=&#039;PCMU&#039; &lt;0 101&gt; Old=&#039;PCMU&#039;","CNmsUaSessionStateTalking(20230727222205051624)::RestartRtpRelay\n\tOriginal rlyPort(25002) media &lt;40.139.11.149:53084&gt; aor=&lt;sip:19168475801@srv.lcr.thinq.com&gt; cccId(125B) rfc2833=101 dtlsSetup=&lt;&gt;\n\tForward rlyPort(25000) media &lt;40.139.11.143:25974&gt; aor=&lt;sip:18587645200@srv.lcr.thinq.com&gt; cccId() rfc2833=101 dtlsSetup=&lt;&gt;","CNmsUaSessionStateTalking(20230727222205051624)::SetTalkTimeout to 10800s at &#039;2023-07-28 01:22:13&#039;"],"core":1,"edge":null,"method":"","ts_ms":"1690496533909","ts_text":"2023-07-27_22:22:13"},{"msg":"Sending to 192.81.236.31:5060 (UdpV4)\nACK sip:192.81.236.31 SIP\/2.0\r\nVia: SIP\/2.0\/UDP 4.30.7.38:5060;branch=z9hG4bK14JyN9fK9eHsbxoV1A5EF4\r\nFrom: &lt;sip:8587645200@netsapiens.com&gt;;tag=6AqWdhMpQe7kNBg31A5EEF\r\nTo: &lt;sip:19168475801@srv.lcr.thinq.com&gt;;tag=sip+1+4f79007e+f68b740b\r\nCall-ID: my-random-unique-callid\r\nCSeq: 201 ACK\r\nMax-Forwards: 20\r\nContent-Length: 0","core":1,"edge":2,"method":"ACK","ts_ms":"1690496533933","ts_text":"2023-07-27_22:22:13"},{"msg":"Sending to 192.81.236.31:5060 (UdpV4)\nACK sip:192.81.236.31 SIP\/2.0\r\nVia: SIP\/2.0\/UDP 4.30.7.38:5060;branch=z9hG4bKJmMRbdENCD5JCqHS1A5EF5\r\nFrom: &quot;netsapiens&quot; &lt;sip:8587645200@netsapiens.com&gt;;tag=e4GIPxrDg48YXznf1A5EF1\r\nTo: &lt;sip:18587645200@srv.lcr.thinq.com&gt;;tag=sip+3+4b9b0013+39352400\r\nCall-ID: 20230727222212051631-6cc082866aafdc5dee7a480c2d339c76\r\nCSeq: 201 ACK\r\nMax-Forwards: 20\r\nContent-Length: 0","core":1,"edge":2,"method":"ACK","ts_ms":"1690496533933","ts_text":"2023-07-27_22:22:13"},{"msg":"Received Packet from 192.81.236.31:5060\nBYE sip:sdf@10.200.1.11:5060;transport=udp SIP\/2.0\r\nVia: SIP\/2.0\/UDP 192.81.236.31:5060;branch=z9hG4bKe1d.e8f1e5e1.0\r\nCall-ID: my-random-unique-callid\r\nFrom: &quot;19168475801&quot; &lt;sip:19168475801@srv.lcr.thinq.com&gt;;tag=sip+1+4f79007e+f68b740b\r\nTo: &lt;sip:8587645200@netsapiens.com&gt;;tag=6AqWdhMpQe7kNBg31A5EEF\r\nCSeq: 1046254113 BYE\r\nContent-Length: 0\r\nMax-Forwards: 31\r\nUser-Agent: ENSR3.0.66.72-IS1-RMRG40386-RG2216-CPO22754","core":1,"edge":2,"method":"BYE","ts_ms":"1690496540905","ts_text":"2023-07-27_22:22:20"},{"msg":["CNmsUaSessionStateTalking(20230727222205051624)::Process BYE\n\tTo-URI    :&lt;sip:8587645200@netsapiens.com&gt;;tag=6AqWdhMpQe7kNBg31A5EEF\n\tFrom-URI  :&quot;19168475801&quot; &lt;sip:19168475801@srv.lcr.thinq.com&gt;;tag=sip+1+4f79007e+f68b740b\n\tfrom       &lt;192.81.236.31:5060&gt;\n\t- BYE from Orig","CB2BProxySessionStateDisconnecting(20230727222205051624)::UpdateCdrDuration Duration=7s Hold=0s Talk=7s Relay\n\t(10.200.1.11:25000) (IPV4) &lt;40.139.11.143:25974&gt; 60200 (60200\/516\/60200) bytes 68.80Kbps,\n\t(10.200.1.11:25002) (IPV4) &lt;40.139.11.149:53084&gt; 58652 (58652\/516\/58652) bytes 67.03Kbps"],"core":1,"edge":null,"method":"","ts_ms":"1690496540916","ts_text":"2023-07-27_22:22:20"},{"msg":"Sending to 192.81.236.31:5060 (UdpV4)\nSIP\/2.0 200 OK\r\nVia: SIP\/2.0\/UDP 192.81.236.31:5060;branch=z9hG4bKe1d.e8f1e5e1.0;received=192.81.236.31\r\nTo: &lt;sip:8587645200@netsapiens.com&gt;;tag=6AqWdhMpQe7kNBg31A5EEF\r\nFrom: &quot;19168475801&quot; &lt;sip:19168475801@srv.lcr.thinq.com&gt;;tag=sip+1+4f79007e+f68b740b\r\nCall-ID: my-random-unique-callid\r\nCSeq: 1046254113 BYE\r\nContent-Length: 0","core":1,"edge":2,"method":"200","ts_ms":"1690496540935","ts_text":"2023-07-27_22:22:20"},{"msg":"Sending to 192.81.236.31:5060 (UdpV4)\nBYE sip:192.81.236.31 SIP\/2.0\r\nVia: SIP\/2.0\/UDP 4.30.7.38:5060;branch=z9hG4bKKLDxH30rpBcJaUxg1A5EF6\r\nFrom: &quot;netsapiens&quot; &lt;sip:8587645200@netsapiens.com&gt;;tag=e4GIPxrDg48YXznf1A5EF1\r\nTo: &lt;sip:18587645200@srv.lcr.thinq.com&gt;;tag=sip+3+4b9b0013+39352400\r\nCall-ID: 20230727222212051631-6cc082866aafdc5dee7a480c2d339c76\r\nCSeq: 202 BYE\r\nMax-Forwards: 20\r\nContent-Length: 0","core":1,"edge":2,"method":"BYE","ts_ms":"1690496540955","ts_text":"2023-07-27_22:22:20"},{"msg":"Received Packet from 192.81.236.31:5060\nSIP\/2.0 200 OK\r\nVia: SIP\/2.0\/UDP 10.200.1.11:5060;branch=z9hG4bKKLDxH30rpBcJaUxg1A5EF6\r\nCall-ID: 20230727222212051631-6cc082866aafdc5dee7a480c2d339c76\r\nCSeq: 202 BYE\r\nFrom: &quot;netsapiens&quot; &lt;sip:8587645200@netsapiens.com&gt;;tag=e4GIPxrDg48YXznf1A5EF1\r\nTo: &lt;sip:18587645200@srv.lcr.thinq.com&gt;;tag=sip+3+4b9b0013+39352400\r\nServer: SIP\/2.0\r\nContent-Length: 0\r\nContact: &lt;sip:192.81.236.31;met=339.c00a7475&gt;\r\nUser-Agent: ENSR3.0.66.72-IS1-RMRG40100-RG2216-CPO15566","core":1,"edge":2,"method":"200","ts_ms":"1690496541108","ts_text":"2023-07-27_22:22:21"},{"msg":["CLiDfLic(Recording-Server2)::SendCdcRelease(2000@portal)\n\t(AccessingElementId) : (sip:eng1-dfw@netsapiens.com)\n\t(CallId) : (my-random-unique-callid)\n\t(EventTime) : (2023-07-27 22:22:28)\n\t(ReleaseReason) : (ReturnAllLegs)\n\t - for &lt;2000@portal&gt;","CLiDfLic(Recording-Server)::SendCdcRelease(2000@portal)\n\t(AccessingElementId) : (sip:eng1-dfw@netsapiens.com)\n\t(CallId) : (my-random-unique-callid)\n\t(EventTime) : (2023-07-27 22:22:28)\n\t(ReleaseReason) : (ReturnAllLegs)\n\t - for &lt;2000@portal&gt;","gSBusRcvCallControl - \n\t(action):(call)\n\t(auto):(no)\n\t(callid):(my-random-unique-callid)\n\t(destination):(sip:18587645200@apidog.ApiReseller)\n\t(object):(call)\n\t(origination):(19168475801)\n\t(uid):(1000@apidog.ApiReseller)","gSBusRcvCallControl - \n\t(action):(call)\n\t(auto):(no)\n\t(callid):(my-random-unique-callid)\n\t(destination):(sip:18587645200@apidog.ApiReseller)\n\t(object):(call)\n\t(origination):(19168475801)\n\t(uid):(1000@apidog.ApiReseller)","gSBusRcvCallControl - \n\t(action):(call)\n\t(auto):(no)\n\t(callid):(my-random-unique-callid)\n\t(destination):(sip:18587645200@apidog.ApiReseller)\n\t(object):(call)\n\t(origination):(19168475801)\n\t(uid):(1000@apidog.ApiReseller)","gSBusRcvCallControl - \n\t(action):(call)\n\t(auto):(no)\n\t(callid):(my-random-unique-callid)\n\t(destination):(sip:18587645200@apidog.ApiReseller)\n\t(object):(call)\n\t(origination):(19168475801)\n\t(uid):(1000@apidog.ApiReseller)","CB2BProxyAgent::GetNewSession by (CB2BProxyAgent::MakeCall)- SessionKey=&lt;20230727222812052283&gt;(3) - created","ProxyAgent::MakeCall(20230727222812052283)\n\tRequest=&#039;Call-To-Talk&#039;\n\tUID=&lt;1000@apidog.ApiReseller&gt;\n\tCallId=&#039;my-random-unique-callid&#039;\n\tAni=&#039;&#039;\n\tCbAni=&#039;&#039;\n\tOrigination=&#039;19168475801&#039;\n\tDestination=&#039;sip:18587645200@apidog.ApiReseller&#039;","CNmsUaSessionStateIdle(20230727222812052283)::SetPreTalkTimeout to 1800s at &#039;2023-07-27 22:58:12&#039;","CNmsUaSessionStateCallBack(20230727222812052283)::LookupResponder(Call-To-Talk)\n\t- Found mode=(playback)","CNmsUaSessionStateCallBack(20230727222812052283)::CheckTimeout\n\tcallID        =&#039;20230727222812052284-6cc082866aafdc5dee7a480c2d339c76&#039;\n\tresponder      &lt;Call-To-Talk&gt;\n\tmatch         =&lt;Call-To-Talk&gt;\n\tcallback      =&lt;19168475801&gt;\n\tby            =&lt;1000@apidog.ApiReseller&gt;\n\trequestID     =&#039;my-random-unique-callid&#039;\n\trequestName   =&#039;&#039;\n\tparameter     =&#039;&#039;\n\tmessage       =&#039;&#039;\n\tbcfrmRequired =false\n\t#retry        =0\n\tretryPeriod   =0","CNmsUaSessionStateCallBack(20230727222812052283)::CheckTimeout - Lookup Origination Subscriber\n\torigUid         &lt;1000@apidog.ApiReseller&gt;\n\torigName       =&quot;Belle Feest&quot;\n\torigSrvCode    =()","CNmsUaSessionStateCallBack(20230727222812052283)::CheckTimeout - Lookup Destination Subscriber\n\tcallbackAddr   =&lt;19168475801&gt;\n\tmatchDest by   =(callbackAddr)&lt;19168475801&gt;\n\t- Destination User not found","CNmsUaSessionStateCallBack(20230727222812052283)::CheckTimeout - construct Destinations\n\tcallback        &lt;19168475801&gt;\n\tfromUri        =&lt;sip:689346037@apidog.ApiReseller&gt;\n\trspMatch       =(Call-To-Talk)\n\t - Ring to &lt;19168475801&gt;","CNmsUaSessionStateCallBack(20230727222812052283)::ApplyDialPlan(0,1024) Last Plan &lt;Default&gt;\n\towner       &lt;1000@apidog.ApiReseller&gt;\n\tcaller      &lt;1000@apidog.ApiReseller&gt;\n\tsearchedBy  (from=&lt;sip:689346037@apidog.ApiReseller&gt;, to=&lt;19168475801&gt;, date=&#039;2023-07-27&#039;,dow=&#039;4&#039;,tod=&#039;15:28&#039;)\n\tmatchedFrom (*)\n\tmatchedTo   (1[2-9][0-9][0-9][1-9][0-9][0-9][0-9][0-9][0-9][0-9])\n\tselectedRule(Forward to Domestic 11-Digit)\n\tapps       =&lt;sip:start@to-device&gt;\n\tTranslate\n\t\t  To-URI from (19168475801) by ([*])(&lt;OwnDomain&gt;) to (sip:19168475801@apidog.ApiReseller)\n\t\tFrom-URI from (sip:689346037@apidog.ApiReseller) by ([*])([*])([*]) to (sip:689346037@apidog.ApiReseller)","CNmsUaSessionStateCallBack(20230727222812052283)::CheckDialPolicy(0)&lt;US and Canada&gt;\n\tagainst (sip:19168475801@apidog.ApiReseller)\n\t match &lt;*&gt;(Permit All) - (permit)","CNmsUaSessionStateOInvitingSetup(20230727222812052283)::LoadRoute\n\tbtn          =(689346037)\n\t- found route for\n\t\tfrom         =&lt;sip:689346037@apidog.ApiReseller&gt;\n\t\tto           =&lt;sip:19168475801@apidog.ApiReseller&gt;\n\t\ttoUri        =&lt;sip:19168475801@apidog.ApiReseller&gt;\n\t\tat            &lt;eng0-san.netsapiens.com&gt;\n\t\tselect        &lt;US Domestic Call&gt; (*)(sip:1??????????@*)\n\t\twith          3 fixed connections.","CNmsUaSessionStateOInvitingSetup(20230727222812052283)::LookupRegisteredUA(sip:19168475801@srv.lcr.thinq.com)\n\tFromUri      =&lt;&lt;sip:689346037@apidog.ApiReseller&gt;&gt;\n\tbSRing       =false\n\t- found no match","CNmsUaSessionStateOInvitingSetup(20230727222812052283)::LookupGateway for User &lt;1000@apidog.ApiReseller&gt;(sip:19168475801@srv.lcr.thinq.com)\n\tfound        &lt;sip:*@srv.lcr.thinq.com&gt;(srv.lcr.thinq.com)\n\tbWanGW      =true\n\tbIsNcs      =false\n\t- PidfLo not required\n\tOrigDomain  =&lt;apidog.ApiReseller&gt;\n\tTermDomain  =&lt;*&gt;\n\tByDomain    =&lt;apidog.ApiReseller&gt;\n\tBySessionKey=(eng0-san.netsapiens.com:1000@apidog.ApiReseller:20230727222812052283)\n\tdomain&lt;apidog.ApiReseller&gt;, external=true, countForLimit(0) &lt; limit(15), countExternal(0) &lt; limitExt(10) - is OK\n\tforceCidRplc=false\n\tbIsAnonymous=false - SRV returned 3 records.","CNmsUaSessionStateOInvitingSetup(20230727222812052283)::LookupRoute\n\tto            (sip:19168475801@apidog.ApiReseller)\n\tfrom          &lt;sip:689346037@apidog.ApiReseller&gt;\n\tbSRing       =false\n\tselect        (1) Chain(1,3) Route(US Domestic Call) Connection(1):&lt;[*]@srv.lcr.thinq.com&gt; To &lt;sip:19168475801@srv.lcr.thinq.com&gt;","CNmsUaSessionStateOInvitingSetup(20230727222812052283)::LookupRegisteredUA(sip:19168475801@srv.lcr.thinq.com)\n\tFromUri      =&lt;&lt;sip:689346037@apidog.ApiReseller&gt;&gt;\n\tbSRing       =false\n\t- found no match","CNmsUaSessionStateOInvitingSetup(20230727222812052283)::LookupGateway::SetSipTransport(sip:19168475801@srv.lcr.thinq.com)\n\tto           (UdpV4) &lt;10.200.1.11:5060&gt;","CNmsUaSessionStateOInvitingSetup(20230727222812052283)::LookupGateway from Contact\n\tinsertAddress  (192.81.236.31)\n\ttrimmed        (192.81.236.31)\n\tto Leg for  GW=&lt;sip:19168475801@srv.lcr.thinq.com&gt;","CNmsUaSessionStateOInvitingSetup(20230727222812052283)::UpdateRtpRelay fwrd=&lt;sip:19168475801@srv.lcr.thinq.com&gt; orig=&lt;sip:19168475801@srv.lcr.thinq.com&gt; bNoPortChange=false - requested forward Audio Relay (24500)","CNmsUaSessionStateOInvitingSetup(20230727222812052283)::LookupGateway for User &lt;1000@apidog.ApiReseller&gt;(sip:19168475801@srv.lcr.thinq.com)\n\tfound        &lt;sip:*@srv.lcr.thinq.com&gt;(srv.lcr.thinq.com)\n\tbWanGW      =true\n\tbIsNcs      =false\n\t- PidfLo not required\n\tOrigDomain  =&lt;apidog.ApiReseller&gt;\n\tTermDomain  =&lt;*&gt;\n\tByDomain    =&lt;apidog.ApiReseller&gt;\n\tBySessionKey=(eng0-san.netsapiens.com:1000@apidog.ApiReseller:20230727222812052283)\n\tdomain&lt;apidog.ApiReseller&gt;, session already exist but not external, countForLimit(1) vs limit(15), countExternal(0) &lt; limitExt(10) - is OK\n\tforceCidRplc=false\n\tbIsAnonymous=false\n\t(Host from SRV): lcr-lb01.rdu.thinq.com:5060\n\tat FQDN      &lt;lcr-lb01.rdu.thinq.com&gt; (v4)\n\tresolved to  &lt;192.81.236.31&gt; and port (5060)\n\ttranslate\n\t\tTo-URI   from (19168475801@srv.lcr.thinq.com) by ([*]@srv.lcr.thinq.com) to (sip:19168475801@srv.lcr.thinq.com)\n\t\tFrom-URI from (&lt;sip:689346037@apidog.ApiReseller&gt;) by ([*]@netsapiens.com) to (&lt;sip:689346037@netsapiens.com&gt;)\n\tfwrdFromUri =(&lt;sip:689346037@netsapiens.com&gt;)","CNmsUaSessionStateOInvitingSetup(20230727222812052283)::LookupRoute\n\tto            (sip:19168475801@apidog.ApiReseller)\n\tfrom          &lt;sip:689346037@apidog.ApiReseller&gt;\n\tbSRing       =false\n\tselect        (2) Chain(1,5) Route(US Domestic Call) Connection(1):&lt;[*]@srv.lcr.thinq.com&gt; To &lt;sip:19168475801@srv.lcr.thinq.com&gt;","CNmsUaSessionStateOInvitingSetup(20230727222812052283)::SetRouteTimeout to 9s at &#039;2023-07-27 22:28:21&#039;","CNmsUaSessionStateOInvitingSetup(20230727222812052283)::OnEntry\n\tbRegistrationExpired=false\n\tbFoundRegisteredUA  =false\n\tbPendingRegistration=false\n\tbDndExceptionPending=false\n\tFromUri             =(&lt;sip:689346037@apidog.ApiReseller&gt;)\n\tisPushedAndPending  =false","CSipSessionLeg(sip:19168475801@srv.lcr.thinq.com)::IsPendingFulfilled\n\t- not pending","CNmsUaSessionStateOInvitingSetup(20230727222812052283)::CheckTimeout\n\t- change state to OInviting","CNmsUaSessionStateOInviting(20230727222812052283)::MakeOriginalInvite\n\turiFrom       =(&lt;sip:689346037@netsapiens.com&gt;)\n\turiTo         =(&lt;sip:19168475801@srv.lcr.thinq.com&gt;)\n\tcallId        =(my-random-unique-callid)\n\tcseq          =200","CNmsUaSessionStateOInviting(20230727222812052283)::SendOriginalInvite\n\ttowards        &lt;sip:19168475801@srv.lcr.thinq.com&gt;\n\tat             (192.81.236.31:5060)\n\tcallID        =&lt;my-random-unique-callid&gt;\n\torigFromUri   =&lt;sip:19168475801@srv.lcr.thinq.com&gt;\n\tfrwdFromUri   =&lt;sip:19168475801@srv.lcr.thinq.com&gt;\n\torigReqFromUri=&lt;&lt;sip:689346037@netsapiens.com&gt;&gt;","CNmsUaSessionStateOInviting(20230727222812052283)::SendRequest\n\tto                &lt;sip:19168475801@srv.lcr.thinq.com&gt;\n\tat                (192.81.236.31:5060) (UdpV4)\n\tviaTag           =(8lyTZFJKwYuGGNX91A5F8A)\n\tkey              =(8lyTZFJKwYuGGNX91A5F8A)\n\tCB2BProxyUACStateCalling(z9hG4bK8lyTZFJKwYuGGNX91A5F8AINVITE200)::SendInviteRequest\n\tto   192.81.236.31\n\tvia  (UDP)\n\t- sent","CNmsUaSessionStateOInviting(20230727222812052283)::SetAnswerTimeout  by Subscriber &lt;1000@apidog.ApiReseller&gt; No Answer TO to 25s at &#039;2023-07-27 22:28:37&#039;","CNmsUaSessionStateOInviting(20230727222812052283)::SetRouteTimeout to 6s at &#039;2023-07-27 22:28:18&#039;"],"core":1,"edge":null,"method":"","ts_ms":"1690496548942","ts_text":"2023-07-27_22:22:28"},{"msg":"Sending to 192.81.236.31:5060 (UdpV4)\nINVITE sip:19168475801@srv.lcr.thinq.com SIP\/2.0\r\nVia: SIP\/2.0\/UDP 4.30.7.38:5060;branch=z9hG4bK8lyTZFJKwYuGGNX91A5F8A\r\nFrom: &lt;sip:689346037@netsapiens.com&gt;;tag=8lyTZFJKwYuGGNX91A5F8A\r\nTo: &lt;sip:19168475801@srv.lcr.thinq.com&gt;\r\nCall-ID: my-random-unique-callid\r\nCSeq: 200 INVITE\r\nMax-Forwards: 20\r\nContact: &lt;sip:sdf@4.30.7.38:5060;transport=udp&gt;\r\nServer: NetSapiens SiPBx v43-4-0x15\r\nContent-Type: application\/sdp\r\nContent-Length: 284\r\n\r\nv=0\r\no=NetSapiens_Nms 1690496892 1690496892088 IN IP4 4.30.7.38\r\ns=SIP Media Description\r\nc=IN IP4 4.30.7.38\r\nt=0 0\r\nm=audio 24500 RTP\/AVP 0 8 13 101\r\na=rtpmap:0 PCMU\/8000\/1\r\na=rtpmap:8 PCMA\/8000\/1\r\na=rtpmap:13 CN\/8000\r\na=rtpmap:101 telephone-event\/8000\r\na=fmtp:101 0-15\r\na=sendrecv","core":1,"edge":2,"method":"INVITE","ts_ms":"1690496892966","ts_text":"2023-07-27_22:28:12"},{"msg":"Received Packet from 192.81.236.31:5060\nSIP\/2.0 100 Giving a try\r\nVia: SIP\/2.0\/UDP 10.200.1.11:5060;branch=z9hG4bK8lyTZFJKwYuGGNX91A5F8A\r\nFrom: &lt;sip:689346037@netsapiens.com&gt;;tag=8lyTZFJKwYuGGNX91A5F8A\r\nTo: &lt;sip:19168475801@srv.lcr.thinq.com&gt;\r\nCall-ID: my-random-unique-callid\r\nCSeq: 200 INVITE\r\nServer: thinQ LB\r\nContent-Length: 0","core":1,"edge":2,"method":"100","ts_ms":"1690496893049","ts_text":"2023-07-27_22:28:13"},{"msg":["CNmsUaSessionStateOInviting::Receive (100) Response from 192.81.236.31 - turn off Route T\/O."],"core":1,"edge":null,"method":"","ts_ms":"1690496893066","ts_text":"2023-07-27_22:28:13"},{"msg":"Received Packet from 192.81.236.31:5060\nSIP\/2.0 183 Session Progress\r\nVia: SIP\/2.0\/UDP 10.200.1.11:5060;branch=z9hG4bK8lyTZFJKwYuGGNX91A5F8A\r\nCall-ID: my-random-unique-callid\r\nCSeq: 200 INVITE\r\nFrom: &lt;sip:689346037@netsapiens.com&gt;;tag=8lyTZFJKwYuGGNX91A5F8A\r\nTo: &lt;sip:19168475801@srv.lcr.thinq.com&gt;;tag=sip+1+4fb5000b+2256999\r\nServer: SIP\/2.0\r\nContent-Length: 216\r\nContact: &lt;sip:192.81.236.31;met=c34.6ae0e6a5&gt;\r\nContent-Type: application\/sdp\r\nAllow: INVITE,ACK,CANCEL,BYE,REFER,OPTIONS,NOTIFY,SUBSCRIBE,PRACK,INFO\r\nUser-Agent: ENSR3.0.66.72-IS1-RMRG40880-RG2216-CPO26475\r\n\r\nv=0\r\no=- 110106426344211 110106426344211 IN IP4 40.139.11.149\r\ns=-\r\nc=IN IP4 40.139.11.149\r\nt=0 0\r\nm=audio 52436 RTP\/AVP 0 101\r\na=sendrecv\r\na=rtpmap:0 PCMU\/8000\/1\r\na=rtpmap:101 telephone-event\/8000\r\na=fmtp:101 0-15","core":1,"edge":2,"method":"183","ts_ms":"1690496894786","ts_text":"2023-07-27_22:28:14"},{"msg":["CNmsUaSessionStateOInviting::Receive (183) Response from 192.81.236.31 - turn off Route T\/O."],"core":1,"edge":null,"method":"","ts_ms":"1690496894802","ts_text":"2023-07-27_22:28:14"},{"msg":"Received Packet from 192.81.236.31:5060\nSIP\/2.0 180 Ringing\r\nVia: SIP\/2.0\/UDP 10.200.1.11:5060;branch=z9hG4bK8lyTZFJKwYuGGNX91A5F8A\r\nCall-ID: my-random-unique-callid\r\nCSeq: 200 INVITE\r\nFrom: &lt;sip:689346037@netsapiens.com&gt;;tag=8lyTZFJKwYuGGNX91A5F8A\r\nTo: &lt;sip:19168475801@srv.lcr.thinq.com&gt;;tag=sip+1+4fb5000b+2256999\r\nServer: SIP\/2.0\r\nContent-Length: 0\r\nContact: &lt;sip:192.81.236.31;met=c34.6ae0e6a5&gt;\r\nAllow: INVITE,ACK,CANCEL,BYE,REFER,OPTIONS,NOTIFY,SUBSCRIBE,PRACK,INFO\r\nUser-Agent: ENSR3.0.66.72-IS1-RMRG40880-RG2216-CPO26475","core":1,"edge":2,"method":"180","ts_ms":"1690496896538","ts_text":"2023-07-27_22:28:16"},{"msg":["CNmsUaSessionStateOInviting::Receive (180) Response from 192.81.236.31 - turn off Route T\/O."],"core":1,"edge":null,"method":"","ts_ms":"1690496896541","ts_text":"2023-07-27_22:28:16"},{"msg":"Received Packet from 192.81.236.31:5060\nSIP\/2.0 200 OK\r\nVia: SIP\/2.0\/UDP 10.200.1.11:5060;branch=z9hG4bK8lyTZFJKwYuGGNX91A5F8A\r\nCall-ID: my-random-unique-callid\r\nCSeq: 200 INVITE\r\nFrom: &lt;sip:689346037@netsapiens.com&gt;;tag=8lyTZFJKwYuGGNX91A5F8A\r\nTo: &lt;sip:19168475801@srv.lcr.thinq.com&gt;;tag=sip+1+4fb5000b+2256999\r\nServer: SIP\/2.0\r\nContent-Length: 216\r\nContact: &lt;sip:192.81.236.31;met=c34.6ae0e6a5&gt;\r\nContent-Type: application\/sdp\r\nAllow: INVITE,ACK,CANCEL,BYE,REFER,OPTIONS,NOTIFY,SUBSCRIBE,PRACK,INFO\r\nUser-Agent: ENSR3.0.66.72-IS1-RMRG40880-RG2216-CPO26475\r\n\r\nv=0\r\no=- 110106426344211 110106426344211 IN IP4 40.139.11.149\r\ns=-\r\nc=IN IP4 40.139.11.149\r\nt=0 0\r\nm=audio 52436 RTP\/AVP 0 101\r\na=sendrecv\r\na=rtpmap:0 PCMU\/8000\/1\r\na=rtpmap:101 telephone-event\/8000\r\na=fmtp:101 0-15","core":1,"edge":2,"method":"200","ts_ms":"1690496898823","ts_text":"2023-07-27_22:28:18"},{"msg":["CNmsUaSessionStateOInviting(20230727222812052283)::Process 200 OK\n\tTo           :&lt;sip:19168475801@srv.lcr.thinq.com&gt;;tag=sip+1+4fb5000b+2256999\n\tfrom          &lt;192.81.236.31:5060&gt;","CNmsUaSessionStateOInviting(20230727222812052283)::ReconcileRtpPayloadList(21106)\n\tpcmOnly           =false)\n\tLocal  Media       (PCMU PCMA)\n\tRemote addr        (192.81.236.31:5060)\n\tRemote CSeq        (200 INVITE)\n\tRemote RTP Map     :\n\t\t (0 PCMU\/8000\/1) payloadType=0 media=(PCMU) timestampRate=(8000) channel=(1)\n\t\t (101 telephone-event\/8000) payloadType=101 media=(telephone-event) timestampRate=(8000) channel=(0)\n\n\tRemote Payload     (0 101)\n\tRemote Media       (PCMU telephone-event)\n\tMatching           :\n\t\t(PCMU) : (0)(8000) from RTP Map\n\t\t(PCMA) : not in remote map\n\tReconciled Payload (0)\n\t- Select           (PCMU) : (0) : (8000)","CNmsUaSessionStateOInviting(20230727222812052283)::UpdateCdrMedia from (200) Response Media=&#039;PCMU&#039; &lt;0 101&gt; Old=&#039;&#039; - update CDR","CNmsUaSessionStateOInviting(20230727222812052283) from SDP\n\tinsertAddress  (40.139.11.149)\n\ttrimmed        (40.139.11.149)\n\tto Leg for  GW=&lt;sip:19168475801@srv.lcr.thinq.com&gt;","CNmsUaSessionStateOInviting(20230727222812052283)::LookupResponder(sip:init@call-to-talk)\n\t- Found mode=(set_cdr)","CNmsUaSessionStateOInviting(20230727222812052283)::LookupNextResponder case(1)\n\tTranslate\n\t\tfrom &lt;19168475801@apidog.ApiReseller&gt;\n\t\tby   (init)(call-to-talk)\n\t\tto   (sip:init@call-to-talk)(sip:init@call-to-talk)\n\t- found responder\n\tName       =(Call To Talk - Init)\n\tMatch      =(sip:init@call-to-talk)\n\tMediaMode  =(set_cdr)\n\tP0         =(CdrOrigFromUri)\n\tP1         =(Call-To-Talk)\n\tNextUser0  =(n\/a)\n\tNextHost0  =(n\/a)\n\tNextUser1  =(init2)\n\tNextHost1  =(call-to-talk)","CNmsUaSessionStateSetCdr(20230727222812052283)::LookupResponder(sip:init2@call-to-talk)\n\t- Found mode=(set_cdr)","CNmsUaSessionStateSetCdr(20230727222812052283)::LookupNextResponder case(1)\n\tTranslate\n\t\tfrom &lt;init@call-to-talk&gt;\n\t\tby   (init2)(call-to-talk)\n\t\tto   (sip:init2@call-to-talk)(sip:init2@call-to-talk)\n\t- found responder\n\tName       =(Call To Talk - Init)\n\tMatch      =(sip:init2@call-to-talk)\n\tMediaMode  =(set_cdr)\n\tP0         =(CdrOrigToUser)\n\tP1         =(CallDestAddress)\n\tNextUser0  =(n\/a)\n\tNextHost0  =(n\/a)\n\tNextUser1  =(init3)\n\tNextHost1  =(call-to-talk)"],"core":1,"edge":null,"method":"","ts_ms":"1690496898832","ts_text":"2023-07-27_22:28:18"},{"msg":"Sending to 192.81.236.31:5060 (UdpV4)\nACK sip:192.81.236.31 SIP\/2.0\r\nVia: SIP\/2.0\/UDP 4.30.7.38:5060;branch=z9hG4bKDD1ZZb7FXl2NRvHf1A5F8C\r\nFrom: &lt;sip:689346037@netsapiens.com&gt;;tag=8lyTZFJKwYuGGNX91A5F8A\r\nTo: &lt;sip:19168475801@srv.lcr.thinq.com&gt;;tag=sip+1+4fb5000b+2256999\r\nCall-ID: my-random-unique-callid\r\nCSeq: 200 ACK\r\nMax-Forwards: 20\r\nContent-Length: 0","core":1,"edge":2,"method":"ACK","ts_ms":"1690496898847","ts_text":"2023-07-27_22:28:18"},{"msg":["CNmsUaSessionStateSetCdr(20230727222812052283)::CheckTimeout(CdrOrigToUser,CallDestAddress) - Dialed Number set to &lt;sip:18587645200@apidog.ApiReseller&gt;","CNmsUaSessionStateSetCdr(20230727222812052283)::LookupResponder(sip:init3@call-to-talk)\n\t- Found mode=(set_parameter)","CNmsUaSessionStateSetCdr(20230727222812052283)::LookupNextResponder case(1)\n\tTranslate\n\t\tfrom &lt;init2@call-to-talk&gt;\n\t\tby   (init3)(call-to-talk)\n\t\tto   (sip:init3@call-to-talk)(sip:init3@call-to-talk)\n\t- found responder\n\tName       =(Call To Talk - init)\n\tMatch      =(sip:init3@call-to-talk)\n\tMediaMode  =(set_parameter)\n\tP0         =(AccountUser)\n\tP1         =(CallReqAddress)\n\tNextUser0  =(n\/a)\n\tNextHost0  =(n\/a)\n\tNextUser1  =(start)\n\tNextHost1  =(call-to-talk)","SetParameter - User &lt;1000@apidog.ApiReseller&gt; entered.","CNmsUaSessionStateSetParameter(20230727222812052283)::LookupResponder(sip:start@call-to-talk)\n\t- Found mode=(forward_call)","CNmsUaSessionStateSetParameter(20230727222812052283)::LookupNextResponder case(1)\n\tTranslate\n\t\tfrom &lt;1000@apidog.ApiReseller&gt;\n\t\tby   (start)(call-to-talk)\n\t\tto   (sip:start@call-to-talk)(sip:start@call-to-talk)\n\t- found responder\n\tName       =(Call To Talk - Forward Call)\n\tMatch      =(sip:start@call-to-talk)\n\tMediaMode  =(forward_call)\n\tP0         =(AccountUser)\n\tP1         =(CallDestAddress)\n\tNextUser0  =(n\/a)\n\tNextHost0  =(n\/a)\n\tNextUser1  =(n\/a)\n\tNextHost1  =(n\/a)","CNmsUaSessionStateForwardCall(20230727222812052283)::ApplyDialPlan(0,1023) Last Plan &lt;Default&gt;\n\towner       &lt;1000@apidog.ApiReseller&gt;\n\tcaller      &lt;1000@apidog.ApiReseller&gt;\n\tsearchedBy  (from=&lt;sip:19168475801@srv.lcr.thinq.com&gt;, to=&lt;sip:18587645200@apidog.ApiReseller&gt;, date=&#039;2023-07-27&#039;,dow=&#039;4&#039;,tod=&#039;15:28&#039;)\n\tmatchedFrom (*)\n\tmatchedTo   (sip:1[2-9][0-9][0-9][1-9][0-9][0-9][0-9][0-9][0-9][0-9]@*)\n\tselectedRule(11-Digit DID)\n\tapps       =&lt;&lt;DID Table&gt; &lt;To Connection&gt;&gt;\n\tTranslate\n\t\t  To-URI from (sip:18587645200@apidog.ApiReseller) by ([*])(&lt;OwnDomain&gt;) to (sip:18587645200@apidog.ApiReseller)\n\t\tFrom-URI from (sip:19168475801@srv.lcr.thinq.com) by (&lt;OwnCidName&gt;)(&lt;OwnCidNmbr&gt;)(&lt;OwnDomain&gt;) to (&quot;Dicki - Reilly&quot; &lt;sip:689346037@apidog.ApiReseller&gt;)","CNmsUaSessionStateForwardCall(20230727222812052283)::ApplyDialPlan(1,1022) &lt;DID Table&gt;\n\t(from=&lt;sip:689346037@apidog.ApiReseller&gt;, to=&lt;sip:18587645200@apidog.ApiReseller&gt;, date=&#039;2023-07-27&#039;,dow=&#039;4&#039;,tod=&#039;15:28&#039;)\n\t - does not match any rule","CNmsUaSessionStateForwardCall(20230727222812052283)::ApplyDialPlan(2,1021) Last Plan &lt;To Connection&gt;\n\towner       &lt;1000@apidog.ApiReseller&gt;\n\tcaller      &lt;1000@apidog.ApiReseller&gt;\n\tsearchedBy  (from=&lt;sip:689346037@apidog.ApiReseller&gt;, to=&lt;sip:18587645200@apidog.ApiReseller&gt;, date=&#039;2023-07-27&#039;,dow=&#039;4&#039;,tod=&#039;15:28&#039;)\n\tmatchedFrom (*)\n\tmatchedTo   (*)\n\tselectedRule(To Connection)\n\tapps       =&lt;sip:start@to-connection&gt;\n\tTranslate\n\t\t  To-URI from (sip:18587645200@apidog.ApiReseller) by ([*])([*]) to (sip:18587645200@apidog.ApiReseller)\n\t\tFrom-URI from (&quot;Dicki - Reilly&quot; &lt;sip:689346037@apidog.ApiReseller&gt;) by ([*])([*])([*]) to (&quot;Dicki - Reilly&quot; &lt;sip:689346037@apidog.ApiReseller&gt;)","CNmsUaSessionStateForwardCall(20230727222812052283)::CheckDialPolicy(0)&lt;US and Canada&gt;\n\tagainst (sip:18587645200@apidog.ApiReseller)\n\t match &lt;*&gt;(Permit All) - (permit)","CNmsUaSessionStateForwardCall(20230727222812052283)::CheckTimeout (AccountUser,CallDestAddress)\n\tdialPlanFor=&lt;1000@apidog.ApiReseller&gt;\n\tdialPlan   =&lt;Default&gt;\n\tdestination=&lt;sip:18587645200@apidog.ApiReseller&gt;\n\t- new OutInvCdr\n\tforwardUri =&lt;sip:18587645200@apidog.ApiReseller&gt;","CNmsUaSessionStateForwardCall(20230727222812052283)::LookupResponder(sip:start@to-connection)\n\t- Found mode=(invite_call)","CNmsUaSessionStateForwardCall(20230727222812052283)::SwitchToApplication(sip:start@to-connection)\n\t- found responder\n\tName       =(To Connection)\n\tMatch      =(sip:start@to-connection)\n\tMediaMode  =(invite_call)\n\tP0         =(CallOutbound)\n\tP1         =(n\/a)\n\tNextUser0  =(chk-next-call)\n\tNextHost0  =(talk-return)\n\tNextUser1  =([*])\n\tNextHost1  =(talking)","CNmsUaSessionStateConnectDevice(20230727222812052283)::LoadRoute\n\tbtn          =(689346037)\n\t- found route for\n\t\tfrom         =&lt;sip:689346037@apidog.ApiReseller&gt;\n\t\tto           =&lt;sip:18587645200@apidog.ApiReseller&gt;\n\t\ttoUri        =&lt;sip:18587645200@apidog.ApiReseller&gt;\n\t\tat            &lt;eng0-san.netsapiens.com&gt;\n\t\tselect        &lt;US Domestic Call&gt; (*)(sip:1??????????@*)\n\t\twith          3 fixed connections.","CNmsUaSessionStateConnectDevice(20230727222812052283)::LookupRegisteredUA(sip:18587645200@srv.lcr.thinq.com)\n\tFromUri      =&lt;&quot;Dicki - Reilly&quot; &lt;sip:689346037@apidog.ApiReseller&gt;&gt;\n\tbSRing       =false\n\t- found no match","CNmsUaSessionStateConnectDevice(20230727222812052283)::LookupGateway(sip:18587645200@srv.lcr.thinq.com)\n\tfound        &lt;sip:*@srv.lcr.thinq.com&gt;(srv.lcr.thinq.com)\n\tbWanGW      =true\n\tbIsNcs      =false\n\t- PidfLo not required\n\tOrigDomain  =&lt;apidog.ApiReseller&gt;\n\tTermDomain  =&lt;*&gt;\n\tByDomain    =&lt;apidog.ApiReseller&gt;\n\tBySessionKey=(eng0-san.netsapiens.com:1000@apidog.ApiReseller:20230727222812052283)\n\tdomain&lt;apidog.ApiReseller&gt;, session already exist but not external, countForLimit(1) vs limit(15), countExternal(0) &lt; limitExt(10) - is OK\n\tforceCidRplc=false\n\tbIsAnonymous=false - SRV returned 3 records.","CNmsUaSessionStateConnectDevice(20230727222812052283)::LookupRoute\n\tto            (sip:18587645200@apidog.ApiReseller)\n\tfrom          &lt;sip:689346037@apidog.ApiReseller&gt;\n\tbSRing       =false\n\tselect        (1) Chain(1,3) Route(US Domestic Call) Connection(1):&lt;[*]@srv.lcr.thinq.com&gt; To &lt;sip:18587645200@srv.lcr.thinq.com&gt;","CNmsUaSessionStateConnectDevice(20230727222812052283)::LookupRegisteredUA(sip:18587645200@srv.lcr.thinq.com)\n\tFromUri      =&lt;&quot;Dicki - Reilly&quot; &lt;sip:689346037@apidog.ApiReseller&gt;&gt;\n\tbSRing       =false\n\t- found no match","CNmsUaSessionStateConnectDevice(20230727222812052283)::LookupGateway::SetSipTransport(sip:18587645200@srv.lcr.thinq.com)\n\tto           (UdpV4) &lt;10.200.1.11:5060&gt;","CNmsUaSessionStateConnectDevice(20230727222812052283)::LookupGateway from Contact\n\tinsertAddress  (192.81.236.31)\n\ttrimmed        (192.81.236.31)\n\tto Leg for  GW=&lt;sip:18587645200@srv.lcr.thinq.com&gt;","CNmsUaSessionStateConnectDevice(20230727222812052283)::UpdateRtpRelay fwrd=&lt;sip:18587645200@srv.lcr.thinq.com&gt; orig=&lt;sip:19168475801@srv.lcr.thinq.com&gt;\/(24500) bNoPortChange=false - requested forward Audio Relay (27820)","CNmsUaSessionStateConnectDevice(20230727222812052283)::LookupGateway(sip:18587645200@srv.lcr.thinq.com)\n\tfound        &lt;sip:*@srv.lcr.thinq.com&gt;(srv.lcr.thinq.com)\n\tbWanGW      =true\n\tbIsNcs      =false\n\t- PidfLo not required\n\tOrigDomain  =&lt;apidog.ApiReseller&gt;\n\tTermDomain  =&lt;*&gt;\n\tByDomain    =&lt;apidog.ApiReseller&gt;\n\tBySessionKey=(eng0-san.netsapiens.com:1000@apidog.ApiReseller:20230727222812052283)\n\tdomain&lt;apidog.ApiReseller&gt;, session already exist but not external, countForLimit(1) vs limit(15), countExternal(0) &lt; limitExt(10) - is OK\n\tforceCidRplc=false\n\tbIsAnonymous=false\n\t(Host from SRV): lcr-lb01.rdu.thinq.com:5060\n\tat FQDN      &lt;lcr-lb01.rdu.thinq.com&gt; (v4)\n\tresolved to  &lt;192.81.236.31&gt; and port (5060)\n\ttranslate\n\t\tTo-URI   from (18587645200@srv.lcr.thinq.com) by ([*]@srv.lcr.thinq.com) to (sip:18587645200@srv.lcr.thinq.com)\n\t\tFrom-URI from (&quot;Dicki - Reilly&quot; &lt;sip:689346037@apidog.ApiReseller&gt;) by ([*]@netsapiens.com) to (&quot;Dicki - Reilly&quot; &lt;sip:689346037@netsapiens.com&gt;)\n\tfwrdFromUri =(&quot;Dicki - Reilly&quot; &lt;sip:689346037@netsapiens.com&gt;)","CNmsUaSessionStateConnectDevice(20230727222812052283)::LookupRoute\n\tto            (sip:18587645200@apidog.ApiReseller)\n\tfrom          &lt;sip:689346037@apidog.ApiReseller&gt;\n\tbSRing       =false\n\tselect        (2) Chain(1,5) Route(US Domestic Call) Connection(1):&lt;[*]@srv.lcr.thinq.com&gt; To &lt;sip:18587645200@srv.lcr.thinq.com&gt;","CNmsUaSessionStateConnectDevice(20230727222812052283)::SetupForwardLeg(0) &lt;sip:18587645200@apidog.ApiReseller&gt;\n\torigAor          =&lt;sip:19168475801@srv.lcr.thinq.com&gt;\n\tcallID           =(20230727222818052294-6cc082866aafdc5dee7a480c2d339c76)\n\tfromUri          =(&quot;Dicki - Reilly&quot; &lt;sip:689346037@apidog.ApiReseller&gt;) from Original Leg","CNmsUaSessionStateConnectDevice(20230727222812052283)::SetRouteTimeout to 9s at &#039;2023-07-27 22:28:27&#039;","CNmsUaSessionStateConnectDevice(20230727222812052283)::OnEntry\n\tbRegistrationExpired=false\n\tbFoundRegisteredUA  =false\n\tbPendingRegistration=false\n\tbDndExceptionPending=false\n\tbLoopDetected       =false\n\tvia Connection       (srv.lcr.thinq.com)\/(sip*@srv.lcr.thinq.com)\n\tbIsPushedAndPending =false","CSipSessionLeg(sip:18587645200@srv.lcr.thinq.com)::IsPendingFulfilled\n\t- not pending","CNmsUaSessionStateConnectDevice(20230727222812052283)::CheckTimeout\n\t- change state to Connecting","CNmsUaSessionStateConnecting(20230727222812052283)::SendForwardInvite\n\tbForceUnHold     = true\n\tuDeltaSecond     = 0\n\tuUacTimeOutSec   = 0\n\tbIsOrigGeo       =false\n\tbIsOrigGw        =true\n\tbIsTermNcs       =false\n\tbIsStateInviting =(false)\n\tbBlockAlertInfo  =(true)\n\t- make Invite from pOriginalLeg&lt;sip:19168475801@srv.lcr.thinq.com&gt;&#039;s Response\n\tbIsWanUA         = true\n\ttowards           &lt;sip:18587645200@srv.lcr.thinq.com&gt;\n\tat                (192.81.236.31:5060)","CNmsUaSessionStateConnecting(20230727222812052283)::SendRequest\n\tto                &lt;sip:18587645200@srv.lcr.thinq.com&gt;\n\tat                (192.81.236.31:5060) (UdpV4)\n\tviaTag           =(J8m5Gkb6ZBl7NZ711A5F8E)\n\tkey              =(G1OIir58iPr9nnFE1A5F8D)\n\tCB2BProxyUACStateCalling(z9hG4bKJ8m5Gkb6ZBl7NZ711A5F8EINVITE201)::SendInviteRequest\n\tto   192.81.236.31\n\tvia  (UDP)\n\t- sent","CNmsUaSessionStateConnecting(20230727222812052283)::SetAnswerTimeout by System Ring TO to 60s at &#039;2023-07-27 22:29:18&#039;","CNmsUaSessionStateConnecting(20230727222812052283)::SetRouteTimeout to 6s at &#039;2023-07-27 22:28:24&#039;","CMediaPlayback(21106)::Initialize\n\tRfc2833 Type=101\n\tpayloadType =(0)\n\tmediaName   =(PCMU)\n\tto           &lt;10.200.1.11:24502&gt;\n\tfrom         &lt;\/usr\/local\/NetSapiens\/SiPbx\/data\/apidog.ApiReseller\/domain\/audio\/&gt; (phrase-call-is-being-forwarded.wav)"],"core":1,"edge":null,"method":"","ts_ms":"1690496898854","ts_text":"2023-07-27_22:28:18"},{"msg":"Sending to 192.81.236.31:5060 (UdpV4)\nINVITE sip:18587645200@srv.lcr.thinq.com SIP\/2.0\r\nVia: SIP\/2.0\/UDP 4.30.7.38:5060;branch=z9hG4bKJ8m5Gkb6ZBl7NZ711A5F8E\r\nFrom: &quot;Dicki - Reilly&quot; &lt;sip:689346037@netsapiens.com&gt;;tag=G1OIir58iPr9nnFE1A5F8D\r\nTo: &lt;sip:18587645200@srv.lcr.thinq.com&gt;\r\nCall-ID: 20230727222818052294-6cc082866aafdc5dee7a480c2d339c76\r\nCSeq: 201 INVITE\r\nMax-Forwards: 20\r\nContact: &lt;sip:sdf@4.30.7.38:5060;transport=udp&gt;\r\nServer: NetSapiens SiPBx v43-4-0x15\r\nContent-Type: application\/sdp\r\nContent-Length: 238\r\n\r\nv=0\r\no=NetSapiens_Nms 1690496898 1690496898089 IN IP4 4.30.7.38\r\ns=-\r\nc=IN IP4 4.30.7.38\r\nt=0 0\r\nm=audio 27820 RTP\/AVP 0 101 13\r\na=sendrecv\r\na=rtpmap:0 PCMU\/8000\/1\r\na=rtpmap:101 telephone-event\/8000\r\na=fmtp:101 0-15\r\na=rtpmap:13 CN\/8000","core":1,"edge":2,"method":"INVITE","ts_ms":"1690496898928","ts_text":"2023-07-27_22:28:18"},{"msg":"Received Packet from 192.81.236.31:5060\nSIP\/2.0 100 Giving a try\r\nVia: SIP\/2.0\/UDP 10.200.1.11:5060;branch=z9hG4bKJ8m5Gkb6ZBl7NZ711A5F8E\r\nFrom: &quot;Dicki - Reilly&quot; &lt;sip:689346037@netsapiens.com&gt;;tag=G1OIir58iPr9nnFE1A5F8D\r\nTo: &lt;sip:18587645200@srv.lcr.thinq.com&gt;\r\nCall-ID: 20230727222818052294-6cc082866aafdc5dee7a480c2d339c76\r\nCSeq: 201 INVITE\r\nServer: thinQ LB\r\nContent-Length: 0","core":1,"edge":2,"method":"100","ts_ms":"1690496899006","ts_text":"2023-07-27_22:28:19"},{"msg":["CNmsUaSessionStateConnecting(20230727222812052283)::Process (100) Response\n\tfrom        &lt;192.81.236.31&gt;\n\tcallID     =&lt;20230727222818052294-6cc082866aafdc5dee7a480c2d339c76&gt;\n\tCSeq       =(201 INVITE)"],"core":1,"edge":null,"method":"","ts_ms":"1690496899021","ts_text":"2023-07-27_22:28:19"},{"msg":"Received Packet from 192.81.236.31:5060\nSIP\/2.0 200 OK\r\nVia: SIP\/2.0\/UDP 10.200.1.11:5060;branch=z9hG4bKJ8m5Gkb6ZBl7NZ711A5F8E\r\nCall-ID: 20230727222818052294-6cc082866aafdc5dee7a480c2d339c76\r\nCSeq: 201 INVITE\r\nFrom: &quot;Dicki - Reilly&quot; &lt;sip:689346037@netsapiens.com&gt;;tag=G1OIir58iPr9nnFE1A5F8D\r\nTo: &lt;sip:18587645200@srv.lcr.thinq.com&gt;;tag=sip+3+63570023+18a6fb98\r\nServer: SIP\/2.0\r\nContent-Length: 237\r\nSupported: timer,replaces\r\nContact: &lt;sip:192.81.236.31;met=f2b.79f2c5d&gt;\r\nContent-Type: application\/sdp\r\nAccept: application\/sdp, application\/isup, application\/dtmf,multipart\/mixed\r\nAllow: INVITE,ACK,CANCEL,BYE,REGISTER,REFER,INFO,SUBSCRIBE,NOTIFY,PRACK,UPDATE,OPTIONS,MESSAGE,PUBLISH\r\nSession-Expires: 1800;refresher=uas\r\n\r\nv=0\r\no=Sonus_UAC 11502567167625 11502567167625 IN IP4 40.139.11.143\r\ns=-\r\nc=IN IP4 40.139.11.143\r\nt=0 0\r\nm=audio 22750 RTP\/AVP 0 101\r\na=sendrecv\r\na=rtpmap:0 PCMU\/8000\/1\r\na=rtpmap:101 telephone-event\/8000\r\na=fmtp:101 0-15\r\na=maxptime:20","core":1,"edge":2,"method":"200","ts_ms":"1690496899774","ts_text":"2023-07-27_22:28:19"},{"msg":["CNmsUaSessionStateConnecting(20230727222812052283)::UpdateRtpRelay fwrd=&lt;sip:18587645200@srv.lcr.thinq.com&gt;\/(27820) orig=&lt;sip:19168475801@srv.lcr.thinq.com&gt;\/(24500) bNoPortChange=false Rfc2833=101","CNmsUaSessionStateConnecting(20230727222812052283) from SDP\n\tinsertAddress  (40.139.11.143)\n\ttrimmed        (40.139.11.143)\n\tto Leg for  GW=&lt;sip:18587645200@srv.lcr.thinq.com&gt;","CNmsUaSessionStateConnecting(20230727222812052283)::UpdateCdrMedia from (200) Response Media=&#039;PCMU&#039; &lt;0 101&gt; Old=&#039;PCMU&#039;","CNmsUaSessionStateConnecting(20230727222812052283)::Process (200) Response\n\tfrom        &lt;192.81.236.31:5060&gt;\n\tcallID     =&lt;20230727222818052294-6cc082866aafdc5dee7a480c2d339c76&gt;\n\tCSeq       =(201 INVITE)","CNmsUaSessionStateConnecting(20230727222812052283)::SendRequest\n\tto                &lt;sip:19168475801@srv.lcr.thinq.com&gt;\n\tat                (192.81.236.31:5060) (UdpV4)\n\tviaTag           =(HDyfBe4f6gvEgv1X1A5F90)\n\tkey              =(8lyTZFJKwYuGGNX91A5F8A)\n\tCB2BProxyUACStateCalling(z9hG4bKHDyfBe4f6gvEgv1X1A5F90INVITE201)::SendInviteRequest\n\tto   192.81.236.31\n\tvia  (UDP)\n\t- sent","CNmsUaSessionStateReinviting(20230727222812052283)::OnEntry"],"core":1,"edge":null,"method":"","ts_ms":"1690496899790","ts_text":"2023-07-27_22:28:19"},{"msg":"Sending to 192.81.236.31:5060 (UdpV4)\nINVITE sip:192.81.236.31 SIP\/2.0\r\nVia: SIP\/2.0\/UDP 4.30.7.38:5060;branch=z9hG4bKHDyfBe4f6gvEgv1X1A5F90\r\nFrom: &lt;sip:689346037@netsapiens.com&gt;;tag=8lyTZFJKwYuGGNX91A5F8A\r\nTo: &lt;sip:19168475801@srv.lcr.thinq.com&gt;;tag=sip+1+4fb5000b+2256999\r\nCall-ID: my-random-unique-callid\r\nCSeq: 201 INVITE\r\nMax-Forwards: 20\r\nContact: &lt;sip:sdf@4.30.7.38:5060;transport=udp&gt;\r\nServer: NetSapiens SiPBx v43-4-0x15\r\nContent-Type: application\/sdp\r\nContent-Length: 253\r\n\r\nv=0\r\no=NetSapiens_Nms 1690496892 1690496899090 IN IP4 4.30.7.38\r\ns=-\r\nc=IN IP4 4.30.7.38\r\nt=0 0\r\nm=audio 27822 RTP\/AVP 0 101 13\r\na=sendrecv\r\na=rtpmap:0 PCMU\/8000\/1\r\na=rtpmap:101 telephone-event\/8000\r\na=fmtp:101 0-15\r\na=maxptime:20\r\na=rtpmap:13 CN\/8000","core":1,"edge":2,"method":"INVITE","ts_ms":"1690496899796","ts_text":"2023-07-27_22:28:19"},{"msg":"Received Packet from 192.81.236.31:5060\nSIP\/2.0 100 Giving a try\r\nVia: SIP\/2.0\/UDP 10.200.1.11:5060;branch=z9hG4bKHDyfBe4f6gvEgv1X1A5F90\r\nFrom: &lt;sip:689346037@netsapiens.com&gt;;tag=8lyTZFJKwYuGGNX91A5F8A\r\nTo: &lt;sip:19168475801@srv.lcr.thinq.com&gt;;tag=sip+1+4fb5000b+2256999\r\nCall-ID: my-random-unique-callid\r\nCSeq: 201 INVITE\r\nServer: thinQ LB\r\nContent-Length: 0","core":1,"edge":2,"method":"100","ts_ms":"1690496899875","ts_text":"2023-07-27_22:28:19"},{"msg":["CNmsUaSessionStateReinviting(20230727222812052283)::Process (100) Response\n\tTo-URI   : &lt;sip:19168475801@srv.lcr.thinq.com&gt;;tag=sip+1+4fb5000b+2256999\n\tFrom-URI : &lt;sip:689346037@netsapiens.com&gt;;tag=8lyTZFJKwYuGGNX91A5F8A from 192.81.236.31:5060\n\tCallID   : &lt;my-random-unique-callid&gt;\n\tCSeq     : 201 INVITE\n\t - Response from OriginalLeg. Turn Off Route T\/O&lt;sip:19168475801@srv.lcr.thinq.com&gt;"],"core":1,"edge":null,"method":"","ts_ms":"1690496899893","ts_text":"2023-07-27_22:28:19"},{"msg":"Received Packet from 192.81.236.31:5060\nSIP\/2.0 200 OK\r\nVia: SIP\/2.0\/UDP 10.200.1.11:5060;branch=z9hG4bKHDyfBe4f6gvEgv1X1A5F90\r\nCall-ID: my-random-unique-callid\r\nCSeq: 201 INVITE\r\nFrom: &lt;sip:689346037@netsapiens.com&gt;;tag=8lyTZFJKwYuGGNX91A5F8A\r\nTo: &lt;sip:19168475801@srv.lcr.thinq.com&gt;;tag=sip+1+4fb5000b+2256999\r\nServer: SIP\/2.0\r\nContent-Length: 231\r\nContact: &lt;sip:192.81.236.31;met=c34.6ae0e6a5&gt;\r\nContent-Type: application\/sdp\r\nAllow: INVITE,ACK,CANCEL,BYE,REFER,OPTIONS,NOTIFY,SUBSCRIBE,PRACK,INFO\r\nUser-Agent: ENSR3.0.66.72-IS1-RMRG40880-RG2216-CPO26475\r\n\r\nv=0\r\no=- 110106426344211 110106426344212 IN IP4 40.139.11.149\r\ns=-\r\nc=IN IP4 40.139.11.149\r\nt=0 0\r\nm=audio 52436 RTP\/AVP 0 101\r\na=sendrecv\r\na=rtpmap:0 PCMU\/8000\/1\r\na=rtpmap:101 telephone-event\/8000\r\na=maxptime:20\r\na=fmtp:101 0-15","core":1,"edge":2,"method":"200","ts_ms":"1690496900039","ts_text":"2023-07-27_22:28:20"},{"msg":["CNmsUaSessionStateReinviting(20230727222812052283)::Process 200 OK\n\tTo-URI   : &lt;sip:19168475801@srv.lcr.thinq.com&gt;;tag=sip+1+4fb5000b+2256999\n\tFrom-URI : &lt;sip:689346037@netsapiens.com&gt;;tag=8lyTZFJKwYuGGNX91A5F8A from 192.81.236.31:5060\n\tCallID   : &lt;my-random-unique-callid&gt;\n\tCSeq     : 201 INVITE\n\t- from OriginalLeg&lt;sip:19168475801@srv.lcr.thinq.com&gt;","CNmsUaSessionStateReinviting(20230727222812052283)::LookupResponder(sip:start@talking)\n\t- Found mode=(talking)","CNmsUaSessionStateReinviting(20230727222812052283)::LookupNextResponder case(1)\n\tTranslate\n\t\tfrom &lt;start@to-connection&gt;\n\t\tby   ([*])(talking)\n\t\tto   (sip:start@talking)(sip:start@talking)\n\t- found responder\n\tName       =(Talking)\n\tMatch      =(sip:*@talking)\n\tMediaMode  =(talking)\n\tP0         =(n\/a)\n\tP1         =(n\/a)\n\tNextUser0  =(chk-orig-bye)\n\tNextHost0  =(talk-return)\n\tNextUser1  =([*])\n\tNextHost1  =(transfer)","CNmsUaSessionStateTalking(20230727222812052283)::OnEntry\n\t#leg             =2","CNmsUaSessionStateTalking(20230727222812052283)::UpdateCdrMedia from (200) Response Media=&#039;PCMU&#039; &lt;0 101&gt; Old=&#039;PCMU&#039;","CNmsUaSessionStateTalking(20230727222812052283)::RestartRtpRelay\n\tOriginal rlyPort(27822) media &lt;40.139.11.149:52436&gt; aor=&lt;sip:19168475801@srv.lcr.thinq.com&gt; cccId() rfc2833=101 dtlsSetup=&lt;&gt;\n\tForward rlyPort(27820) media &lt;40.139.11.143:22750&gt; aor=&lt;sip:18587645200@srv.lcr.thinq.com&gt; cccId() rfc2833=101 dtlsSetup=&lt;&gt;","CNmsUaSessionStateTalking(20230727222812052283)::SetTalkTimeout to 10800s at &#039;2023-07-28 01:28:20&#039;"],"core":1,"edge":null,"method":"","ts_ms":"1690496900055","ts_text":"2023-07-27_22:28:20"},{"msg":"Sending to 192.81.236.31:5060 (UdpV4)\nACK sip:192.81.236.31 SIP\/2.0\r\nVia: SIP\/2.0\/UDP 4.30.7.38:5060;branch=z9hG4bKCrUQQ2nZxO9H9tfB1A5F91\r\nFrom: &lt;sip:689346037@netsapiens.com&gt;;tag=8lyTZFJKwYuGGNX91A5F8A\r\nTo: &lt;sip:19168475801@srv.lcr.thinq.com&gt;;tag=sip+1+4fb5000b+2256999\r\nCall-ID: my-random-unique-callid\r\nCSeq: 201 ACK\r\nMax-Forwards: 20\r\nContent-Length: 0","core":1,"edge":2,"method":"ACK","ts_ms":"1690496900079","ts_text":"2023-07-27_22:28:20"},{"msg":"Sending to 192.81.236.31:5060 (UdpV4)\nACK sip:192.81.236.31 SIP\/2.0\r\nVia: SIP\/2.0\/UDP 4.30.7.38:5060;branch=z9hG4bKds9iRQO4jsWjVN1X1A5F92\r\nFrom: &quot;Dicki - Reilly&quot; &lt;sip:689346037@netsapiens.com&gt;;tag=G1OIir58iPr9nnFE1A5F8D\r\nTo: &lt;sip:18587645200@srv.lcr.thinq.com&gt;;tag=sip+3+63570023+18a6fb98\r\nCall-ID: 20230727222818052294-6cc082866aafdc5dee7a480c2d339c76\r\nCSeq: 201 ACK\r\nMax-Forwards: 20\r\nContent-Length: 0","core":1,"edge":2,"method":"ACK","ts_ms":"1690496900079","ts_text":"2023-07-27_22:28:20"},{"msg":"Received Packet from 192.81.236.31:5060\nBYE sip:sdf@10.200.1.11:5060;transport=udp SIP\/2.0\r\nVia: SIP\/2.0\/UDP 192.81.236.31:5060;branch=z9hG4bKd5f7.0ae505f3.0\r\nCall-ID: my-random-unique-callid\r\nFrom: &quot;19168475801&quot; &lt;sip:19168475801@srv.lcr.thinq.com&gt;;tag=sip+1+4fb5000b+2256999\r\nTo: &lt;sip:689346037@netsapiens.com&gt;;tag=8lyTZFJKwYuGGNX91A5F8A\r\nCSeq: 424568309 BYE\r\nContent-Length: 0\r\nMax-Forwards: 31\r\nUser-Agent: ENSR3.0.66.72-IS1-RMRG40880-RG2216-CPO26475","core":1,"edge":2,"method":"BYE","ts_ms":"1690496904058","ts_text":"2023-07-27_22:28:24"},{"msg":["CNmsUaSessionStateTalking(20230727222812052283)::Process BYE\n\tTo-URI    :&lt;sip:689346037@netsapiens.com&gt;;tag=8lyTZFJKwYuGGNX91A5F8A\n\tFrom-URI  :&quot;19168475801&quot; &lt;sip:19168475801@srv.lcr.thinq.com&gt;;tag=sip+1+4fb5000b+2256999\n\tfrom       &lt;192.81.236.31:5060&gt;\n\t- BYE from Orig","CB2BProxySessionStateDisconnecting(20230727222812052283)::UpdateCdrDuration Duration=5s Hold=0s Talk=5s Relay\n\t(10.200.1.11:27820) (IPV4) &lt;40.139.11.143:22750&gt; 34400 (34400\/516\/34400) bytes 55.04Kbps,\n\t(10.200.1.11:27822) (IPV4) &lt;40.139.11.149:52436&gt; 33368 (33368\/516\/33368) bytes 53.39Kbps"],"core":1,"edge":null,"method":"","ts_ms":"1690496904067","ts_text":"2023-07-27_22:28:24"},{"msg":"Sending to 192.81.236.31:5060 (UdpV4)\nSIP\/2.0 200 OK\r\nVia: SIP\/2.0\/UDP 192.81.236.31:5060;branch=z9hG4bKd5f7.0ae505f3.0;received=192.81.236.31\r\nTo: &lt;sip:689346037@netsapiens.com&gt;;tag=8lyTZFJKwYuGGNX91A5F8A\r\nFrom: &quot;19168475801&quot; &lt;sip:19168475801@srv.lcr.thinq.com&gt;;tag=sip+1+4fb5000b+2256999\r\nCall-ID: my-random-unique-callid\r\nCSeq: 424568309 BYE\r\nContent-Length: 0","core":1,"edge":2,"method":"200","ts_ms":"1690496904074","ts_text":"2023-07-27_22:28:24"},{"msg":"Sending to 192.81.236.31:5060 (UdpV4)\nBYE sip:192.81.236.31 SIP\/2.0\r\nVia: SIP\/2.0\/UDP 4.30.7.38:5060;branch=z9hG4bK3fOwlEp3bm4BV2AA1A5F95\r\nFrom: &quot;Dicki - Reilly&quot; &lt;sip:689346037@netsapiens.com&gt;;tag=G1OIir58iPr9nnFE1A5F8D\r\nTo: &lt;sip:18587645200@srv.lcr.thinq.com&gt;;tag=sip+3+63570023+18a6fb98\r\nCall-ID: 20230727222818052294-6cc082866aafdc5dee7a480c2d339c76\r\nCSeq: 202 BYE\r\nMax-Forwards: 20\r\nContent-Length: 0","core":1,"edge":2,"method":"BYE","ts_ms":"1690496904074","ts_text":"2023-07-27_22:28:24"},{"msg":"Received Packet from 192.81.236.31:5060\nSIP\/2.0 200 OK\r\nVia: SIP\/2.0\/UDP 10.200.1.11:5060;branch=z9hG4bK3fOwlEp3bm4BV2AA1A5F95\r\nCall-ID: 20230727222818052294-6cc082866aafdc5dee7a480c2d339c76\r\nCSeq: 202 BYE\r\nFrom: &quot;Dicki - Reilly&quot; &lt;sip:689346037@netsapiens.com&gt;;tag=G1OIir58iPr9nnFE1A5F8D\r\nTo: &lt;sip:18587645200@srv.lcr.thinq.com&gt;;tag=sip+3+63570023+18a6fb98\r\nServer: SIP\/2.0\r\nContent-Length: 0\r\nContact: &lt;sip:192.81.236.31;met=f2b.79f2c5d&gt;","core":1,"edge":2,"method":"200","ts_ms":"1690496904246","ts_text":"2023-07-27_22:28:24"}]};
]]>
</script><script xmlns:xlink="http://www.w3.org/1999/xlink" data-state="nsflow_ea98c1da65ce01046c5ca2b574be33ea" xlink:href="https://vb.netsapiens.com/portal/nsflow/bundle.js"></script></svg>" } ] } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/transcriptions": { "get": { "summary": "Read Transcription for Specific Call", "deprecated": false, "description": "", "tags": [ "Transcriptions & Sentiment", "44.3" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "example.com", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "id", "in": "query", "description": "The Job Id of the recording transcription. Required to be given on request. ID can be found in CDR read when available using field \"call-intelligence-job-id\"", "required": true, "example": 423542156, "schema": { "type": "number" } }, { "name": "date", "in": "query", "description": "The date will help identify the year and month of the call to limit the search down. The format will be YYYYMM", "required": true, "example": "202405", "schema": { "type": "string" } }, { "name": "callid", "in": "query", "description": "One callid_id needs to be provided that can be linked to the domain of the call> you can use any of the fields orig_callid, term_callid, by_callid or if you dont know which one you have just callid though callid might have additional DB lookups. ", "required": true, "example": "20241001224534015297-092d2c5baad20a2a3e5ae22b849b5e6", "schema": { "type": "string" } }, { "name": "orig_callid", "in": "query", "description": "One callid_id needs to be provided that can be linked to the domain of the call> you can use any of the fields orig_callid, term_callid, by_callid or if you dont know which one you have just callid though callid might have additional DB lookups. ", "required": false, "example": "453691718_66427591@4.55.78.161", "schema": { "type": "string" } }, { "name": "term_callid", "in": "query", "description": "One callid_id needs to be provided that can be linked to the domain of the call> you can use any of the fields orig_callid, term_callid, by_callid or if you dont know which one you have just callid though callid might have additional DB lookups. ", "required": false, "example": "20241001224534015297-092d2c5baad20a2a3e5ae22b849b5e6", "schema": { "type": "string" } }, { "name": "by_callid", "in": "query", "description": "One callid_id needs to be provided that can be linked to the domain of the call> you can use any of the fields orig_callid, term_callid, by_callid or if you dont know which one you have just callid though callid might have additional DB lookups. ", "required": false, "example": "20241001224534015293-092d2c5baad20a2a3e5ae22b849b5e6c", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Transcription" }, "example": { "call-intelligence-job-id": 179133950, "call-intelligence-processing-status": "finished", "created-datetime": "2024-10-01T22:48:21+00:00", "call-id": "20241001224534015297-092d2c5baad20a2a3e5ae22b849b5e6c", "call-intelligence-features-enabled": "transcription,sentiment,summary,topics", "call-intelligence-summary": "The customer calls Acme Automotive about a taillight part that hasn't arrived for their Toyota 4 Runner. The agent asks for the order number and confirms the part is for a RAV 4. The agent checks the system and confirms that the part should be sent later in the week. The call ends with the agent thanking the customer for their call and saying goodbye.", "call-intelligence-topics-top": [ "part order", "taillight", "toyota 4 runner" ], "call-intelligence-duration-seconds": 82.76, "call-intelligence-duration-seconds-negative": 0, "call-intelligence-duration-seconds-neutral": 75.5, "call-intelligence-duration-seconds-positive": 7.26, "call-intelligence-ending-duration-seconds": 31.79, "call-intelligence-ending-duration-seconds-negative": 0, "call-intelligence-ending-duration-seconds-neutral": 27.99, "call-intelligence-ending-duration-seconds-positive": 3.8, "call-intelligence-ending-percent-negative": 0, "call-intelligence-ending-percent-neutral": 88, "call-intelligence-ending-percent-positive": 12, "call-intelligence-ending-sentiment-scale": 0, "call-intelligence-percent-negative": 0, "call-intelligence-percent-neutral": 91, "call-intelligence-percent-positive": 9, "call-intelligence-segments": [ { "speaker": "sip:2000@example", "comment": "Hello, and thanks for calling Acme Automotive. How can I help you today?", "sentiment": "Positive", "start-time": "00:00:01,04", "end-time": "00:00:04,50" }, { "speaker": "sip:+18589267933@192.81.237.20", "comment": "Yeah. Hi. I\\'m calling about this taillight that I ordered, and I can\\'t seem to get it to work.", "sentiment": "Neutral", "start-time": "00:00:05,12", "end-time": "00:00:11,13" }, { "speaker": "sip:2000@example", "comment": "Alright. So you\\'re calling about a part order. Let me, go ahead and check that out. Okay? Do you have an order number on", "sentiment": "Neutral", "start-time": "00:00:11,44", "end-time": "00:00:17,59" }, { "speaker": "sip:+18589267933@192.81.237.20", "comment": "Yeah. Yeah. I do. Hold on. So, let me pull it up. My order number is a as in apple, 9 1 6 4 2 1 1.", "sentiment": "Neutral", "start-time": "00:00:17,89", "end-time": "00:00:27,27" }, { "speaker": "sip:2000@example", "comment": "you?", "sentiment": "Neutral", "start-time": "00:00:18,05", "end-time": "00:00:18,55" }, { "speaker": "sip:2000@example", "comment": "Alright. Thanks. Let me enter that here.", "sentiment": "Neutral", "start-time": "00:00:28,05", "end-time": "00:00:30,31" }, { "speaker": "sip:2000@example", "comment": "Okay. Yeah. I see that. So it, you didn\\'t get the part? It hasn\\'t arrived yet? Is that what you\\'re suggesting?", "sentiment": "Neutral", "start-time": "00:00:32,10", "end-time": "00:00:39,00" }, { "speaker": "sip:+18589267933@192.81.237.20", "comment": "No. I got the part, but it won\\'t plug in to my Toyota. It seems like it\\'s a part for a different car maybe.", "sentiment": "Neutral", "start-time": "00:00:39,86", "end-time": "00:00:47,08" }, { "speaker": "sip:2000@example", "comment": "Oh, okay. What model Toyota do you have?", "sentiment": "Neutral", "start-time": "00:00:47,47", "end-time": "00:00:50,77" }, { "speaker": "sip:+18589267933@192.81.237.20", "comment": "A 4 Runner.", "sentiment": "Neutral", "start-time": "00:00:51,72", "end-time": "00:00:52,62" }, { "speaker": "sip:2000@example", "comment": "4 Runner. Great car. Okay. Let me check that.", "sentiment": "Neutral", "start-time": "00:00:52,83", "end-time": "00:00:56,61" }, { "speaker": "sip:2000@example", "comment": "Yes. That does look like that\\'s a part for a RAV 4, which will not work.", "sentiment": "Neutral", "start-time": "00:00:58,89", "end-time": "00:01:04,19" }, { "speaker": "sip:+18589267933@192.81.237.20", "comment": "That would explain it. Okay.", "sentiment": "Neutral", "start-time": "00:01:04,62", "end-time": "00:01:06,24" }, { "speaker": "sip:2000@example", "comment": "Let me go ahead and ship you a new part, for your Toyota 4 Runner.", "sentiment": "Neutral", "start-time": "00:01:04,89", "end-time": "00:01:10,19" }, { "speaker": "sip:2000@example", "comment": "Let me see if I can do that. Yep. No problem. I have that in my system. That should go out later this week. Is there anything that I can help you with? Anything else I can help you with? Okay.", "sentiment": "Neutral", "start-time": "00:01:11,86", "end-time": "00:01:22,20" }, { "speaker": "sip:+18589267933@192.81.237.20", "comment": "That\\'s great.", "sentiment": "Neutral", "start-time": "00:01:18,50", "end-time": "00:01:19,48" }, { "speaker": "sip:+18589267933@192.81.237.20", "comment": "No. That\\'s awesome. That\\'s exactly what I needed. I appreciate the help.", "sentiment": "Neutral", "start-time": "00:01:20,34", "end-time": "00:01:23,88" }, { "speaker": "sip:2000@example", "comment": "I appreciate it very much. Thanks again for calling Acme Automotive.", "sentiment": "Positive", "start-time": "00:01:23,70", "end-time": "00:01:26,76" }, { "speaker": "sip:+18589267933@192.81.237.20", "comment": "Alright. Thank you. Bye now.", "sentiment": "Neutral", "start-time": "00:01:27,46", "end-time": "00:01:29,48" }, { "speaker": "sip:2000@example", "comment": "Thank you.", "sentiment": "Positive", "start-time": "00:01:28,40", "end-time": "00:01:29,14" } ], "call-intelligence-summary-status": "success", "call-intelligence-topics-all": [ "part order", "taillight", "toyota 4 runner", "vehicle model" ], "errors": null, "last-modified-datetime": "2024-10-01T22:48:26+00:00" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/calls": { "get": { "summary": "Read Active Calls In Domain", "deprecated": false, "description": "", "tags": [ "Calls (live/active calls)" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ActiveCall" } } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/calls/count": { "get": { "summary": "Count Active Calls In Domain", "deprecated": false, "description": "", "tags": [ "Calls (live/active calls)" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Count" }, "example": { "total": 0 } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 403, "message": "Domain not found or access denied" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/calls": { "get": { "summary": "Read Active Calls for User", "deprecated": false, "description": "", "tags": [ "Calls (live/active calls)" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/UserNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ActiveCall" } }, "example": [ { "hostname": "eng0-san.example.com", "session_id": "20230719183242018723", "orig_callid": "my-random-unique-callid", "orig_match": "2000@portal", "orig_user": "", "orig_domain": "", "orig_uri": "sip:18585551234@srv.lcr.thinq.com", "orig_name": "Pete TheReseller", "ani": "18585551234", "dnis": "18587645200", "by_action": "CallRequest", "by_user": "2000", "by_domain": "portal", "by_callid": "my-random-unique-callid", "term_callid": "20230719183258018753-6cc082866aafdc5dee7a480c2d339c76", "term_user": "", "term_domain": "*", "term_uri": "sip:18587645200@srv.lcr.thinq.com", "time_begin": "2023-07-19 18:32:58", "time_answer": "2023-07-19 18:32:59", "orig_call_info": "active", "term_call_info": "active", "media": "PCMU" } ] } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "post": { "summary": "Make a new Call", "deprecated": false, "description": "", "tags": [ "Calls (live/active calls)" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "synchronous": { "$ref": "#/components/schemas/Synchronous" }, "call-id": { "type": "string", "description": "This will be the callid for the requested call. This should be a random string generated by your application and stored if you want to read back the call later or end it. " }, "dial-rule-application": { "type": "string", "default": "call", "description": "The application can be used to help with next destination selection." }, "call-term-user": { "type": "string", "description": "This will be the destination or termination number for the call request. This will be used once the call is connected to the orgination number. " }, "call-orig-user": { "type": "string", "default": "user@domain", "examples": [ "1000@example.com", "18587645200" ], "description": "This field will allow you to select the device, user or number the first leg of the call request will connect to. If left blank the origination will be the user@domain of the user making the request. " }, "auto-answer-enabled": { "type": "string", "enum": [ "yes", "no" ], "default": "no", "description": "If enabled it will request auto answer headers for the first leg (origination) of the call. " }, "caller-id-number": { "type": "string", "description": "This setting will allow for the callerid of the termination leg to be set, by default it will be the preconfigured callerid of the user making the request. " }, "callback-caller-id-number": { "type": "string", "description": "This is the callerid that will be used when calling the first leg(callback) of the call request. If left empty it will default to the user's caller id. " } }, "required": [ "synchronous", "call-id", "call-term-user" ] }, "example": { "synchronous": "yes", "call-id": "{% faker random.alphaNumeric(16) %}", "dial-rule-application": "call", "call-orig-user": "19168475801", "call-term-user": "18587645200", "auto-answer-enabled": "no", "call-term-added-sip-header": "X-Example: TestHeader", "caller-id-number": "18587645226", "callback-caller-id-number": "18587645226" } } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/calls/{callid}": { "get": { "summary": "Read Specific Active Call", "deprecated": false, "description": "", "tags": [ "Calls (live/active calls)" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "callid", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActiveCall" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/calls/{call_id}": { "delete": { "summary": "Disconnect Call", "deprecated": false, "description": "", "tags": [ "Calls (live/active calls)" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "call_id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/calls/{call_id}/transferPeer": { "patch": { "summary": "Transfer Peer Call", "deprecated": false, "description": "", "tags": [ "Calls (live/active calls)", "44.4" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "call_id", "in": "path", "description": "This will be the callid for the requested call. This should be a random string generated by your application per call session.", "required": true, "example": "", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "destination": { "type": [ "string", "null" ], "description": "Destination for blind transfer. SIP account of the extension to transfer to" }, "valid": { "type": [ "string", "null" ], "description": "Comma seperated array of Call Park extensions for Dynamic Park case" }, "prefix": { "type": [ "string", "null" ], "description": "System wide prefix to prepend to each Call park extensions when using valid" } } }, "example": { "destination": "sip:ext@domain" } } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/calls/{call_id}/transfer": { "patch": { "summary": "Transfer Call", "deprecated": false, "description": "", "tags": [ "Calls (live/active calls)" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "call_id", "in": "path", "description": "", "required": true, "example": "zq3foox8rnkwjycu", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallActions" }, "example": { "destination": "18587625200" } } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/calls/{call_id}/answer": { "patch": { "summary": "Answer Call", "deprecated": false, "description": "", "tags": [ "Calls (live/active calls)" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "call_id", "in": "path", "description": "", "required": true, "example": "pg7wit1ulu0pk9ru", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallActions" }, "example": { "destination": "sip:{{user}}wp@{{domain}}" } } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/calls/{call_id}/hold": { "patch": { "summary": "Hold Active Call", "deprecated": false, "description": "", "tags": [ "Calls (live/active calls)" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "call_id", "in": "path", "description": "", "required": true, "example": "pg7wit1ulu0pk9ru", "schema": { "type": "string" } } ], "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/calls/{call_id}/unhold": { "patch": { "summary": "Un-Hold Active Call", "deprecated": false, "description": "", "tags": [ "Calls (live/active calls)" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "call_id", "in": "path", "description": "", "required": true, "example": "pg7wit1ulu0pk9ru", "schema": { "type": "string" } } ], "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/calls/{call_id}/reject": { "delete": { "summary": "Reject Call", "deprecated": false, "description": "Reject a call with orig call ID. This would cancel a \"ringing\" call prior to any answer event. If you're looking to disconnect an active call then, reference DELETE on /domains/{domain}/users/{user}/calls/{call_id}", "tags": [ "Calls (live/active calls)" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "call_id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "description": "", "content": { "*/*": { "schema": { "type": "object", "properties": {} } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/calls/report": { "post": { "summary": "Report Active Calls", "deprecated": false, "description": "", "tags": [ "Calls (live/active calls)" ], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": null } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": { "1705276800": [ { "type": "ah", "core2-iad.jg.nseng.dev": { "min": 0, "max": 0, "avg": 0, "date": "Mon, 15 Jan 2024 00:00:00 +0000" } }, { "type": "ah", "core1-iad.jg.nseng.dev": { "min": 0, "max": 0, "avg": 0, "date": "Mon, 15 Jan 2024 00:00:00 +0000" } } ] } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/contacts": { "get": { "summary": "Get Domain Contacts", "deprecated": false, "description": "", "tags": [ "Contacts/Shared Contacts" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Contact" } } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "post": { "summary": "Create Shared Contact", "deprecated": false, "description": "", "tags": [ "Contacts/Shared Contacts" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "", "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name-first-name": { "type": "string" }, "name-middle-name": { "type": "string" }, "name-last-name": { "type": "string" }, "email": { "type": "string" }, "company": { "type": "string" }, "phonenumber-work": { "type": "string" }, "phonenumber-cell": { "type": "string" }, "phonenumber-fax": { "type": "string" }, "phonenumber-home": { "type": "string" } }, "required": [ "name-first-name", "name-middle-name", "name-last-name", "email", "company", "phonenumber-work", "phonenumber-cell", "phonenumber-fax", "phonenumber-home" ] }, "example": { "name-first-name": "John", "name-middle-name": "imShared", "name-last-name": "Doe", "company": "netsap", "phonenumber-work": "8587645200" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/contacts/{contact_id}": { "get": { "summary": "Get Specific Domain Contact", "deprecated": false, "description": "", "tags": [ "Contacts/Shared Contacts" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "contact_id", "in": "path", "description": "", "required": true, "example": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Contact" } } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "put": { "summary": "Update Shared Contact", "deprecated": false, "description": "", "tags": [ "Contacts/Shared Contacts" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "contact_id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name-first-name": { "type": "string" }, "name-middle-name": { "type": "string" }, "name-last-name": { "type": "string" }, "email": { "type": "string" }, "company": { "type": "string" }, "phonenumber-work": { "type": "string" }, "phonenumber-cell": { "type": "string" }, "phonenumber-fax": { "type": "string" }, "phonenumber-home": { "type": "string" } }, "required": [ "name-first-name", "name-middle-name", "name-last-name", "email", "company", "phonenumber-work", "phonenumber-cell", "phonenumber-fax", "phonenumber-home" ] }, "example": null } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "delete": { "summary": "Delete Shared Contact", "deprecated": false, "description": "", "tags": [ "Contacts/Shared Contacts" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "contact_id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/contacts": { "get": { "summary": "Get Contacts for User", "deprecated": false, "description": "", "tags": [ "Contacts" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "", "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "includeDomain", "in": "query", "description": "Whether to include onnet domain users, will also match the users to contact details. (values: \"yes\"/\"no\", default \"no\")", "required": false, "example": "true", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Contact" } } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "post": { "summary": "Create Contact", "deprecated": false, "description": "", "tags": [ "Contacts" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "", "schema": { "$ref": "#/components/schemas/UserNamePath" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name-first-name": { "type": "string" }, "name-middle-name": { "type": "string" }, "name-last-name": { "type": "string" }, "email": { "type": "string" }, "company": { "type": "string" }, "phonenumber-work": { "type": "string" }, "phonenumber-cell": { "type": "string" }, "phonenumber-fax": { "type": "string" }, "phonenumber-home": { "type": "string" } }, "required": [ "name-first-name", "name-middle-name", "name-last-name", "email", "company", "phonenumber-work", "phonenumber-cell", "phonenumber-fax", "phonenumber-home" ] }, "example": { "name-first-name": "culpa in", "name-middle-name": "do voluptate", "name-last-name": "consequat esse cillum dolor Lorem", "email": "do sunt ut incididunt id", "company": "et eu cillum", "phonenumber-work": "labore dolore culpa", "phonenumber-cell": "sint est ipsum", "phonenumber-fax": "aute dolor in", "phonenumber-home": "do est" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/contacts/{contact_id}": { "get": { "summary": "Get Specific Contact for User", "deprecated": false, "description": "", "tags": [ "Contacts" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "", "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "contact_id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Contact" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "put": { "summary": "Update Contact", "deprecated": false, "description": "", "tags": [ "Contacts" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "", "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "contact_id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name-first-name": { "type": "string" }, "name-middle-name": { "type": "string" }, "name-last-name": { "type": "string" }, "email": { "type": "string" }, "company": { "type": "string" }, "phonenumber-work": { "type": "string" }, "phonenumber-cell": { "type": "string" }, "phonenumber-fax": { "type": "string" }, "phonenumber-home": { "type": "string" }, "created-datetime": { "type": "string" } }, "required": [ "name-first-name", "name-middle-name", "name-last-name", "email", "company", "phonenumber-work", "phonenumber-cell", "phonenumber-fax", "phonenumber-home", "created-datetime" ] }, "example": null } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "delete": { "summary": "Delete Contact", "deprecated": false, "description": "", "tags": [ "Contacts" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "contact_id", "in": "path", "description": "", "required": true, "example": "999b5ac4b5095251870476d449954554", "schema": { "type": "string" } } ], "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/contacts/count": { "get": { "summary": "Count Contacts for User", "deprecated": false, "description": "", "tags": [ "Contacts" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Count" }, "example": { "total": 75 } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 403, "message": "Domain not found or access denied" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/~/users/~/contacts": { "get": { "summary": "Get My Contacts", "deprecated": false, "description": "", "tags": [ "Contacts" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Contact" } } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/addresses": { "get": { "summary": "Get Addresses for Domain", "deprecated": false, "description": "", "operationId": "GetAddressesForDomain", "tags": [ "Addresses" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "", "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Address" } } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "post": { "summary": "Create Address for Domain", "deprecated": false, "description": "", "operationId": "CreateAddressForDomain", "tags": [ "Addresses" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "", "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "emergency-address-id": { "type": "string", "description": "This is an autogenerated ID for the Address." }, "address-name": { "type": "string", "description": "This is the name label for the address" }, "caller-name": { "type": "string", "description": "This is the caller's name for the address" }, "address-line-1": { "type": "string", "description": "This is the address line 1 for the address" }, "address-line-2": { "type": [ "string", "null" ], "description": "This is the address line 2 for the address" }, "address-city": { "type": "string", "description": "This is the city for the address" }, "address-state-province-abbreviation": { "type": "string", "description": "This is the state or province (Canadian) abbreviation for the address" }, "address-postal-code": { "type": "string", "description": "This is the postal code for the address" }, "address-country-abbreviation": { "type": "string", "description": "This is the country appreviation for the address" }, "address-location-description": { "type": [ "string", "null" ], "description": "This is an optional location description for the address" }, "ip-address-public": { "type": [ "string", "null" ], "description": "This is the public IP of the client window creating the address." }, "address-formatted-pidflo": { "type": "string", "description": "This is a return value of the formatted PIDFLO standardized value for the address" }, "carrier": { "type": [ "string", "null" ], "description": "This is the carrier name for the address" } }, "required": [ "emergency-address-id", "address-name", "caller-name", "address-line-1", "address-city", "address-state-province-abbreviation", "address-postal-code", "address-country-abbreviation", "address-formatted-pidflo" ] }, "example": { "emergency-address-id": "a-UNIQE_ID", "address-name": "WeWork Office", "caller-id-number": "WeWork Secretary", "address-line-1": "8910 UNIVERSITY CENTER LN", "address-line-2": "STE 400", "address-city": "San Diego", "address-state-province-abbreviation": "CA", "address-postal-code": "92122-1025", "address-country-abbreviation": "US", "address-location-description": "front left desk", "address-provisioned-carrier-name": "bandwidth", "address-formatted-pidflo": { "HouseNumber": 8910, "StreetName": "UNIVERSITY CENTER", "StreetSuffix": "LN", "City": "SAN DIEGO", "StateCode": "CA", "Zip": 92122, "PlusFour": 1012, "County": [], "Country": "US", "AddressType": "E911", "LocationId": "a-UNIQE_ID", "ValidationStatus": "VALID", "Adjusted": "true" }, "ip-address-public": "XXX.XX.XX.XXX" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressCreateReturn" }, "example": { "address-formatted-pidflo": { "HouseNumber": 8910, "StreetName": "UNIVERSITY CENTER", "StreetSuffix": "LN", "City": "SAN DIEGO", "StateCode": "CA", "Zip": 92122, "PlusFour": 1012, "County": [], "Country": "US", "AddressType": "E911", "LocationId": "a-652487faeb24d_3", "ValidationStatus": "VALID", "Adjusted": "true" }, "object": "address", "domain": "portal", "singular": 0, "address_id": "a-652487faeb24e_4", "address_name": "WeWork Office", "callid_nmbr": "WeWork Secretary", "address_line_1": "8910 UNIVERSITY CENTER LN", "address_line_2": "STE 400", "city": "San Diego", "state_code": "CA", "zip": "92122-1025", "country_code": "US", "location": "front left desk", "carrier": "bandwidth", "public_ip": "207.45.79.249", "action": "create", "controller": "addresses", "format": "json", "apiVer": "v2", "user": "*" } } }, "headers": {} }, "409": { "description": "", "content": { "*/*": { "schema": { "type": "object", "properties": {} }, "example": "{\n \"code\": 409,\n \"message\": \"Conflicting address_id\"\n}" } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/addresses/validate": { "post": { "summary": "Validate Address", "deprecated": false, "description": "", "operationId": "ValidateAddress", "tags": [ "Addresses" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "sampleDomain", "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "emergency-address-id": { "type": "string", "description": "A hash for the identifier of the address for both carrier and NS side." }, "address-name": { "type": "string" }, "caller-name": { "type": "string" }, "address-line-1": { "type": "string" }, "address-line-2": { "type": "string" }, "address-country-abbreviation": { "type": "string" }, "address-state-province-abbreviation": { "type": "string" }, "address-city": { "type": "string" }, "address-postal-code": { "type": "string" }, "address-location-description": { "type": "string" } }, "required": [ "address-line-1", "address-country-abbreviation", "address-state-province-abbreviation", "address-city", "address-postal-code", "address-location-description", "address-name", "caller-name" ] }, "example": { "domain": "sampleDomain", "address-name": "We Work Office", "caller-name": "We Work Secretary", "address-line-1": "8910 UNIVERSITY CENTER LN", "address-line-2": "STE 400", "address-country-abbreviation": "US", "address-state-province-abbreviation": "CA", "address-city": "San Diego", "address-postal-code": "92122-1025", "address-location-description": "front left desk" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": { "type": "string" }, "object": { "type": "string" }, "emergency-address-id": { "type": "string" }, "address-formatted-pidflo": { "type": "object", "properties": {}, "description": "Standardized values and fields of the address. May be different depending on carrier" }, "address-name": { "type": "string" }, "caller-name": { "type": "string" }, "address-line-1": { "type": "string" }, "address-line-2": { "type": "string" }, "address-country-abbreviation": { "type": "string" }, "address-state-province-abbreviation": { "type": "string" }, "address-city": { "type": "string" }, "address-postal-code": { "type": "string" }, "carrier": { "type": "string" } }, "required": [ "domain", "object", "emergency-address-id", "address-formatted-pidflo", "address-name", "caller-name", "address-line-1", "address-line-2", "address-country-abbreviation", "address-state-province-abbreviation", "address-city", "address-postal-code", "carrier" ] }, "example": { "domain": "sampleDomain", "object": "address", "singular": 1, "action": "validate", "http_method": "POST", "controller": "addresses", "format": "json", "apiVer": "v2", "address-name": "We Work Office", "caller-id-number": "We Work Secretary", "address-line-1": "8910 UNIVERSITY CENTER LN", "address-line-2": "STE 400", "address-country-abbreviation": "US", "address-state-province-abbreviation": "CA", "address-city": "San Diego", "address-postal-code": "92122-1025", "address-location-description": "front left desk", "emergency-address-id": "a-6525c1ae9d7ff", "address-formatted-pidflo": { "HouseNumber": 8910, "StreetName": "UNIVERSITY CENTER", "StreetSuffix": "LN", "City": "SAN DIEGO", "StateCode": "CA", "Zip": 92122, "PlusFour": 1012, "County": [], "Country": "US", "AddressType": "E911", "LocationId": "a-6525c1ae9d7ff", "ValidationStatus": "VALID", "Adjusted": "true" }, "address-provisioned-carrier-name": "bandwidth" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/addresses/{emergency-address-id}": { "put": { "summary": "Update Address for Domain", "deprecated": false, "description": "", "operationId": "UpdateAddressForDomain", "tags": [ "Addresses" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "sampleDomain", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "emergency-address-id", "in": "path", "description": "", "required": true, "example": "a-UNIQE_ID", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "address-name": { "type": "string", "description": "This is the name label for the address" }, "caller-name": { "type": "string", "description": "This is the caller's name for the address" }, "address-line-1": { "type": "string", "description": "This is the address line 1 for the address" }, "address-line-2": { "type": [ "string", "null" ], "description": "This is the address line 2 for the address" }, "address-city": { "type": "string", "description": "This is the city for the address" }, "address-state-province-abbreviation": { "type": "string", "description": "This is the state or province (Canadian) abbreviation for the address" }, "address-postal-code": { "type": "string", "description": "This is the postal code for the address" }, "address-country-abbreviation": { "type": "string", "description": "This is the country appreviation for the address" }, "address-location-description": { "type": [ "string", "null" ], "description": "This is an optional location description for the address" }, "ip-address-public": { "type": [ "string", "null" ], "description": "This is the public IP of the client window creating the address." }, "address-formatted-pidflo": { "type": "string", "description": "This is a return value of the formatted PIDFLO standardized value for the address" }, "carrier": { "type": [ "string", "null" ], "description": "This is the carrier name for the address" } }, "required": [ "address-name", "caller-name", "address-line-1", "address-city", "address-state-province-abbreviation", "address-postal-code", "address-country-abbreviation", "address-formatted-pidflo" ] }, "example": { "address-name": "WeWork Office", "caller-name": "WeWork Secretary UPDATED", "address-line-1": "8911 UNIVERSITY CENTER LN", "address-line-2": "STE 400", "address-city": "San Diego", "address-state-province-abbreviation": "CA", "address-postal-code": "92122-1025", "address-country-abbreviation": "US", "address-location-description": "front RIGHT desk UPDATED", "address-provisioned-carrier-name": "bandwidth", "address-formatted-pidflo": { "HouseNumber": 8911, "StreetName": "UNIVERSITY CENTER", "StreetSuffix": "LN", "City": "SAN DIEGO", "StateCode": "CA", "Zip": 92122, "PlusFour": 1012, "County": [], "Country": "US", "AddressType": "E911", "LocationId": "a-652487faeb24d_6", "ValidationStatus": "VALID", "Adjusted": "true" }, "ip-address-public": "207.45.79.249" } } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "delete": { "summary": "Delete Address For Domain", "deprecated": false, "description": "", "operationId": "DeleteAddressForDomain", "tags": [ "Addresses" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "sampleDomain", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "emergency-address-id", "in": "path", "description": "", "required": true, "example": "a-UNIQE_ID", "schema": { "type": "string" } } ], "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] }, "example": { "code": 202, "message": "Accepted" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/addresses/{emergency-address-id}": { "put": { "summary": "Update Address for User", "deprecated": false, "description": "", "operationId": "UpdateAddressForUser", "tags": [ "Addresses" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "sampleDomain", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "sampleUser", "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "emergency-address-id", "in": "path", "description": "", "required": true, "example": "a-UNIQE_ID", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "address-name": { "type": "string", "description": "This is the name label for the address" }, "caller-name": { "type": "string", "description": "This is the caller's name for the address" }, "address-line-1": { "type": "string", "description": "This is the address line 1 for the address" }, "address-line-2": { "type": [ "string", "null" ], "description": "This is the address line 2 for the address" }, "address-city": { "type": "string", "description": "This is the city for the address" }, "address-state-province-abbreviation": { "type": "string", "description": "This is the state or province (Canadian) abbreviation for the address" }, "address-postal-code": { "type": "string", "description": "This is the postal code for the address" }, "address-country-abbreviation": { "type": "string", "description": "This is the country appreviation for the address" }, "address-location-description": { "type": [ "string", "null" ], "description": "This is an optional location description for the address" }, "ip-address-public": { "type": [ "string", "null" ], "description": "This is the public IP of the client window creating the address." }, "address-formatted-pidflo": { "type": "string", "description": "This is a return value of the formatted PIDFLO standardized value for the address" }, "carrier": { "type": [ "string", "null" ], "description": "This is the carrier name for the address" } }, "required": [ "address-name", "caller-name", "address-line-1", "address-city", "address-state-province-abbreviation", "address-postal-code", "address-country-abbreviation", "address-formatted-pidflo" ] }, "example": { "address-name": "WeWork Office", "caller-name": "WeWork Secretary", "address-line-1": "8911 UNIVERSITY CENTER LN", "address-line-2": "STE 400 3", "address-city": "San Diego", "address-state-province-abbreviation": "CA", "address-postal-code": "92122-1025", "address-country-abbreviation": "US", "address-location-description": "front left desk 2", "address-provisioned-carrier-name": "bandwidth", "address-formatted-pidflo": { "HouseNumber": 8911, "StreetName": "UNIVERSITY CENTER", "StreetSuffix": "LN", "City": "SAN DIEGO", "StateCode": "CA", "Zip": 92122, "PlusFour": 1012, "County": [], "Country": "US", "AddressType": "E911", "LocationId": "a-652487faeb24d_6", "ValidationStatus": "VALID", "Adjusted": "true" }, "ip-address-public": "207.45.79.249" } } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "get": { "summary": "Get Address Using Address ID", "deprecated": false, "description": "", "operationId": "GetAddressUsingAddressID", "tags": [ "Addresses" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "domainSample", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "userSample", "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "emergency-address-id", "in": "path", "description": "", "required": true, "example": "a-5fc83a12c8e98", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Address" }, "example": { "domain": "sampleDomain", "user": "sampleUser", "emergency-address-id": "a-652487faeb24d_6", "address-name": "WeWork Office", "caller-id-number": "WeWork Secretary", "address-line-1": "8911 UNIVERSITY CENTER LN", "address-line-2": "STE 400", "address-city": "San Diego", "address-state-province-abbreviation": "CA", "address-postal-code": "92122-1025", "address-country-abbreviation": "US", "address-location-description": "front left desk", "ip-address-public": "207.45.79.249", "address-formatted-pidflo": " US8911UNIVERSITY CENTERLNCASAN DIEGOSTE 400 front left desk92122-1012", "address-provisioned-carrier-name": "bandwidth", "address-formatted-pretty": "8911 UNIVERSITY CENTER LN STE 400 front left desk\r\nSan Diego, CA 92122-1025, US" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/addresses/endpoints/{endpoint}": { "put": { "summary": "Update Address Endpoint", "deprecated": false, "description": "", "operationId": "UpdateAddressEndpoint", "tags": [ "Addresses" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "sampleDomain", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "endpoint", "in": "path", "description": "The callback number of the address.", "required": true, "example": "8585551234", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "address-name": { "type": "string", "description": "This is the name label for the address" }, "caller-name": { "type": "string", "description": "This is the caller's name for the address" }, "address-line-1": { "type": "string", "description": "This is the address line 1 for the address" }, "address-line-2": { "type": [ "string", "null" ], "description": "This is the address line 2 for the address" }, "address-city": { "type": "string", "description": "This is the city for the address" }, "address-state-province-abbreviation": { "type": "string", "description": "This is the state or province (Canadian) abbreviation for the address" }, "address-postal-code": { "type": "string", "description": "This is the postal code for the address" }, "address-country-abbreviation": { "type": "string", "description": "This is the country appreviation for the address" }, "address-location-description": { "type": [ "string", "null" ], "description": "This is an optional location description for the address" }, "address-formatted-pidflo": { "type": [ "object", "null" ], "properties": {}, "description": "This is a return value of the formatted PIDFLO standardized value for the address. For create/update either location-id or address-formatted-pidflo is needed. If address-formatted-pidflo is used, fill in address-line-1, address-city, etc for address information" }, "carrier": { "type": [ "string", "null" ], "description": "This is the carrier name for the address" }, "location-id": { "type": [ "string", "null" ], "description": "This is the address-id in cases for creation using an existing address. For create/update either location-id or address-formatted-pidflo is needed" } }, "required": [ "address-name", "caller-name" ] }, "example": null } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] }, "example": { "code": 202, "message": "Accepted" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "delete": { "summary": "Delete Address Endpoint", "deprecated": false, "description": "", "operationId": "DeleteAddressEndpoint", "tags": [ "Addresses" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "sampleDomain", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "endpoint", "in": "path", "description": "The callback number of the address.", "required": true, "example": "8585551236", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "carrier": { "type": "string" } }, "required": [ "carrier" ] }, "example": { "carrier": "bandwidth" } } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] }, "example": { "code": 202, "message": "Accepted" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/addresses": { "post": { "summary": "Create Address for User", "deprecated": false, "description": "", "operationId": "CreateAddressForUser", "tags": [ "Addresses" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "sampleDomain", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "sampleUser", "schema": { "$ref": "#/components/schemas/UserNamePath" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "emergency-address-id": { "type": "string", "description": "This is an autogenerated ID for the Address." }, "address-name": { "type": "string", "description": "This is the name label for the address" }, "caller-name": { "type": "string", "description": "This is the caller's name for the address" }, "address-line-1": { "type": "string", "description": "This is the address line 1 for the address" }, "address-line-2": { "type": [ "string", "null" ], "description": "This is the address line 2 for the address" }, "address-city": { "type": "string", "description": "This is the city for the address" }, "address-state-province-abbreviation": { "type": "string", "description": "This is the state or province (Canadian) abbreviation for the address" }, "address-postal-code": { "type": "string", "description": "This is the postal code for the address" }, "address-country-abbreviation": { "type": "string", "description": "This is the country appreviation for the address" }, "address-location-description": { "type": [ "string", "null" ], "description": "This is an optional location description for the address" }, "ip-address-public": { "type": [ "string", "null" ], "description": "This is the public IP of the client window creating the address." }, "address-formatted-pidflo": { "type": "string", "description": "This is a return value of the formatted PIDFLO standardized value for the address" }, "carrier": { "type": [ "string", "null" ], "description": "This is the carrier name for the address" } }, "required": [ "emergency-address-id", "address-name", "caller-name", "address-line-1", "address-city", "address-state-province-abbreviation", "address-postal-code", "address-country-abbreviation", "address-formatted-pidflo" ] }, "example": { "emergency-address-id": "a-UNIQE_ID", "address-name": "WeWork Office", "caller-id-number": "WeWork Secretary", "address-line-1": "8910 UNIVERSITY CENTER LN", "address-line-2": "STE 400", "address-city": "San Diego", "address-state-province-abbreviation": "CA", "address-postal-code": "92122-1025", "address-country-abbreviation": "US", "address-location-description": "front left desk", "address-provisioned-carrier-name": "bandwidth", "address-formatted-pidflo": { "HouseNumber": 8910, "StreetName": "UNIVERSITY CENTER", "StreetSuffix": "LN", "City": "SAN DIEGO", "StateCode": "CA", "Zip": 92122, "PlusFour": 1012, "County": [], "Country": "US", "AddressType": "E911", "LocationId": "a-UNIQE_ID", "ValidationStatus": "VALID", "Adjusted": "true" }, "ip-address-public": "XXX.XX.XX.XXX" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressCreateReturn" }, "example": { "address-formatted-pidflo": { "HouseNumber": 8910, "StreetName": "UNIVERSITY CENTER", "StreetSuffix": "LN", "City": "SAN DIEGO", "StateCode": "CA", "Zip": 92122, "PlusFour": 1012, "County": [], "Country": "US", "AddressType": "E911", "LocationId": "a-652487faeb24d_9", "ValidationStatus": "VALID", "Adjusted": "true" }, "object": "address", "domain": "portal", "user": "2500", "singular": 0, "address_id": "a-652487faeb24d_12", "address_name": "WeWork Office", "callid_nmbr": "WeWork Secretary", "address_line_1": "8910 UNIVERSITY CENTER LN", "address_line_2": "STE 400", "city": "San Diego", "state_code": "CA", "zip": "92122-1025", "country_code": "US", "location": "front left desk", "carrier": "bandwidth", "public_ip": "207.45.79.249", "action": "create", "controller": "addresses", "format": "json", "apiVer": "v2", "uid": "2500@portal" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "get": { "summary": "Get Addresses for User", "deprecated": false, "description": "", "operationId": "GetAddressesForUser", "tags": [ "Addresses" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "limit", "in": "query", "description": "Records per page. Defaults to 100, maximum 100. Higher values, or more than one `limit` parameter, are rejected with 400. Page through results with `start`.", "required": false, "schema": { "$ref": "#/components/schemas/Limit", "type": "integer", "minimum": 1, "maximum": 100, "default": 100 }, "example": 100 }, { "name": "show_all_personal", "in": "query", "description": "Set to \"yes\" and do not set user in order to show all addresses in domain regardless of user identity. Requires Office Manager or above", "required": false, "example": "", "schema": { "type": "string" } }, { "name": "show_only_personal", "in": "query", "description": "Set to \"yes\" to show only the personal addresses. Default to \"no\" which would also showing all the domain-level addreses", "required": false, "example": "yes/no", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Address" } } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/addresses/{address_id}": { "delete": { "summary": "Delete Address For User", "deprecated": false, "description": "", "operationId": "DeleteAddressForUser", "tags": [ "Addresses" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "sampleDomain", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "sampleUser", "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "address_id", "in": "path", "description": "Address ID to delete", "required": true, "example": "a-UNIQ_ID", "schema": { "type": "string" } } ], "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] }, "example": { "code": 202, "message": "Accepted" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/addresses/endpoints": { "post": { "summary": "Create Address Endpoint", "deprecated": false, "description": "", "operationId": "CreateAddressEndpoint", "tags": [ "Addresses" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "", "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "address-callback-number": { "anyOf": [ { "type": "string" }, { "type": "integer" } ], "description": "This will match the callback number" }, "address-name": { "type": "string", "description": "This is the name label for the address" }, "caller-name": { "type": "string", "description": "This is the caller's name for the address" }, "address-line-1": { "type": "string", "description": "This is the address line 1 for the address" }, "address-line-2": { "type": [ "string", "null" ], "description": "This is the address line 2 for the address" }, "address-city": { "type": "string", "description": "This is the city for the address" }, "address-state-province-abbreviation": { "type": "string", "description": "This is the state or province (Canadian) abbreviation for the address" }, "address-postal-code": { "type": "string", "description": "This is the postal code for the address" }, "address-country-abbreviation": { "type": "string", "description": "This is the country appreviation for the address" }, "address-location-description": { "type": [ "string", "null" ], "description": "This is an optional location description for the address" }, "address-formatted-pidflo": { "type": [ "object", "null" ], "properties": {}, "description": "This is a return value of the formatted PIDFLO standardized value for the address. For create/update either location-id or address-formatted-pidflo is needed. If address-formatted-pidflo is used, fill in address-line-1, address-city, etc for address information" }, "carrier": { "type": [ "string", "null" ], "description": "This is the carrier name for the address" }, "location-id": { "type": [ "string", "null" ], "description": "This is the address-id in cases for creation using an existing address. For create/update either location-id or address-formatted-pidflo is needed" } }, "required": [ "address-name", "caller-name" ] }, "example": { "address-callback-number": "8585551234", "address-name": "WeWork Office", "caller-name": "WeWork Secretary", "address-line-1": "8910 UNIVERSITY CENTER LN", "address-line-2": "STE 400", "address-city": "San Diego", "address-state-province-abbreviation": "CA", "address-postal-code": "92122-1025", "address-country-abbreviation": "US", "address-location-description": "front left desk", "address-provisioned-carrier-name": "bandwidth", "address-formatted-pidflo": { "HouseNumber": 8910, "StreetName": "UNIVERSITY CENTER", "StreetSuffix": "LN", "City": "SAN DIEGO", "StateCode": "CA", "Zip": 92122, "PlusFour": 1012, "County": [], "Country": "US", "AddressType": "E911", "LocationId": "LOCATION ID", "ValidationStatus": "VALID", "Adjusted": "true" } } } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] }, "example": { "code": 202, "message": "Accepted" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "get": { "summary": "Get Address Endpoints for a Domain", "deprecated": false, "description": "Emergency Address Endpoints are different than Emergency Addresses. Endpoints contain the Emergency Caller ID Number and the address associated with it should be the billing address. Emergency Addresses are what is passed in to the PIDFLO object. ", "operationId": "GetAddressEndpointsForDomain", "tags": [ "Addresses" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "limit", "in": "query", "description": "Records per page. Defaults to 100, maximum 100. Higher values, or more than one `limit` parameter, are rejected with 400. Page through results with `start`.", "required": false, "schema": { "$ref": "#/components/schemas/Limit", "type": "integer", "minimum": 1, "maximum": 100, "default": 100 }, "example": 100 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Address" } }, "example": "[\n {\n \"domain\": \"sampleDomain\",\n \"user\": \"address_endpoint\",\n \"sub_count_total\": 157,\n \"multiple\": false,\n \"emergency-address-id\": 201422XXXX,\n \"address-name\": \"La Jolla Office HQ\",\n \"caller-id-number\": \"Example HQ\",\n \"address-line-1\": \"1200 PROSPECT St\",\n \"address-line-2\": \"\",\n \"address-city\": \"LA JOLLA\",\n \"address-state-province-abbreviation\": \"CA\",\n \"address-postal-code\": \"92037\",\n \"address-country-abbreviation\": \"US\",\n \"address-location-description\": \"\",\n \"ip-address-public\": \"\",\n \"address-formatted-pidflo\": \"\",\n \"address-provisioned-carrier-name\": \"inteliquent\",\n \"count-users-configured\": 15,\n \"address-formatted-pretty\": \"1200 PROSPECT St\\r\\n \\r\\nLA JOLLA, CA 92037, US\"\n }\n]" } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/addresses/count": { "get": { "summary": "Get Addresses Count for Domain", "deprecated": false, "description": "", "operationId": "GetAddressesCountForDomain", "tags": [ "Addresses" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Count" }, "example": { "total": 1 } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 403, "message": "Domain not found or access denied" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/vmailnag": { "get": { "summary": "Get Voicemail Reminders for Specific User", "deprecated": false, "description": "", "tags": [ "Voicemail Reminders" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vmailnag" }, "example": [ { "uid": "1000@example", "domain": "example", "user": "1000", "last_sent": "", "expire_timestamp": 0, "geo_server": "", "phone-reminder-enabled": "no", "phone-reminder-numbers": [ 1234567890, 8901234567 ], "sms-reminder-enabled": "no", "sms-reminder-numbers": [ 1234567890 ], "email-reminder-enabled": "no", "email-reminder-addresses": [ "abc@def.ghi", "test@email.com" ], "reminder-interval-minutes": 5 } ] } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "delete": { "summary": "Delete Voicemail Reminders for Specific User", "deprecated": false, "description": "", "tags": [ "Voicemail Reminders" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } } ], "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] }, "example": { "code": 202, "message": "Accepted" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "post": { "summary": "Create Voicemail Reminder", "deprecated": false, "description": "", "tags": [ "Voicemail Reminders" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/UserNamePath" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "voicemail-reminder-phonecall-enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "voicemail-reminder-phonecall-phonenumber-array": { "type": "array", "items": { "type": "integer", "examples": [ 8585551234, 6195551234 ] }, "description": "Phone reminder numbers" }, "voicemail-reminder-sms-enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "voicemail-reminder-sms-phonenumber-array": { "type": "array", "items": { "type": "integer", "examples": [ 8585551234, 6195551234 ] }, "description": "SMS reminder numbers" }, "voicemail-reminder-email-enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "voicemail-reminder-email-address-array": { "type": "array", "items": { "type": "string", "examples": [ "test@email.com", "abc@def.ghi" ] }, "description": "Email reminder addresses" }, "voicemail-reminder-interval-minutes": { "type": "integer", "description": "Interval of reminders (minutes)" }, "voicemail-reminder-last-sent": { "type": "integer", "description": "Timestamp of last sent reminder", "readOnly": true }, "voicemail-reminder-control-server": { "type": "string", "description": "Current server managing the reminders for the user", "readOnly": true } } } } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "put": { "summary": "Update Voicemail Reminders for Specific User", "deprecated": false, "description": "", "tags": [ "Voicemail Reminders" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/UserNamePath" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "voicemail-reminder-phonecall-enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "voicemail-reminder-phonecall-phonenumber-array": { "type": "array", "items": { "type": "integer", "examples": [ 8585551234, 6195551234 ] }, "description": "Phone reminder numbers" }, "voicemail-reminder-sms-enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "voicemail-reminder-sms-phonenumber-array": { "type": "array", "items": { "type": "integer", "examples": [ 8585551234, 6195551234 ] }, "description": "SMS reminder numbers" }, "voicemail-reminder-email-enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "voicemail-reminder-email-address-array": { "type": "array", "items": { "type": "string", "examples": [ "test@email.com", "abc@def.ghi" ] }, "description": "Email reminder addresses" }, "voicemail-reminder-interval-minutes": { "type": "integer", "description": "Interval of reminders (minutes)" }, "voicemail-reminder-last-sent": { "type": "integer", "description": "Timestamp of last sent reminder", "readOnly": true }, "voicemail-reminder-control-server": { "type": "string", "description": "Current server managing the reminders for the user", "readOnly": true } } } } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/vmailnag/count": { "get": { "summary": "Count Voicemail Reminders for Specific User", "deprecated": false, "description": "", "tags": [ "Voicemail Reminders" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Count" }, "example": { "total": 1 } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 403, "message": "Domain not found or access denied" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/dialplans/{dialplan}/dialrules": { "get": { "summary": "Read Dialrules in a Dialplan", "deprecated": false, "description": "", "operationId": "ReadDialrules", "tags": [ "Dialrule" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "dialplan", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DialRule" } } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "post": { "summary": "Add a new dial rule into a dial plan", "deprecated": false, "description": "", "operationId": "CreateDialrule", "tags": [ "Dialrule" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "dialplan", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "synchronous": { "$ref": "#/components/schemas/Synchronous" }, "dial-rule-matching-to-uri": { "type": "string", "description": "This is the main digit string match for the dial translation. ", "examples": [ "sip:611@*", "sip:1??????????@*" ] }, "enabled": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "dial-rule-matching-from-uri": { "type": "string", "description": "This is a source match that would allow for a specific dial rule match based on the caller as well as the forward destination of dial-rule-matching-to-uri. ", "default": "*", "examples": [ "sip:????@*", "*" ] }, "dial-rule-matching-day-of-week": { "type": "string", "default": "*", "examples": [ "[1-5]", "1" ], "description": "This is a field that will control the DOW (day of week) match for this rule. Default is * or to match all the time, but valid format will allow any single day of the week 0-6 (sunday-saturday) or a range in square brackets like [0-6]" }, "dial-rule-matching-start-date": { "type": "string", "format": "date", "default": "*", "examples": [ "2023-09-15", "*" ], "description": "This is the start of a the valid date range for this rule. Keep to * if you do not want to use date range for this rule. " }, "dial-rule-matching-end-date": { "type": "string", "format": "date", "examples": [ "2023-09-16", "*" ], "default": "*", "description": "This is the end of a the valid date range for this rule. Keep to * if you do not want to use date range for this rule. " }, "dial-rule-matching-start-time": { "type": "string", "default": "*", "examples": [ "02:00", "*" ], "description": "This is the start of a the valid time range for this rule. Keep to * if you do not want to use time range for this rule. The format is a valid HH:MM format from 00:00 to 23:59. The timezone would be the user's timezone if passing through a user already. " }, "dial-rule-matching-end-time": { "type": "string", "examples": [ "23:59", "*" ], "default": "*", "description": "This is the end of a the valid time range for this rule. Keep to * if you do not want to use time range for this rule. The format is a valid HH:MM format from 00:00 to 23:59. The timezone would be the user's timezone if passing through a user already. " }, "dial-rule-application": { "$ref": "#/components/schemas/DialruleApplication" }, "dial-rule-parameter": { "type": "string", "description": "This is the application parameter field that can be used for additional settings based on the dial-rule-application. Default is empty string. " }, "dial-rule-translation-destination-scheme": { "type": "string", "description": "This setting controls the \"sip schema\" on the destination, in most all case setting to \"[*]\" is correct. ", "enum": [ "[*]", "sip:", "" ], "default": "[*]" }, "dial-rule-translation-destination-user": { "type": "string", "description": "This is the forward destination the call will be sent to in partnership with the application (dial-rule-application) and host (dial-rule-translation-destination-host). This might be a user, queue or offnet number depending on the application. ", "examples": [ "1000", "2500", "18005551234" ] }, "dial-rule-translation-destination-host": { "type": "string", "description": "This is the forward destination host the call will be sent to in partnership with the application (dial-rule-application) and user (dial-rule-translation-destination-user). This might be the domain name or a connection name if trying to route offnet. ", "default": "[*]", "examples": [ "example.com", "" ] }, "dial-rule-translation-source-name": { "type": "string", "description": "This field will allow customization of the source \"name\" often used for the caller id name or the the descriptive quoted value outside of the sip uri. Defaults to [*] but you can add a prefix for example with something like this, sales_[*]", "default": "[*]", "examples": [ "sales_[*]", "[*]", "" ] }, "dial-rule-translation-source-scheme": { "type": "string", "description": "This setting controls the \"sip schema\" on the destination, in most all case setting to \"[*]\" is correct. ", "enum": [ "[*]", "sip:", "" ], "default": "[*]" }, "dial-rule-translation-source-user": { "type": "string", "description": "This field will allow customization of the source \"user\" which is often the caller id number or the value before the @ in then SIP uri. Defaults to [*] but you can modify and include [*] as the previous value. An example would be using a token like to replace with a user's caller id number. ", "default": "[*]", "examples": [ "", "[*]" ] }, "dial-rule-translation-source-host": { "type": "string", "description": "This field will allow customization of the source \"host\" which is the value after the @ in then SIP uri. Defaults to [*] but you can modify and include [*] as the previous value. An example would be using a token like to replace with a user's domain", "default": "[*]", "examples": [ "", "[*]" ] }, "dial-rule-description": { "type": "string", "description": "This is a description of the number/rule that can be used for defintion or tracking purposes. " } }, "required": [ "synchronous", "dial-rule-matching-to-uri", "dial-rule-translation-destination-user" ] }, "example": { "synchronous": "yes", "dial-rule-matching-to-uri": "sip:611@*", "dial-rule-matching-from-uri": "*", "enabled": "yes", "dial-rule-translation-source-name": "611 - [*]", "dial-rule-translation-source-user": "[*]", "dial-rule-translation-source-host": "[*]", "dial-rule-application": "to-callqueue", "dial-rule-translation-destination-user": "{{queue}}", "dial-rule-translation-destination-host": "{{domain}}", "dial-rule-description": "611 - Customer Service Direct Dial" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DialRule" } } }, "headers": {} }, "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/dialplans/{dialplan}/dialrules/count": { "get": { "summary": "Count Dialrules in a Dialplan", "deprecated": false, "description": "", "tags": [ "Dialrule" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "dialplan", "in": "path", "description": "", "required": true, "example": "{{dialplan}}", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Count" }, "example": { "total": 16 } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 403, "message": "Domain not found or access denied" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/dialplans/{dialplan}/dialrules/{dialrule}": { "get": { "summary": "Read Specific Dialrule in a Dialplan", "deprecated": false, "description": "", "operationId": "ReadDialrule", "tags": [ "Dialrule" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "dialplan", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "type": "string" } }, { "name": "dialrule", "in": "path", "description": "", "required": true, "example": "c2lwOjYxMUAq", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DialRule" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "put": { "summary": "Update a dial rule by ID in a dial plan", "deprecated": false, "description": "Note you cannot update any fields starting with dial-rule-matching (like dial-rule-matching-to-uri and dial-rule-matching-from-uri) , any modification there should be a delete and create new. ", "operationId": "UpdateDialrule", "tags": [ "Dialrule" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "dialplan", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "type": "string" } }, { "name": "dialrule", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "dialrule": { "type": "string", "description": "This is the dialrule id that will be given with each read action that will be needed to read back individual value, update specific rules or delete rules. If wanting to programatically generate the dial rule id is a base64 encoding of the concatination with \"||\" of the following fields in order, dail-rule-matching-to-uri, dail-rule-matching-from-uri, dail-rule-matching-day-of-week, dail-rule-matching-start-date, dail-rule-matching-end-date, dail-rule-matching-start-time, dail-rule-matching-end-time" }, "enabled": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "dial-rule-application": { "$ref": "#/components/schemas/DialruleApplication" }, "dial-rule-parameter": { "type": "string", "description": "This is the application parameter field that can be used for additional settings based on the dial-rule-application. Default is empty string. " }, "dial-rule-translation-destination-scheme": { "type": "string", "description": "This setting controls the \"sip schema\" on the destination, in most all case setting to \"[*]\" is correct. ", "enum": [ "[*]", "sip:", "" ], "default": "[*]" }, "dial-rule-translation-destination-user": { "type": "string", "description": "This is the forward destination the call will be sent to in partnership with the application (dial-rule-application) and host (dial-rule-translation-destination-host). This might be a user, queue or offnet number depending on the application. ", "examples": [ "1000", "2500", "18005551234" ] }, "dial-rule-translation-destination-host": { "type": "string", "description": "This is the forward destination host the call will be sent to in partnership with the application (dial-rule-application) and user (dial-rule-translation-destination-user). This might be the domain name or a connection name if trying to route offnet. ", "default": "[*]", "examples": [ "example.com", "" ] }, "dial-rule-translation-source-name": { "type": "string", "description": "This field will allow customization of the source \"name\" often used for the caller id name or the the descriptive quoted value outside of the sip uri. Defaults to [*] but you can add a prefix for example with something like this, sales_[*]", "default": "[*]", "examples": [ "sales_[*]", "[*]", "" ] }, "dial-rule-translation-source-scheme": { "type": "string", "description": "This setting controls the \"sip schema\" on the destination, in most all case setting to \"[*]\" is correct. ", "enum": [ "[*]", "sip:", "" ], "default": "[*]" }, "dial-rule-translation-source-user": { "type": "string", "description": "This field will allow customization of the source \"user\" which is often the caller id number or the value before the @ in then SIP uri. Defaults to [*] but you can modify and include [*] as the previous value. An example would be using a token like to replace with a user's caller id number. ", "default": "[*]", "examples": [ "", "[*]" ] }, "dial-rule-translation-source-host": { "type": "string", "description": "This field will allow customization of the source \"host\" which is the value after the @ in then SIP uri. Defaults to [*] but you can modify and include [*] as the previous value. An example would be using a token like to replace with a user's domain", "default": "[*]", "examples": [ "", "[*]" ] }, "dial-rule-description": { "type": "string", "description": "This is a description of the number/rule that can be used for defintion or tracking purposes. " } }, "required": [ "dialrule", "dial-rule-translation-destination-user" ] }, "example": { "enable": "yes", "from_name": "611 - [*]", "from_user": "[*]", "from_host": "", "plan_description": "611 - (updated)" } } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "delete": { "summary": "Delete a dial rule by ID in a dial plan", "deprecated": false, "description": "", "operationId": "DeleteDialrule", "tags": [ "Dialrule" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "dialplan", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "type": "string" } }, { "name": "dialrule", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/dialplans": { "get": { "summary": "Read Dialplans", "deprecated": false, "description": "", "tags": [ "Dialrule" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Dialplan" } } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "post": { "summary": "Create Dialplan Global", "deprecated": false, "description": "", "tags": [ "Dialrule" ], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": { "type": "string" }, "dial-rule-dial-plan": { "type": "string" }, "dial-rule-description": { "type": "string" } }, "required": [ "domain", "dial-rule-dial-plan", "dial-rule-description" ] }, "examples": {} } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/dialplans": { "post": { "summary": "Create Dialplan for Domain", "deprecated": false, "description": "", "tags": [ "Dialrule" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "dial-rule-dial-plan": { "type": "string" }, "dial-rule-description": { "type": "string" } }, "required": [ "dial-rule-dial-plan", "dial-rule-description" ] }, "examples": {} } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/dialplans/{dialplan}": { "put": { "summary": "Update Dialplan for Domain", "deprecated": false, "description": "", "tags": [ "Dialrule" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "dialplan", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "dial-rule-description": { "type": "string" } }, "required": [ "dial-rule-description" ] }, "examples": {} } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "delete": { "summary": "Delete Dialplan for Domain", "deprecated": false, "description": "", "tags": [ "Dialrule" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "dialplan", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/dialpolicy": { "get": { "summary": "Read Policies", "deprecated": false, "description": "", "tags": [ "Dial Permisions" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Dialpolicy" } } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "post": { "summary": "Create Dialpolicy Table", "deprecated": false, "description": "", "tags": [ "Dial Permisions" ], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "synchronous": { "$ref": "#/components/schemas/Synchronous" }, "dialpolicy": { "type": "string", "description": "The Name of the DialPolicy" }, "domain": { "type": "string", "description": "The domain that owns the DialPolicy" }, "description": { "type": "string", "description": "The description of the Policy Table" } }, "required": [ "dialpolicy", "domain", "description" ] }, "examples": {} } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Dialpolicy" } } }, "headers": {} }, "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/dialpolicy/{policy}": { "get": { "summary": "Read Specific Policy", "deprecated": false, "description": "", "tags": [ "Dial Permisions" ], "parameters": [ { "name": "policy", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Dialpolicy" } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "put": { "summary": "Update Dialpolicy ", "deprecated": false, "description": "", "tags": [ "Dial Permisions" ], "parameters": [ { "name": "policy", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Dialpolicy" }, "examples": {} } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "delete": { "summary": "Delete Dialpolicy ", "deprecated": false, "description": "", "tags": [ "Dial Permisions" ], "parameters": [ { "name": "policy", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/dialpolicy/{policy}": { "get": { "summary": "Read Specific Policy in Domain", "deprecated": false, "description": "", "tags": [ "Dial Permisions" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "policy", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Dialpolicy" } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "put": { "summary": "Update Dialpolicy in Domain", "deprecated": false, "description": "", "tags": [ "Dial Permisions" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "policy", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Dialpolicy" }, "examples": {} } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "delete": { "summary": "Delete Dialpolicy in Domain", "deprecated": false, "description": "", "tags": [ "Dial Permisions" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "policy", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/dialpolicy/{policy}/permission": { "get": { "summary": "Read Permissions in a DialPolicy", "deprecated": false, "description": "", "tags": [ "Dial Permisions" ], "parameters": [ { "name": "policy", "in": "path", "description": "", "required": true, "example": "US and Canada", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Permission" } } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "post": { "summary": "Add a new permission to a dialpolicy table", "deprecated": false, "description": "", "operationId": "CreatePermission", "tags": [ "Dial Permisions" ], "parameters": [ { "name": "policy", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "synchronous": { "$ref": "#/components/schemas/Synchronous" }, "permission-match": { "type": "string", "description": "The specific match to check against" }, "permission-mode": { "type": "string", "enum": [ "permit", "deny" ], "description": "To allow or deny specific match" }, "permission-reason": { "type": "string", "description": "The description/reason for making the rule. " } }, "required": [ "synchronous", "permission-match", "permission-mode", "permission-reason" ] }, "examples": {} } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Permission" } } }, "headers": {} }, "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/dialpolicy/{policy}/permission": { "get": { "summary": "Read Permissions in a DialPolicy in Domain", "deprecated": false, "description": "", "tags": [ "Dial Permisions" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "policy", "in": "path", "description": "", "required": true, "example": "US and Canada", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Permission" } } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "post": { "summary": "Add a new permission to a dialpolicy table in Domain", "deprecated": false, "description": "", "operationId": "CreatePermissionDomain", "tags": [ "Dial Permisions" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "policy", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "synchronous": { "$ref": "#/components/schemas/Synchronous" }, "permission-match": { "type": "string", "description": "The specific match to check against" }, "permission-mode": { "type": "string", "enum": [ "permit", "deny" ], "description": "To allow or deny specific match" }, "permission-reason": { "type": "string", "description": "The description/reason for making the rule. " } }, "required": [ "synchronous", "permission-match", "permission-mode", "permission-reason" ] }, "examples": {} } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Permission" } } }, "headers": {} }, "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/dialpolicy/{policy}/permission/{id}": { "get": { "summary": "Read Specific Permission in a Dialpolicy", "deprecated": false, "description": "", "operationId": "ReadPermission", "tags": [ "Dial Permisions" ], "parameters": [ { "name": "policy", "in": "path", "description": "", "required": true, "example": "testtest6", "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Permission" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "put": { "summary": "Update a permission in a dialpolicy table", "deprecated": false, "description": "", "operationId": "UpdatePermission", "tags": [ "Dial Permisions" ], "parameters": [ { "name": "policy", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "permission-mode": { "type": "string", "enum": [ "permit", "deny" ], "description": "To allow or deny specific match" }, "permission-reason": { "type": "string", "description": "The description/reason for making the rule. " } }, "required": [ "permission-mode", "permission-reason" ] }, "examples": {} } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "delete": { "summary": "Delete a permission by ID in a dialpolicy", "deprecated": false, "description": "", "operationId": "DeletePermission", "tags": [ "Dial Permisions" ], "parameters": [ { "name": "policy", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/dialpolicy/{policy}/permission/{id}": { "get": { "summary": "Read Specific Permission in a Dialpolicy in Domain", "deprecated": false, "description": "", "operationId": "ReadPermissionDomain", "tags": [ "Dial Permisions" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "policy", "in": "path", "description": "", "required": true, "example": "testtest6", "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Permission" } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "put": { "summary": "Update a permission in a dialpolicy table in Domain", "deprecated": false, "description": "", "operationId": "UpdatePermissionDomain", "tags": [ "Dial Permisions" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "policy", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "permission-mode": { "type": "string", "enum": [ "permit", "deny" ], "description": "To allow or deny specific match" }, "permission-reason": { "type": "string", "description": "The description/reason for making the rule. " } }, "required": [ "permission-mode", "permission-reason" ] }, "examples": {} } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "delete": { "summary": "Delete a permission by ID in a dialpolicy in Domain", "deprecated": false, "description": "", "operationId": "DeletePermissionDomain", "tags": [ "Dial Permisions" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "policy", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/smsblocks": { "get": { "summary": "Read SMS Blocks for Domain", "deprecated": false, "description": "", "tags": [ "Messages/SMS Block" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "", "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SmsBlock" } } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "post": { "summary": "Add SMS Blocks for Domain", "deprecated": false, "description": "", "tags": [ "Messages/SMS Block" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "", "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "requesting-number": { "type": "string", "description": "This is the number that is requesting the block be added against the blocked-number. ", "format": "e164", "examples": [ "+18585551234" ] }, "blocked-number": { "type": "string", "format": "e164", "examples": [ "+18585551234" ], "description": "This is the number that will be blocked from sending new SMS to the requesting-number" }, "status": { "type": "string", "description": "active/inactive", "enum": [ "active", "inactive" ], "default": "active" } }, "required": [ "requesting-number", "blocked-number" ] }, "examples": {} } }, "required": true }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/smsblocks": { "get": { "summary": "Read SMS Blocks for all Domains", "deprecated": false, "description": "", "tags": [ "Messages/SMS Block" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SmsBlock" } } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/smsblocks/{id}": { "put": { "summary": "Update SMS Block for Domain", "deprecated": false, "description": "", "tags": [ "Messages/SMS Block" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "description": "active/inactive", "enum": [ "active", "inactive" ], "default": "active" }, "created-datetime": { "type": "string", "format": "date-time" }, "last-modified-datetime": { "type": "string", "format": "date-time" } } }, "example": null } }, "required": true }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "delete": { "summary": "Delete/Deactivate SMS Block for Domain", "deprecated": false, "description": "NOTE: This will not remove the row from the database, it will just made the status inactive and prevent the block from denying requests. ", "tags": [ "Messages/SMS Block" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/messagesessions": { "get": { "summary": "Get Messagesessions for Domain", "deprecated": false, "description": "", "operationId": "GetMessageSessionsForDomain", "tags": [ "Messages" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "limit", "in": "query", "description": "Records per page. Defaults to 100, maximum 100. Higher values, or more than one `limit` parameter, are rejected with 400. Page through results with `start`.", "required": false, "schema": { "$ref": "#/components/schemas/Limit", "type": "integer", "minimum": 1, "maximum": 100, "default": 100 }, "example": 100 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Messagesession" } }, "example": [ { "user": "2500", "domain": "portal", "messagesession-id": "173ff396f3580f30dfef32be9838e836", "messagesession-remote": 17145550353, "messagesession-sms-number": 18585550626, "messagesession-last-timestamp": "2023-10-05 17:35:15", "messagesession-start-timestamp": "2023-06-12 20:48:43", "messagesession-last-message": "hi from eng0 wp", "messagesession-last-sender": "2500@portal", "messagesession-last-status": "read", "messagesession-muted": "no", "messagesession-last-email-reminder-timestamp": "2023-06-13 18:53:16", "messagesession-reciever-hostname": "eng0-san.example.com", "messagesession-queue-termination": null, "messagesession-queue-status": null, "messagesession-queue-session-id": null, "messagesession-agent-start-timestamp": null, "messagesession-last-type": "sms", "messagesession-last-media-type": "image/png", "messagesession-last-media-size": 5596, "messagesession-type": "", "messagesession-name": "", "messagesession-participants": "" }, { "user": "2500", "domain": "portal", "messagesession-id": "c3529b7ce79a86018d006462fa70fcea", "messagesession-remote": "1123@portal,1004@portal", "messagesession-sms-number": "", "messagesession-last-timestamp": "2023-10-10 18:24:40", "messagesession-start-timestamp": null, "messagesession-last-message": 941173465, "messagesession-last-sender": "1004@portal", "messagesession-last-status": "read", "messagesession-muted": "no", "messagesession-last-email-reminder-timestamp": "2023-10-09 21:09:57", "messagesession-reciever-hostname": "eng2-phx.example.com", "messagesession-queue-termination": null, "messagesession-queue-status": null, "messagesession-queue-session-id": null, "messagesession-agent-start-timestamp": null, "messagesession-last-type": "chat-vid", "messagesession-last-media-type": "", "messagesession-last-media-size": 0, "messagesession-type": "group-chat", "messagesession-name": "", "messagesession-participants": "1123@portal,2500@portal,1004@portal" }, { "user": "2500", "domain": "portal", "messagesession-id": "b0569814b84556c7ebca00be47d7f534", "messagesession-remote": "1123@portal", "messagesession-sms-number": "", "messagesession-last-timestamp": "2023-10-04 18:32:27", "messagesession-start-timestamp": null, "messagesession-last-message": "hi peter", "messagesession-last-sender": "2500@portal", "messagesession-last-status": "read", "messagesession-muted": "no", "messagesession-last-email-reminder-timestamp": null, "messagesession-reciever-hostname": "eng2-phx.example.com", "messagesession-queue-termination": null, "messagesession-queue-status": null, "messagesession-queue-session-id": null, "messagesession-agent-start-timestamp": null, "messagesession-last-type": "chat", "messagesession-last-media-type": "", "messagesession-last-media-size": 0, "messagesession-type": "", "messagesession-name": "", "messagesession-participants": null } ] } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/messages": { "post": { "summary": "Start a new Message Session", "deprecated": false, "description": "This is a good place to start with messaging if you do not already have a message session ID. ", "operationId": "startSession", "tags": [ "Messages" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "", "schema": { "$ref": "#/components/schemas/UserNamePath" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/MessageType" }, "message": { "type": "string", "description": "This is the text that will be sent as the message" }, "destination": { "anyOf": [ { "type": "string", "description": "A single domain user or phonenumber", "examples": [ "1123", "18585551234" ] }, { "type": "array", "items": { "type": "string" }, "description": "An array of domain users or phonenumbers in string format" } ], "description": "This is a single user or phonenumber for chat and SMS respectively. If sending to multiple recipients, then should be an array of users or phonenumbers" }, "from-number": { "type": "string", "description": "This is used only for SMS. This is the user's number used to send outbound for SMS" }, "data": { "type": [ "string", "null" ], "description": "This is used only for media chat or MMS. This is the base64 data of the media file to be sent" }, "mime-type": { "description": "This is used only for media chat or MMS. This is the mime type of the media file to be sent", "anyOf": [ { "$ref": "#/components/schemas/MimeTypes" }, { "type": "null" } ] }, "size": { "type": [ "integer", "null" ], "description": "This is used only for media chat or MMS. This is the size in bytes of the media file being sent" } }, "required": [ "type", "message", "destination" ] }, "example": { "type": "chat", "message": "Hello there!", "destination": "0010" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" }, "example": { "code": 202, "message": "Accepted" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/messagesessions": { "get": { "summary": "Get Messagesessions for User", "deprecated": false, "description": "", "operationId": "GetMessageSessionsForUser", "tags": [ "Messages" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "sampleDomain", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "sampleUser", "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "limit", "in": "query", "description": "Records per page. Defaults to 100, maximum 100. Higher values, or more than one `limit` parameter, are rejected with 400. Page through results with `start`.", "required": false, "schema": { "$ref": "#/components/schemas/Limit", "type": "integer", "minimum": 1, "maximum": 100, "default": 100 }, "example": 100 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Messagesession" } }, "example": [ { "user": "2500", "domain": "portal", "messagesession-id": "173ff396f3580f30dfef32be9838e836", "messagesession-remote": 17145550353, "messagesession-sms-number": 18585550626, "messagesession-last-timestamp": "2023-10-05 17:35:15", "messagesession-start-timestamp": "2023-06-12 20:48:43", "messagesession-last-message": "hi from eng0 wp", "messagesession-last-sender": "2500@portal", "messagesession-last-status": "read", "messagesession-muted": "no", "messagesession-last-email-reminder-timestamp": "2023-06-13 18:53:16", "messagesession-reciever-hostname": "eng0-san.example.com", "messagesession-queue-termination": null, "messagesession-queue-status": null, "messagesession-queue-session-id": null, "messagesession-agent-start-timestamp": null, "messagesession-last-type": "sms", "messagesession-last-media-type": "image/png", "messagesession-last-media-size": 5596, "messagesession-type": "", "messagesession-name": "", "messagesession-participants": "" }, { "user": "2500", "domain": "portal", "messagesession-id": "c3529b7ce79a86018d006462fa70fcea", "messagesession-remote": "1123@portal,1004@portal", "messagesession-sms-number": "", "messagesession-last-timestamp": "2023-10-10 18:24:40", "messagesession-start-timestamp": null, "messagesession-last-message": 941173465, "messagesession-last-sender": "1004@portal", "messagesession-last-status": "read", "messagesession-muted": "no", "messagesession-last-email-reminder-timestamp": "2023-10-09 21:09:57", "messagesession-reciever-hostname": "eng2-phx.example.com", "messagesession-queue-termination": null, "messagesession-queue-status": null, "messagesession-queue-session-id": null, "messagesession-agent-start-timestamp": null, "messagesession-last-type": "chat-vid", "messagesession-last-media-type": "", "messagesession-last-media-size": 0, "messagesession-type": "group-chat", "messagesession-name": "", "messagesession-participants": "1123@portal,2500@portal,1004@portal" }, { "user": "2500", "domain": "portal", "messagesession-id": "b0569814b84556c7ebca00be47d7f534", "messagesession-remote": "1123@portal", "messagesession-sms-number": "", "messagesession-last-timestamp": "2023-10-04 18:32:27", "messagesession-start-timestamp": null, "messagesession-last-message": "hi peter", "messagesession-last-sender": "2500@portal", "messagesession-last-status": "read", "messagesession-muted": "no", "messagesession-last-email-reminder-timestamp": null, "messagesession-reciever-hostname": "eng2-phx.example.com", "messagesession-queue-termination": null, "messagesession-queue-status": null, "messagesession-queue-session-id": null, "messagesession-agent-start-timestamp": null, "messagesession-last-type": "chat", "messagesession-last-media-type": "", "messagesession-last-media-size": 0, "messagesession-type": "", "messagesession-name": "", "messagesession-participants": null } ] } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/messagesessions/{messagesession}": { "get": { "summary": "Get Messagesession for User", "deprecated": false, "description": "", "operationId": "GetMessageSessionForUser", "tags": [ "Messages", "44.3" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "sampleDomain", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "sampleUser", "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "messagesession", "in": "path", "description": "", "required": true, "example": "sampleSessionId", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Messagesession" } }, "example": [ { "user": "2500", "domain": "portal", "messagesession-id": "173ff396f3580f30dfef32be9838e836", "messagesession-remote": 17145550353, "messagesession-sms-number": 18585550626, "messagesession-last-timestamp": "2023-10-05 17:35:15", "messagesession-start-timestamp": "2023-06-12 20:48:43", "messagesession-last-message": "hi from eng0 wp", "messagesession-last-sender": "2500@portal", "messagesession-last-status": "read", "messagesession-muted": "no", "messagesession-last-email-reminder-timestamp": "2023-06-13 18:53:16", "messagesession-reciever-hostname": "eng0-san.example.com", "messagesession-queue-termination": null, "messagesession-queue-status": null, "messagesession-queue-session-id": null, "messagesession-agent-start-timestamp": null, "messagesession-last-type": "sms", "messagesession-last-media-type": "image/png", "messagesession-last-media-size": 5596, "messagesession-type": "", "messagesession-name": "", "messagesession-participants": "" }, { "user": "2500", "domain": "portal", "messagesession-id": "c3529b7ce79a86018d006462fa70fcea", "messagesession-remote": "1123@portal,1004@portal", "messagesession-sms-number": "", "messagesession-last-timestamp": "2023-10-10 18:24:40", "messagesession-start-timestamp": null, "messagesession-last-message": 941173465, "messagesession-last-sender": "1004@portal", "messagesession-last-status": "read", "messagesession-muted": "no", "messagesession-last-email-reminder-timestamp": "2023-10-09 21:09:57", "messagesession-reciever-hostname": "eng2-phx.example.com", "messagesession-queue-termination": null, "messagesession-queue-status": null, "messagesession-queue-session-id": null, "messagesession-agent-start-timestamp": null, "messagesession-last-type": "chat-vid", "messagesession-last-media-type": "", "messagesession-last-media-size": 0, "messagesession-type": "group-chat", "messagesession-name": "", "messagesession-participants": "1123@portal,2500@portal,1004@portal" }, { "user": "2500", "domain": "portal", "messagesession-id": "b0569814b84556c7ebca00be47d7f534", "messagesession-remote": "1123@portal", "messagesession-sms-number": "", "messagesession-last-timestamp": "2023-10-04 18:32:27", "messagesession-start-timestamp": null, "messagesession-last-message": "hi peter", "messagesession-last-sender": "2500@portal", "messagesession-last-status": "read", "messagesession-muted": "no", "messagesession-last-email-reminder-timestamp": null, "messagesession-reciever-hostname": "eng2-phx.example.com", "messagesession-queue-termination": null, "messagesession-queue-status": null, "messagesession-queue-session-id": null, "messagesession-agent-start-timestamp": null, "messagesession-last-type": "chat", "messagesession-last-media-type": "", "messagesession-last-media-size": 0, "messagesession-type": "", "messagesession-name": "", "messagesession-participants": null } ] } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "put": { "summary": "Update Messagesession (Participants)", "deprecated": false, "description": "This is how you add or remove participants from a chat message session. You cannot add or remove from a group MMS session, in that case you must start a new session.", "operationId": "updateMessageSessionParticipants", "tags": [ "Messages" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "portal", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "1123", "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "messagesession", "in": "path", "description": "ID of the message session to send in (when changing participants, do not change the session ID)", "required": true, "example": "", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "participants": { "type": "string", "description": "This is a comma separated list of User IDs that will be the final list of users in the group chat. This includes the current user's User ID" } }, "required": [ "participants" ] }, "example": null } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] }, "example": { "code": 202, "message": "Accepted" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "delete": { "summary": "Delete Messagesession", "deprecated": false, "description": "", "operationId": "deleteMessagesession", "tags": [ "Messages" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "sampleDomain", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "1000", "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "messagesession", "in": "path", "description": "ID of the message session to delete", "required": true, "example": "", "schema": { "type": "string" } } ], "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] }, "example": { "code": 202, "message": "Accepted" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/messagesessions/{messagesession}/messages": { "get": { "summary": "Get Messages for Messagesession", "deprecated": false, "description": "", "operationId": "GetMessagesForMessagesession", "tags": [ "Messages" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "messagesession", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Records per page. Defaults to 100, maximum 100. Higher values, or more than one `limit` parameter, are rejected with 400. Page through results with `start`.", "required": false, "schema": { "$ref": "#/components/schemas/Limit", "type": "integer", "minimum": 1, "maximum": 100, "default": 100 }, "example": 100 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Message" } }, "examples": { "1": { "summary": "Success", "value": [ { "id": 20202178326, "timestamp": "2023-07-31 23:52:35", "type": "chat", "domain": "portal", "direction": "", "dialed": "", "text": "whatu p", "status": "sending", "messagesession-reciever-hostname": "eng0-san.example.com", "from-number": "", "from-user-id": "2500@portal", "from-video-attendee-id": null, "from-user-agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KH", "terminating-user-id": "2503@portal", "terminating-number": "", "messagesession-id": "177b39bb06162ce930be0657f9286781", "video-instance-id": null, "media-type": "", "media-size": 0, "messagesession-participants": null, "deleted-timestamp": "" }, { "id": 71086444177, "timestamp": "2023-07-31 23:51:20", "type": "chat", "domain": "portal", "direction": "", "dialed": "", "text": "jjjj", "status": "sending", "messagesession-reciever-hostname": "eng2-phx.example.com", "from-number": "", "from-user-id": "2500@portal", "from-video-attendee-id": null, "from-user-agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KH", "terminating-user-id": "2503@portal", "terminating-number": "", "messagesession-id": "177b39bb06162ce930be0657f9286781", "video-instance-id": null, "media-type": "", "media-size": 0, "messagesession-participants": null, "deleted-timestamp": "" }, { "id": 97091760995, "timestamp": "2023-07-31 23:51:16", "type": "chat", "domain": "portal", "direction": "", "dialed": "", "text": "asdf", "status": "sending", "messagesession-reciever-hostname": "eng2-phx.example.com", "from-number": "", "from-user-id": "2500@portal", "from-video-attendee-id": null, "from-user-agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KH", "terminating-user-id": "2503@portal", "terminating-number": "", "messagesession-id": "177b39bb06162ce930be0657f9286781", "video-instance-id": null, "media-type": "", "media-size": 0, "messagesession-participants": null, "deleted-timestamp": "" }, { "id": 41354275372, "timestamp": "2023-07-31 23:51:09", "type": "chat", "domain": "portal", "direction": "", "dialed": "", "text": "asdf", "status": "sending", "messagesession-reciever-hostname": "eng2-phx.example.com", "from-number": "", "from-user-id": "2500@portal", "from-video-attendee-id": null, "from-user-agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KH", "terminating-user-id": "2503@portal", "terminating-number": "", "messagesession-id": "177b39bb06162ce930be0657f9286781", "video-instance-id": null, "media-type": "", "media-size": 0, "messagesession-participants": null, "deleted-timestamp": "" }, { "id": 67088400653, "timestamp": "2023-07-31 23:50:51", "type": "chat", "domain": "portal", "direction": "", "dialed": "", "text": "asdf", "status": "sending", "messagesession-reciever-hostname": "eng2-phx.example.com", "from-number": "", "from-user-id": "2500@portal", "from-video-attendee-id": null, "from-user-agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KH", "terminating-user-id": "2503@portal", "terminating-number": "", "messagesession-id": "177b39bb06162ce930be0657f9286781", "video-instance-id": null, "media-type": "", "media-size": 0, "messagesession-participants": null, "deleted-timestamp": "" } ] }, "2": { "summary": "Success Group Chat", "value": [ { "id": "m-652697db42351", "timestamp": "2023-10-11 12:40:59", "type": "chat", "domain": "automation", "direction": "", "dialed": "", "text": "Reply 3811", "status": "sending", "messagesession-reciever-hostname": "eng0-san.example.com", "from-number": "", "from-user-id": "1200@automation", "from-video-attendee-id": null, "from-user-agent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like ", "terminating-user-id": "3811@automation,100@automation", "terminating-number": "", "messagesession-id": "f453c6fddf0c27f0d173a0d70993f0fd", "video-instance-id": null, "media-type": "", "media-size": 0, "messagesession-participants": "3811@automation,100@automation,1200@automation", "deleted-timestamp": "" }, { "id": "m-652697d4ac49f", "timestamp": "2023-10-11 12:40:52", "type": "chat", "domain": "automation", "direction": "", "dialed": "", "text": "Hello 3811", "status": "sending", "messagesession-reciever-hostname": "eng0-san.example.com", "from-number": "", "from-user-id": "1200@automation", "from-video-attendee-id": null, "from-user-agent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like ", "terminating-user-id": "3811@automation,100@automation", "terminating-number": "", "messagesession-id": "f453c6fddf0c27f0d173a0d70993f0fd", "video-instance-id": null, "media-type": "", "media-size": 0, "messagesession-participants": "3811@automation,100@automation,1200@automation", "deleted-timestamp": "" } ] }, "3": { "summary": "Success Group SMS (changed numbers)", "value": [ { "id": "m-6261eb64a4191", "timestamp": "2022-04-21 23:40:20", "type": "sms", "domain": "portal", "direction": "orig", "dialed": "", "text": 5, "status": "", "messagesession-reciever-hostname": "eng1-dfw.example.com", "from-number": 17145550353, "from-user-id": "", "from-video-attendee-id": null, "from-user-agent": "Apache-HttpClient/4.5.13 (Java/1.8.0_152)", "terminating-user-id": "2500@portal", "terminating-number": "", "messagesession-id": "181b190ccd889bee28ed6aa9dbb0383f", "video-instance-id": null, "media-type": "", "media-size": 0, "messagesession-participants": "12285559476,14425553974,17145550353", "deleted-timestamp": "" }, { "id": "72d28e63f6e576c2b32f9542686b3259", "timestamp": "2022-04-21 23:40:20", "type": "mms", "domain": "portal", "direction": "orig", "dialed": "", "text": "media message", "status": "", "messagesession-reciever-hostname": "eng1-dfw.example.com", "from-number": 17145550353, "from-user-id": "", "from-video-attendee-id": null, "from-user-agent": "Apache-HttpClient/4.5.13 (Java/1.8.0_152)", "terminating-user-id": "2500@portal", "terminating-number": "", "messagesession-id": "181b190ccd889bee28ed6aa9dbb0383f", "video-instance-id": null, "media-type": "image/png", "media-size": 5450, "messagesession-participants": "12285559476,14425553974,17145550353", "deleted-timestamp": "", "file-access-url ": "https://eng1-dfw.example.com/api/?object=message&action=read_media&domain=portal&user=2500&time=20231011231857&id=72d28e63f6e576c2b32f9542686b3259&auth=1a8d112268f3dc1dc4486eaa2c9b4102" }, { "id": "deb3b1a2-8e70-4b3c-a4e5-bffae1eb6e2e", "timestamp": "2022-04-21 23:40:20", "type": "mms", "domain": "portal", "direction": "orig", "dialed": "", "text": "", "status": "", "messagesession-reciever-hostname": "eng1-dfw.example.com", "from-number": 17145550353, "from-user-id": "", "from-video-attendee-id": null, "from-user-agent": "Apache-HttpClient/4.5.13 (Java/1.8.0_152)", "terminating-user-id": "2500@portal", "terminating-number": "", "messagesession-id": "181b190ccd889bee28ed6aa9dbb0383f", "video-instance-id": null, "media-type": "image/png", "media-size": 5596, "messagesession-participants": "12285559476,14425553974,17145550353", "deleted-timestamp": "", "file-access-url ": "https://eng1-dfw.example.com/api/?object=message&action=read_media&domain=portal&user=2500&time=20231011231857&id=deb3b1a2-8e70-4b3c-a4e5-bffae1eb6e2e&auth=7ad1c49c8e7973e6cdf8e6533e40672c" } ] } } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "post": { "summary": "Send a message (Chat)", "deprecated": false, "description": "", "operationId": "sendMessageChat", "tags": [ "Messages" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "", "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "messagesession", "in": "path", "description": "ID of the message session to send in. Needs to be at least 32 characters long and random. Only alphanumeric chracters and underscore are allowed.", "required": true, "example": "", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/MessageType" }, "message": { "type": "string", "description": "This is the text that will be sent as the message" }, "destination": { "anyOf": [ { "type": "string", "description": "A single domain user or phonenumber", "examples": [ "1123", "18585551234" ] }, { "type": "array", "items": { "type": "string" }, "description": "An array of domain users or phonenumbers in string format" } ], "description": "This is a single user or phonenumber for chat and SMS respectively. If sending to multiple recipients, then should be an array of users or phonenumbers" }, "from-number": { "type": "string", "description": "This is used only for SMS. This is the user's number used to send outbound for SMS" }, "data": { "type": [ "string", "null" ], "description": "This is used only for media chat or MMS. This is the base64 data of the media file to be sent" }, "mime-type": { "description": "This is used only for media chat or MMS. This is the mime type of the media file to be sent", "anyOf": [ { "$ref": "#/components/schemas/MimeTypes" }, { "type": "null" } ] }, "size": { "type": [ "integer", "null" ], "description": "This is used only for media chat or MMS. This is the size in bytes of the media file being sent" } }, "required": [ "type", "message", "destination" ] }, "example": { "type": "chat", "message": "Hello there!", "destination": "0010" } } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] }, "example": { "code": 202, "message": "Accepted" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/messagesessions/{messagesession}/leave": { "put": { "summary": "Update Messagesession (Leave)", "deprecated": false, "description": "This is how you leave a chat conversation.", "operationId": "leaveMessagesession", "tags": [ "Messages" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "portal", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "1123", "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "messagesession", "in": "path", "description": "ID of the message session to send in (when changing participants, do not change the session ID)", "required": true, "example": "", "schema": { "type": "string" } } ], "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] }, "example": { "code": 202, "message": "Accepted" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/smsnumbers": { "get": { "summary": "Get SMS Numbers for Domain", "deprecated": false, "description": "", "operationId": "GetSmsNumbersForDomain", "tags": [ "SMS Numbers" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SmsNumber" } } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "post": { "summary": "Create SMS Number", "deprecated": false, "description": "", "operationId": "CreateSMSNumber", "tags": [ "SMS Numbers" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "number": { "type": "string" }, "application": { "type": "string", "description": "This is the application of the number. Can be for a user, callqueue, or available" }, "dest": { "type": "string", "description": "This is the destination for the SMS number if assigned. Can be a user or a call queue" }, "carrier": { "type": "string", "description": "Accepts carrier definition at number creation. Be mindful of formatting here. " } }, "required": [ "number", "application" ] }, "example": { "number": "18586451230", "application": "user", "dest": "2500" } } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] }, "example": { "domain": "portal", "number": "18585551230", "application": "user", "dest": "2500" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/smsnumbers": { "get": { "summary": "Get All SMS Numbers for System", "deprecated": false, "description": "", "operationId": "GetAllSMSNumbersSystem", "tags": [ "SMS Numbers" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SmsNumber" } } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/smsnumbers/{smsnumber}": { "put": { "summary": "Update SMS Number", "deprecated": false, "description": "", "operationId": "UpdateSMSNumber", "tags": [ "SMS Numbers" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "smsnumber", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "application": { "type": "string", "description": "This is the application of the number. Can be for a user, callqueue, or available" }, "dest": { "type": "string", "description": "This is the destination for the SMS number if assigned. Can be a user or a call queue" }, "carrier": { "type": "string", "description": "Accepts updating of carrier field, useful during porting of numbers. Mind the formatting." } }, "required": [ "application" ] }, "example": { "application": "user", "dest": "2500" } } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] }, "example": { "code": 202, "message": "Accepted" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "delete": { "summary": "Delete an SMS Number", "deprecated": false, "description": "", "operationId": "DeleteSMSNumber", "tags": [ "SMS Numbers" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "smsnumber", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] }, "example": { "code": 202, "message": "Accepted" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/smsnumbers": { "get": { "summary": "Get SMS Numbers for User", "deprecated": false, "description": "", "operationId": "GetSmsNumbersForUser", "tags": [ "SMS Numbers" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/UserNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SmsNumber" } } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/smsnumbers/count": { "get": { "summary": "Count SMS Numbers for User", "deprecated": false, "description": "", "operationId": "CountSmsNumbers", "tags": [ "SMS Numbers" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Count" }, "example": { "total": 29 } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 403, "message": "Domain not found or access denied" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/recordings/{callid}": { "get": { "summary": "Get Specific Recording by Callid for User", "deprecated": false, "description": "A user who is a party to a call may request the recording data for that call.", "tags": [ "Recordings" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "callid", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Recording" } } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/recordings/{callid}": { "get": { "summary": "Get Specific Recording by Callid for Domain", "deprecated": false, "description": "A user with sufficient scope may request recording data for calls to which they were not a party - but which are within their purview - using the domain and callid.", "tags": [ "Recordings" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "callid", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Recording" } } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/email/verify/{token}": { "post": { "summary": "Verify Email", "deprecated": false, "description": "", "operationId": "VerifyEmail", "tags": [ "Email" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "token", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/meetings/{id}/instance/{instance}/log": { "post": { "summary": "Create a Meeting Log Event", "deprecated": false, "description": "", "tags": [ "Meetings/Event Logs" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "id", "in": "path", "description": "Meeting Id", "required": true, "schema": { "type": "string" } }, { "name": "instance", "in": "path", "description": "Meeting Instance Id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "meeting event to log" }, "target": { "type": "string", "description": "the user the log entry pertains to" }, "details": { "type": "object", "properties": {}, "description": "meeting event details object" } }, "required": [ "event" ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "get": { "summary": "Read Meeting Events", "deprecated": false, "description": "", "tags": [ "Meetings/Event Logs" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "instance", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "meeting_events": { "type": "array", "items": { "type": "object", "properties": { "event_id": { "type": "string" }, "meeting_id": { "type": "integer" }, "source_id": { "type": [ "integer", "string" ] }, "event": { "type": "string" }, "target": { "type": "string" }, "details": { "type": "string" }, "timestamp": { "type": "string" }, "meeting-instance-id": { "type": "string" }, "file-source": { "type": "string" } }, "title": "meeting_event", "required": [ "event_id", "meeting_id", "source_id", "event", "target", "details", "timestamp", "meeting-instance-id", "file-source" ] } } }, "required": [ "meeting_events" ] } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/video": { "get": { "summary": "Read Iotum Video Host", "deprecated": false, "description": "Read a Iotum Host", "tags": [ "Meetings/Iotum" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Meeting" } } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/video/hosts": { "get": { "summary": "Read All Iotum Video Hosts in a Domain", "deprecated": false, "description": "Read All Iotum Video Hosts in a Domain", "tags": [ "Meetings/Iotum" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Meeting" } } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/video/conference": { "get": { "summary": "Read Iotum Video Host Conferences", "deprecated": false, "description": "Read a Iotum Host", "tags": [ "Meetings/Iotum" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "post": { "summary": "Create a Ad-hoc Conference", "deprecated": false, "description": "", "tags": [ "Meetings/Iotum", "Iotum" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "participants": { "type": "array", "items": { "type": "string" } } } } } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] }, "examples": { "1": { "summary": "Success", "value": { "code": 202, "message": "Accepted" } }, "2": { "summary": "Success", "value": { "code": 409, "message": "User already has a host_id" } } } } }, "headers": {} }, "409": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/video/contacts": { "get": { "summary": "Read Iotum Video Host Contacts", "deprecated": false, "description": "Read a Iotum Host", "tags": [ "Meetings/Iotum" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Meeting" } } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/video": { "get": { "summary": "Read Iotum Video Company", "deprecated": false, "description": "Read a Iotum Company (domain)", "tags": [ "Meetings/Iotum" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Meeting" } } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "put": { "summary": "Update Domain's Iotum Company", "deprecated": false, "description": "Update the details of a Domain's Iotum Company", "tags": [ "Meetings/Iotum", "Iotum" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "company-name": { "type": "string" } } }, "example": { "default-plan": "example_pro", "plans": [ "example_pro" ], "default-addons": [ "example_webinar_5000", "example_webinar_3000" ], "add-ons": [ "example_webinar_500", "example_webinar_5000", "example_webinar_3000" ] } } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] }, "examples": { "1": { "summary": "Success", "value": { "code": 202, "message": "Accepted" } }, "2": { "summary": "Success", "value": { "code": 409, "message": "User already has a host_id" } } } } }, "headers": {} }, "409": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "post": { "summary": "Create Iotum Video Company", "deprecated": false, "description": "Read a Iotum Company (domain)", "tags": [ "Meetings/Iotum" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "Leftcoast", "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "subdomain": { "type": "string" } }, "required": [ "name", "subdomain" ] }, "example": null } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Meeting" } } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "delete": { "summary": "Delete a Video Company", "deprecated": false, "description": "", "tags": [ "Meetings/Iotum", "Iotum" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] }, "examples": { "1": { "summary": "Success", "value": { "code": 202, "message": "Accepted" } }, "2": { "summary": "Success", "value": { "code": 409, "message": "User already has a host_id" } } } } }, "headers": {} }, "409": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/video/products": { "get": { "summary": "Read Iotum Video Company Products", "deprecated": false, "description": "Read the products (plans and add-ons) a domain's company is currently using", "tags": [ "Meetings/Iotum" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Meeting" } } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/video/availableproducts": { "get": { "summary": "Read Iotum Video Available Products", "deprecated": false, "description": "Read all available products for the company via the reseller", "tags": [ "Meetings/Iotum" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "", "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Meeting" } } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/host": { "post": { "summary": "Create a Host", "deprecated": false, "description": "", "tags": [ "Meetings/Iotum", "Iotum" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IotumHost" } } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] }, "examples": { "1": { "summary": "Success", "value": { "code": 202, "message": "Accepted" } }, "2": { "summary": "Success", "value": { "code": 409, "message": "User already has a host_id" } } } } }, "headers": {} }, "409": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "put": { "summary": "Update User's Iotum Host", "deprecated": false, "description": "Update a user's Iotum Host.", "tags": [ "Meetings/Iotum", "Iotum" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/UserNamePath" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "default-plan": { "type": "string" }, "plans": { "type": "array", "items": { "type": "string" } }, "default-addons": { "type": "array", "items": { "type": "string" } }, "add-ons": { "type": "array", "items": { "type": "string" } }, "iotum_time_format": { "type": "object", "properties": { "hm_separator": { "type": "string" }, "md_format": { "type": "string" }, "md_y_comma": { "type": "boolean" }, "time_24hr": { "type": "boolean" } }, "required": [ "hm_separator", "md_format", "md_y_comma", "time_24hr" ] } }, "required": [ "default-plan", "plans", "default-addons", "add-ons", "iotum_time_format" ] }, "example": { "default-plan": "example_pro", "plans": [ "example_pro" ], "default-addons": [ "example_webinar_5000", "example_webinar_3000" ], "add-ons": [ "example_webinar_500", "example_webinar_5000", "example_webinar_3000" ] } } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] }, "examples": { "1": { "summary": "Success", "value": { "code": 202, "message": "Accepted" } }, "2": { "summary": "Success", "value": { "code": 409, "message": "User already has a host_id" } } } } }, "headers": {} }, "409": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "delete": { "summary": "Delete a Host", "deprecated": false, "description": "", "tags": [ "Meetings/Iotum", "Iotum" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } } ], "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] }, "examples": { "1": { "summary": "Success", "value": { "code": 202, "message": "Accepted" } }, "2": { "summary": "Success", "value": { "code": 409, "message": "User already has a host_id" } } } } }, "headers": {} }, "409": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/host/contacts": { "post": { "summary": "Create Host Contacts", "deprecated": false, "description": "", "tags": [ "Meetings/Iotum", "Iotum" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IotumContact" } } } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] }, "examples": { "1": { "summary": "Success", "value": { "code": 202, "message": "Accepted" } }, "2": { "summary": "Success", "value": { "code": 409, "message": "User already has a host_id" } } } } }, "headers": {} }, "409": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/video/subscription/{slug}": { "post": { "summary": "Create Iotum Video Subscription", "deprecated": false, "description": "Create a Iotum video subscription to one of the available Iotum products for that company", "tags": [ "Meetings/Iotum", "Iotum" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "slug", "in": "path", "description": "", "required": true, "example": "", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "switch-plan": { "type": "boolean", "description": "If specified and set to the subscription ID of one of the company’s current plans, that plan will be canceled and used in to prorate the initial amount of the new plan (plan switching) If set to null, the current plan(s) of the company will not be canceled and instead the company will be subscribed to the provided plan in addition to their existing plan(s). When omitted (no key/value not present in the request body), the default behavior of switching the company’s current plan with the new plan will be applied." }, "host-limit": { "type": "integer", "description": "A positive integer value that the new subscription’s host limit should be set to. When subscribing to a product that is using the per-host pricing method, the host_limit value provided will be multiplied by the per-host price of the product to determine and set the total amount of the monthly subscription charges." } } }, "example": { "host-limit": 201, "switch-plan": false } } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] }, "examples": { "1": { "summary": "Success", "value": { "code": 202, "message": "Accepted" } }, "2": { "summary": "Success", "value": { "code": 409, "message": "User already has a host_id" } } } } }, "headers": {} }, "409": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "delete": { "summary": "Delete Iotum Video Subscription", "deprecated": false, "description": "Delete a subscription to a product for the domain's company.", "tags": [ "Meetings/Iotum", "Iotum" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "slug", "in": "path", "description": "", "required": true, "example": "", "schema": { "type": "string" } } ], "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] }, "examples": { "1": { "summary": "Success", "value": { "code": 202, "message": "Accepted" } }, "2": { "summary": "Success", "value": { "code": 409, "message": "User already has a host_id" } } } } }, "headers": {} }, "409": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/video/subscriptions": { "put": { "summary": "Update Domain's Iotum Subscriptions", "deprecated": false, "description": "Update the plans and add-ons a domain's Iotum company is subscribed to.", "tags": [ "Meetings/Iotum", "Iotum" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "plans": { "type": "array", "items": { "type": "string" } }, "add-ons": { "type": "array", "items": { "type": "string" } }, "default-plan": { "type": "string" }, "default-addons": { "type": "array", "items": { "type": "string" } } } }, "example": { "default-plan": "example_pro", "plans": [ "example_pro" ], "default-addons": [ "example_webinar_5000", "example_webinar_3000" ], "add-ons": [ "example_webinar_500", "example_webinar_5000", "example_webinar_3000" ] } } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] }, "examples": { "1": { "summary": "Success", "value": { "code": 202, "message": "Accepted" } }, "2": { "summary": "Success", "value": { "code": 409, "message": "User already has a host_id" } } } } }, "headers": {} }, "409": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/meetings/{id}": { "post": { "summary": "Create a Meeting with Id", "deprecated": false, "description": "API v1 create meeting passing in newly requested meeting Id", "tags": [ "Meetings" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "id", "in": "path", "description": "Meeting Id to create", "required": true, "example": "779608244", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string" }, "current_timestamp": { "description": "This is when the message was recieved or sent", "$ref": "#/components/schemas/Timestamp" }, "meeting-calendar-invite-id": { "type": "string" }, "meeting-ordinal-sequence": { "type": "integer" }, "core-server": { "type": "string" }, "chat-session-id": { "type": "string" }, "meeting-registration-id": { "type": "string" }, "meeting-instance-id": { "type": "string" }, "meeting-name": { "type": "string" }, "meeting-type": { "type": "string" }, "limits-max-participants": { "type": "integer" }, "meeting-status": { "type": "string" }, "meeting-schedule-start-datetime": { "description": "This is when the message was recieved or sent", "$ref": "#/components/schemas/Timestamp" }, "timezone": { "$ref": "#/components/schemas/TimeZone" }, "meeting-schedule-duration-minutes": { "type": "integer" }, "meeting-schedule-recurrence-rule": { "type": "string" }, "meeting-video-allowed-from": { "$ref": "#/components/schemas/YesNoString", "description": "Enabled will trigger music on hold for the domain and allow it to be customized. " }, "meeting-audio-allowed-from": { "$ref": "#/components/schemas/YesNoString", "description": "Enabled will trigger music on hold for the domain and allow it to be customized. " }, "meeting-chat-enabled": { "$ref": "#/components/schemas/YesNoString", "description": "Enabled will trigger music on hold for the domain and allow it to be customized. " }, "meeting-chat-history-enabled": { "$ref": "#/components/schemas/YesNoString", "description": "Enabled will trigger music on hold for the domain and allow it to be customized. " }, "meeting-question-answer-enabled": { "$ref": "#/components/schemas/YesNoString", "description": "Enabled will trigger music on hold for the domain and allow it to be customized. " }, "meeting-recording-enabled": { "$ref": "#/components/schemas/YesNoString", "description": "Enabled will trigger music on hold for the domain and allow it to be customized. " }, "meeting-join-require-invite-enabled": { "$ref": "#/components/schemas/YesNoString", "description": "Enabled will trigger music on hold for the domain and allow it to be customized. " }, "meeting-join-require-passcode-enabled": { "$ref": "#/components/schemas/YesNoString", "description": "Enabled will trigger music on hold for the domain and allow it to be customized. " }, "meeting-require-host-to-begin-enabled": { "$ref": "#/components/schemas/YesNoString", "description": "Enabled will trigger music on hold for the domain and allow it to be customized. " }, "meeting-allow-changes-from-hosts-enabled": { "$ref": "#/components/schemas/YesNoString", "description": "Enabled will trigger music on hold for the domain and allow it to be customized. " }, "meeting-hide-attendee-list-enabled": { "$ref": "#/components/schemas/YesNoString", "description": "Enabled will trigger music on hold for the domain and allow it to be customized. " }, "meeting-lock-enabled": { "$ref": "#/components/schemas/YesNoString", "description": "Enabled will trigger music on hold for the domain and allow it to be customized. " }, "meeting-lock-allowed": { "$ref": "#/components/schemas/YesNoString", "description": "Enabled will trigger music on hold for the domain and allow it to be customized. " }, "meeting-room-enabled": { "$ref": "#/components/schemas/YesNoString", "description": "Enabled will trigger music on hold for the domain and allow it to be customized. " }, "meeting-dial-in-number-blob": { "type": "string" }, "meeting-passcode": { "type": "string" }, "meeting-previous-presenter-attendee-id": { "type": "string" }, "meeting-presenter-attendee-id": { "type": "string" }, "meeting-video-layout ": { "type": "integer" }, "last-modified-datetime": { "description": "This is when the message was recieved or sent", "$ref": "#/components/schemas/Timestamp" }, "meeting-instance-actual-start-datetime": { "description": "This is when the message was recieved or sent", "$ref": "#/components/schemas/Timestamp" } }, "required": [ "meeting-name" ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "The meeting id", "readOnly": true }, "domain": { "$ref": "#/components/schemas/DomainName" }, "user": { "$ref": "#/components/schemas/UserName" }, "description": { "type": "string", "description": "The description about the meeting" }, "current_timestamp": { "type": "string", "description": "The current timestamp value of the meeting", "format": "date-time" }, "meeting-calendar-invite-id": { "type": "string", "readOnly": true, "description": "The read only value for the meeting to use with calendar integration" }, "meeting-ordinal-sequence": { "type": "integer", "readOnly": true, "description": "The read only value for the meeting with manage the calendar integrations" }, "core-server": { "type": "string", "description": "The core server which the meeting was created on and events are driven from", "readOnly": true }, "chat-session-id": { "type": "string", "readOnly": true, "description": "The read only value identifying the meeting chat room session" }, "meeting-registration-id": { "type": "string", "description": "The token value for guest to use to register for a webinar" }, "meeting-instance-id": { "type": "string", "description": "The instance value of a meeting with used to associate with a recording or differentiating recurring meetings" }, "meeting-name": { "type": "string", "description": "The descriptive name of the meeting" }, "meeting-type": { "type": "string", "description": "The meeting category either the standard meeting 'conference' or a webinar style meeting by using 'presentation'", "enum": [ "presentation", "conference" ], "default": "conference" }, "limits-max-participants": { "type": "integer", "description": "The maximum number of participants allows in the meeting" }, "meeting-status": { "anyOf": [ { "$ref": "#/components/schemas/MeetingStatus" }, { "type": "string", "title": "empty string", "maxLength": 0 } ], "description": "The current status of the meeting" }, "meeting-schedule-start-datetime": { "type": "string", "description": "The scheduled start time for the meeting", "format": "date-time" }, "timezone": { "$ref": "#/components/schemas/TimeZone" }, "meeting-schedule-duration-minutes": { "type": "integer", "description": "The scheduled length of the meeting" }, "meeting-schedule-recurrence-rule": { "type": "string", "description": "The read only value describing the recuring nature of the meeting using RFC 5545", "readOnly": true }, "meeting-video-allowed-from": { "type": "string", "enum": [ "everyone", "host", "presenters" ], "description": "The value indicating which attendee types can share video" }, "meeting-audio-allowed-from": { "type": "string", "enum": [ "everyone", "host", "presenters" ], "description": "The value indicating which attendee types can share audio" }, "meeting-chat-enabled": { "description": "The value indicating if chat is enabled for this meeting", "$ref": "#/components/schemas/OneZeroDefaultOne" }, "meeting-chat-history-enabled": { "description": "The value indicating if chat is enabled for this meeting", "$ref": "#/components/schemas/OneZeroDefaultOne" }, "meeting-question-answer-enabled": { "description": "The value indicating if question and answer feature is enabled", "$ref": "#/components/schemas/OneZeroDefaultZero" }, "meeting-recording-enabled": { "description": "The value indicating if question and answer feature is enabled", "$ref": "#/components/schemas/OneZeroDefaultZero" }, "meeting-join-require-invite-enabled": { "description": "The value indicating if question and answer feature is enabled", "$ref": "#/components/schemas/OneZeroDefaultZero" }, "meeting-join-require-passcode-enabled": { "description": "The value indicating if question and answer feature is enabled", "$ref": "#/components/schemas/OneZeroDefaultZero" }, "meeting-require-host-to-begin-enabled": { "description": "The value indicating if question and answer feature is enabled", "$ref": "#/components/schemas/OneZeroDefaultZero" }, "meeting-allow-changes-from-hosts-enabled": { "description": "The value indicating if chat is enabled for this meeting", "$ref": "#/components/schemas/OneZeroDefaultOne" }, "meeting-hide-attendee-list-enabled": { "description": "The value indicating if question and answer feature is enabled", "$ref": "#/components/schemas/OneZeroDefaultZero" }, "meeting-lock-enabled": { "description": "The value indicating if question and answer feature is enabled", "$ref": "#/components/schemas/OneZeroDefaultZero" }, "meeting-lock-allowed": { "type": "string", "description": "The value indicating if the meeting is allowed to be locked" }, "meeting-room-enabled": { "description": "The value indicating if question and answer feature is enabled", "$ref": "#/components/schemas/OneZeroDefaultZero" }, "meeting-dial-in-number-blob": { "anyOf": [ { "type": "string" }, { "type": "integer" } ], "description": "The number for audio-only users to dial in to the meeting" }, "meeting-passcode": { "type": "string", "description": "The passcode used to enter meeting if it is required" }, "meeting-previous-presenter-attendee-id": { "type": "string", "description": "The value of the previous attendee that prsented their screen", "readOnly": true }, "meeting-presenter-attendee-id": { "type": "string", "description": "The value of the current attendee that is sharing their screen" }, "meeting-video-layout ": { "type": "string", "description": "The current meeting layout default for entire meeting", "enum": [ "spotlight", "conversation", "grid" ] }, "last-modified-datetime": { "type": "string", "description": "The timestamp of the last time the meeting was modified", "format": "date-time" }, "meeting-instance-actual-start-datetime": { "type": "string", "description": "The timestamp the current meeting instance was started", "format": "date-time" } }, "required": [ "id", "domain", "user", "current_timestamp", "meeting-status", "meeting-schedule-start-datetime", "timezone", "meeting-room-enabled" ] } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "get": { "summary": "Read Meeting", "deprecated": false, "description": "", "tags": [ "Meetings" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "id", "in": "path", "description": "", "required": true, "example": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Meeting" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/meetings": { "post": { "summary": "Create a Meeting", "deprecated": false, "description": "Create a new meeting wit", "tags": [ "Meetings" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "description": "The description about the meeting" }, "current_timestamp": { "type": "string", "description": "The current timestamp value of the meeting", "format": "date-time" }, "meeting-calendar-invite-id": { "type": "string", "readOnly": true, "description": "The read only value for the meeting to use with calendar integration" }, "meeting-ordinal-sequence": { "type": "integer", "readOnly": true, "description": "The read only value for the meeting with manage the calendar integrations" }, "core-server": { "type": "string", "description": "The core server which the meeting was created on and events are driven from", "readOnly": true }, "chat-session-id": { "type": "string", "readOnly": true, "description": "The read only value identifying the meeting chat room session" }, "meeting-registration-id": { "type": "string", "description": "The token value for guest to use to register for a webinar" }, "meeting-instance-id": { "type": "string", "description": "The instance value of a meeting with used to associate with a recording or differentiating recurring meetings" }, "meeting-name": { "type": "string", "description": "The descriptive name of the meeting" }, "meeting-type": { "type": "string", "description": "The meeting category either the standard meeting 'conference' or a webinar style meeting by using 'presentation'", "enum": [ "presentation", "conference" ], "default": "conference" }, "limits-max-participants": { "type": "integer", "description": "The maximum number of participants allows in the meeting" }, "meeting-status": { "anyOf": [ { "$ref": "#/components/schemas/MeetingStatus" }, { "type": "string", "title": "empty string", "maxLength": 0 } ], "description": "The current status of the meeting" }, "meeting-schedule-start-datetime": { "type": "string", "description": "The scheduled start time for the meeting", "format": "date-time" }, "timezone": { "$ref": "#/components/schemas/TimeZone" }, "meeting-schedule-duration-minutes": { "type": "integer", "description": "The scheduled length of the meeting" }, "meeting-schedule-recurrence-rule": { "type": "string", "description": "The read only value describing the recuring nature of the meeting using RFC 5545", "readOnly": true }, "meeting-video-allowed-from": { "type": "string", "enum": [ "everyone", "host", "presenters" ], "description": "The value indicating which attendee types can share video" }, "meeting-audio-allowed-from": { "type": "string", "enum": [ "everyone", "host", "presenters" ], "description": "The value indicating which attendee types can share audio" }, "meeting-chat-enabled": { "description": "The value indicating if chat is enabled for this meeting", "$ref": "#/components/schemas/OneZeroDefaultOne" }, "meeting-chat-history-enabled": { "description": "The value indicating if chat is enabled for this meeting", "$ref": "#/components/schemas/OneZeroDefaultOne" }, "meeting-question-answer-enabled": { "description": "The value indicating if question and answer feature is enabled", "$ref": "#/components/schemas/OneZeroDefaultZero" }, "meeting-recording-enabled": { "description": "The value indicating if question and answer feature is enabled", "$ref": "#/components/schemas/OneZeroDefaultZero" }, "meeting-join-require-invite-enabled": { "description": "The value indicating if question and answer feature is enabled", "$ref": "#/components/schemas/OneZeroDefaultZero" }, "meeting-join-require-passcode-enabled": { "description": "The value indicating if question and answer feature is enabled", "$ref": "#/components/schemas/OneZeroDefaultZero" }, "meeting-require-host-to-begin-enabled": { "description": "The value indicating if question and answer feature is enabled", "$ref": "#/components/schemas/OneZeroDefaultZero" }, "meeting-allow-changes-from-hosts-enabled": { "description": "The value indicating if chat is enabled for this meeting", "$ref": "#/components/schemas/OneZeroDefaultOne" }, "meeting-hide-attendee-list-enabled": { "description": "The value indicating if question and answer feature is enabled", "$ref": "#/components/schemas/OneZeroDefaultZero" }, "meeting-lock-enabled": { "description": "The value indicating if question and answer feature is enabled", "$ref": "#/components/schemas/OneZeroDefaultZero" }, "meeting-lock-allowed": { "type": "string", "description": "The value indicating if the meeting is allowed to be locked" }, "meeting-room-enabled": { "description": "The value indicating if question and answer feature is enabled", "$ref": "#/components/schemas/OneZeroDefaultZero" }, "meeting-dial-in-number-blob": { "anyOf": [ { "type": "string" }, { "type": "integer" } ], "description": "The number for audio-only users to dial in to the meeting" }, "meeting-passcode": { "type": "string", "description": "The passcode used to enter meeting if it is required" }, "meeting-previous-presenter-attendee-id": { "type": "string", "description": "The value of the previous attendee that prsented their screen", "readOnly": true }, "meeting-presenter-attendee-id": { "type": "string", "description": "The value of the current attendee that is sharing their screen" }, "meeting-video-layout ": { "type": "string", "description": "The current meeting layout default for entire meeting", "enum": [ "spotlight", "conversation", "grid" ] }, "last-modified-datetime": { "type": "string", "description": "The timestamp of the last time the meeting was modified", "format": "date-time" }, "meeting-instance-actual-start-datetime": { "type": "string", "description": "The timestamp the current meeting instance was started", "format": "date-time" } }, "required": [ "current_timestamp", "meeting-status", "meeting-schedule-start-datetime", "timezone", "meeting-room-enabled" ] }, "example": { "meeting-schedule-start-datetime": "2023-11-07T15:18:52.409Z", "timezone": "Etc/GMT-11", "meeting-room-enabled": 0, "meeting-recording-enabled": 0, "meeting-video-allowed-from": "host", "meeting-require-host-to-begin-enabled": 0, "limits-max-participants": 53034089, "description": "proident consectetur", "meeting-hide-attendee-list-enabled": 0, "meeting-schedule-duration-minutes": 5848348, "meeting-question-answer-enabled": 0, "meeting-lock-enabled": 0, "meeting-allow-changes-from-hosts-enabled": 1, "meeting-chat-enabled": 1, "meeting-audio-allowed-from": "presenters", "meeting-chat-history-enabled": 1, "meeting-join-require-passcode-enabled": 0, "meeting-type": "conference", "meeting-video-layout ": "conversation", "meeting-name": "laboris minim mollit ullamco aliquip", "meeting-join-require-invite-enabled": 0 } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Meeting" } } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "get": { "summary": "Read Meetings for User", "deprecated": false, "description": "", "tags": [ "Meetings" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/UserNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Meeting" } } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/meetings/count": { "get": { "summary": "Count Domains Meetings", "deprecated": false, "description": "", "tags": [ "Meetings" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Count" }, "example": { "total": 37 } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 403, "message": "Domain not found or access denied" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/meetings/{meeting_id}/count": { "get": { "summary": "Count Meeting", "deprecated": false, "description": "", "tags": [ "Meetings" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "meeting_id", "in": "path", "description": "Meeting Id which to query meeting total", "required": true, "example": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Count" }, "example": { "total": 1 } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 403, "message": "Domain not found or access denied" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/meetings/register/{meeting_registration_id}": { "post": { "summary": "Register Meeting", "deprecated": false, "description": "", "tags": [ "Meetings" ], "parameters": [ { "name": "meeting_registration_id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of attendee" }, "email": { "type": "string", "description": "Email address for attendee" } }, "required": [ "name", "email" ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/meetings/{meeting}": { "put": { "summary": "Update a Meeting", "deprecated": false, "description": "", "tags": [ "Meetings" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "meeting", "in": "path", "description": "", "required": true, "example": "975300547", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "The meeting id", "readOnly": true }, "domain": { "$ref": "#/components/schemas/DomainName" }, "user": { "$ref": "#/components/schemas/UserName" }, "description": { "type": "string", "description": "The description about the meeting" }, "meeting-name": { "type": "string", "description": "The descriptive name of the meeting" }, "meeting-type": { "type": "string", "description": "The meeting category either the standard meeting 'conference' or a webinar style meeting by using 'presentation'", "enum": [ "presentation", "conference" ], "default": "conference" }, "limits-max-participants": { "type": "integer", "description": "The maximum number of participants allows in the meeting" }, "meeting-status": { "anyOf": [ { "$ref": "#/components/schemas/MeetingStatus" }, { "type": "string", "title": "empty string", "maxLength": 0 } ], "description": "The current status of the meeting" }, "meeting-schedule-start-datetime": { "type": "string", "description": "The scheduled start time for the meeting", "format": "date-time" }, "timezone": { "$ref": "#/components/schemas/TimeZone" }, "meeting-schedule-duration-minutes": { "type": "integer", "description": "The scheduled length of the meeting" }, "meeting-schedule-recurrence-rule": { "type": "string", "description": "The read only value describing the recuring nature of the meeting using RFC 5545", "readOnly": true }, "meeting-video-allowed-from": { "type": "string", "enum": [ "everyone", "host", "presenters" ], "description": "The value indicating which attendee types can share video" }, "meeting-audio-allowed-from": { "type": "string", "enum": [ "everyone", "host", "presenters" ], "description": "The value indicating which attendee types can share audio" }, "meeting-chat-enabled": { "description": "The value indicating if chat is enabled for this meeting", "$ref": "#/components/schemas/OneZeroDefaultOne" }, "meeting-chat-history-enabled": { "description": "The value indicating if chat is enabled for this meeting", "$ref": "#/components/schemas/OneZeroDefaultOne" }, "meeting-question-answer-enabled": { "description": "The value indicating if question and answer feature is enabled", "$ref": "#/components/schemas/OneZeroDefaultZero" }, "meeting-recording-enabled": { "description": "The value indicating if question and answer feature is enabled", "$ref": "#/components/schemas/OneZeroDefaultZero" }, "meeting-join-require-invite-enabled": { "description": "The value indicating if question and answer feature is enabled", "$ref": "#/components/schemas/OneZeroDefaultZero" }, "meeting-join-require-passcode-enabled": { "description": "The value indicating if question and answer feature is enabled", "$ref": "#/components/schemas/OneZeroDefaultZero" }, "meeting-require-host-to-begin-enabled": { "description": "The value indicating if question and answer feature is enabled", "$ref": "#/components/schemas/OneZeroDefaultZero" }, "meeting-allow-changes-from-hosts-enabled": { "description": "The value indicating if chat is enabled for this meeting", "$ref": "#/components/schemas/OneZeroDefaultOne" }, "meeting-hide-attendee-list-enabled": { "description": "The value indicating if question and answer feature is enabled", "$ref": "#/components/schemas/OneZeroDefaultZero" }, "meeting-lock-enabled": { "description": "The value indicating if question and answer feature is enabled", "$ref": "#/components/schemas/OneZeroDefaultZero" }, "meeting-lock-allowed": { "type": "string", "description": "The value indicating if the meeting is allowed to be locked" }, "meeting-room-enabled": { "description": "The value indicating if question and answer feature is enabled", "$ref": "#/components/schemas/OneZeroDefaultZero" }, "meeting-passcode": { "type": "string", "description": "The passcode used to enter meeting if it is required" }, "meeting-previous-presenter-attendee-id": { "type": "string", "description": "The value of the previous attendee that prsented their screen", "readOnly": true }, "meeting-presenter-attendee-id": { "type": "string", "description": "The value of the current attendee that is sharing their screen" }, "meeting-video-layout ": { "type": "string", "description": "The current meeting layout default for entire meeting", "enum": [ "spotlight", "conversation", "grid" ] } }, "required": [ "id", "domain", "user", "meeting-status", "meeting-schedule-start-datetime", "timezone", "meeting-room-enabled" ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "delete": { "summary": "Delete a Meeting", "deprecated": false, "description": "", "tags": [ "Meetings" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "meeting", "in": "path", "description": "the meeting id to perfom the delete on", "required": true, "example": "123456789", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/DeleteType", "description": "Type of delete" }, "meeting-instance-schedule-start-datetime": { "description": "This is when the message was recieved or sent", "$ref": "#/components/schemas/Timestamp" }, "attendeeids": { "type": "array", "items": { "type": "string" }, "description": "Required with delete type attendee" } }, "required": [ "type" ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/meetings/getId": { "post": { "summary": "Request a Meeting ID", "deprecated": false, "description": "API v1 request Id prior to create meeting", "tags": [ "Meetings" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "Meeting id" }, "registration_id": { "type": "string", "description": "Registration id" }, "phonenumbers": { "type": "string", "description": "Dial in phone number" } }, "required": [ "id", "registration_id", "phonenumbers" ] }, "example": "{\n \"id\": ### ### ###,\n \"registration_id\": \"%########\",\n \"phonenumbers\": \"# ### ### ####\"\n}" } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/images/{filename}": { "get": { "summary": "Read Image", "deprecated": false, "description": "Read an image file", "operationId": "ReadImage", "tags": [ "Images" ], "parameters": [ { "name": "filename", "in": "path", "description": "The name of the image file.", "required": true, "example": "nonexistent_image.png", "schema": { "type": "string" } }, { "name": "reseller", "in": "query", "description": "", "required": true, "example": "{{reseller}}", "schema": { "type": "string" } }, { "name": "domain", "in": "query", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "server", "in": "query", "description": "", "required": true, "example": "*", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": { "type": "string" }, "server": { "type": "string" }, "description": { "type": "string" }, "reseller": { "type": "string" }, "file-mime-type": { "type": "string" }, "file-size-bytes": { "type": "integer" }, "file-access-url ": { "type": "string" } }, "required": [ "domain", "server", "description", "reseller", "file-mime-type", "file-size-bytes", "file-access-url " ] } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] }, "example": { "code": 404, "message": "File not found." } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "post": { "summary": "Create Image from Upload (JSON + Base64 File)", "deprecated": false, "description": "Create an image file", "operationId": "CreateImageBase64", "tags": [ "Images" ], "parameters": [ { "name": "filename", "in": "path", "description": "The name of the image file.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "reseller": { "type": "string", "description": "The reseller or territory the image file applies to.", "default": "*" }, "domain": { "type": "string", "description": "The domain the image file applies to.", "default": "*" }, "server": { "type": "string", "description": "The server the image file applies to.", "default": "*" }, "description": { "type": "string", "description": "A description of the image file to indicate what it is used for" }, "filetype": { "type": "string", "description": "Encoding (content type) of the image file" }, "base64_file": { "type": "string", "description": "A base64 encoded string formatted without line breaks or spaces." } }, "required": [ "filetype", "base64_file" ] } } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] }, "example": { "code": 400, "message": "File already exists." } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "delete": { "summary": "Delete an Image", "deprecated": false, "description": "Delete an image file", "operationId": "DeleteImage", "tags": [ "Images" ], "parameters": [ { "name": "filename", "in": "path", "description": "The name of the image file.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "reseller": { "type": "string", "description": "The reseller or territory the image file applies to.", "default": "*" }, "domain": { "type": "string", "description": "The domain the image file applies to.", "default": "*" }, "server": { "type": "string", "description": "The server the image file applies to.", "default": "*" } } } } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] }, "example": { "code": 202, "message": "Accepted" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] }, "example": { "code": 404, "message": "File does not exist." } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "put": { "summary": "Update Image from Upload (Multipart/Mixed Post)", "deprecated": false, "description": "Update an image file", "operationId": "UpdateImageFileUpload", "tags": [ "Images" ], "parameters": [ { "name": "filename", "in": "path", "description": "The name of the image file.", "required": true, "example": "portal_main_top_left.png", "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "reseller": { "description": "The reseller or territory this image file applies to. Defaults to \"*\"", "example": "", "type": "string" }, "domain": { "description": "The domain this image file applies to. Defaults to \"*\"", "example": "", "type": "string" }, "server": { "description": "The domain this image file applies to. Defaults to \"*\"", "example": "", "type": "string" }, "description": { "description": "A description of the image file to indicate what it is used for.", "example": "", "type": "string" }, "File": { "description": "A \"File\" type parameter that needs to include the image file in question using a file post method.", "example": "file:///Users/caaker/Downloads/portal_main_top_left (19).png", "type": "string", "format": "binary" } }, "required": [ "File" ] }, "examples": {} } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] }, "examples": { "1": { "summary": "Success", "description": "", "value": { "code": 202, "message": "Accepted" } }, "4": { "summary": "Success", "description": "", "value": { "code": 202, "message": "Accepted" } } } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] }, "example": { "code": 400, "message": "Missing file information." } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] }, "example": { "code": 404, "message": "File does not exist." } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/templates/{filename}": { "get": { "summary": "Read Template", "deprecated": false, "description": "Read a template file", "operationId": "ReadTemplate", "tags": [ "Templates" ], "parameters": [ { "name": "filename", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "reseller", "in": "query", "description": "The reseller or territory the template file applies to. Defaults to \"*\"", "required": false, "example": "", "schema": { "type": "string" } }, { "name": "domain", "in": "query", "description": "The domain the template file applies to. Defaults to \"*\"", "required": false, "example": "", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "server", "in": "query", "description": "The server the template file applies to. Defaults to \"*\"", "required": false, "example": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": { "type": "string" }, "server": { "type": "string" }, "description": { "type": "string" }, "reseller": { "type": "string" }, "file-mime-type": { "type": "string" }, "file-size-bytes": { "type": "integer" }, "file-access-url ": { "type": "string" } }, "required": [ "domain", "server", "description", "reseller", "file-mime-type", "file-size-bytes", "file-access-url " ] } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] }, "examples": { "1": { "summary": "Exception", "value": { "code": 404, "message": "File not found." } }, "2": { "summary": "Exception", "value": { "code": 404, "message": "File not found." } } } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "post": { "summary": "Create Template from Upload (JSON + Base64 File)", "deprecated": false, "description": "Create a template file", "operationId": "CreateTemplateBase64", "tags": [ "Templates" ], "parameters": [ { "name": "filename", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "reseller": { "type": "string", "description": "The reseller or territory the template file applies to.", "default": "*" }, "domain": { "type": "string", "description": "The domain the template file applies to.", "default": "*" }, "server": { "type": "string", "description": "The server the template file applies to.", "default": "*" }, "description": { "type": "string", "description": "A description of the template file to indicate what it is used for" }, "filetype": { "type": "string", "description": "Encoding (content type) of the template file" }, "base64_file": { "type": "string", "description": "A base64 encoded string formatted without line breaks or spaces." } }, "required": [ "filetype", "base64_file" ] } } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] }, "examples": { "1": { "summary": "Success", "value": { "code": 202, "message": "Accepted" } }, "2": { "summary": "Exception", "value": { "code": 400, "message": "File already exists." } } } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] }, "example": { "code": 400, "message": "Missing file information." } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "delete": { "summary": "Delete a Template", "deprecated": false, "description": "Delete a template file", "operationId": "DeleteTemplate", "tags": [ "Templates" ], "parameters": [ { "name": "filename", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "reseller": { "type": "string", "description": "The reseller or territory the template file applies to.", "default": "*" }, "domain": { "type": "string", "description": "The domain the template file applies to.", "default": "*" }, "server": { "type": "string", "description": "The server the template file applies to.", "default": "*" } } }, "examples": {} } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "put": { "summary": "Update Template from Upload (JSON + Base64 File)", "deprecated": false, "description": "Update a template file", "operationId": "UpdateTemplateBase64", "tags": [ "Templates" ], "parameters": [ { "name": "filename", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "reseller": { "type": "string", "description": "The reseller or territory the template file applies to.", "default": "*" }, "domain": { "type": "string", "description": "The domain the template file applies to.", "default": "*" }, "server": { "type": "string", "description": "The server the template file applies to.", "default": "*" }, "description": { "type": "string", "description": "A description of the template file to indicate what it is used for" }, "filetype": { "type": "string", "description": "Encoding (content type) of the template file" }, "base64_file": { "type": "string", "description": "A base64 encoded string formatted without line breaks or spaces." } }, "required": [ "filetype", "base64_file" ] } } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] }, "examples": { "1": { "summary": "Success", "value": { "code": 202, "message": "Accepted" } }, "2": { "summary": "Success", "value": { "code": 202, "message": "Accepted" } }, "3": { "summary": "Exception", "value": { "code": 404, "message": "File does not exist." } } } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] }, "example": { "code": 400, "message": "Missing file information." } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] }, "example": { "code": 404, "message": "File does not exist." } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/timeframes": { "post": { "summary": "Create Always Timeframe", "deprecated": false, "description": "", "tags": [ "Timeframes/Domain (Shared)/Always" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "synchronous": { "$ref": "#/components/schemas/Synchronous" }, "timeframe-name": { "type": "string" }, "timeframe-type": { "$ref": "#/components/schemas/RecurringTimeframeType" } }, "required": [ "synchronous" ] }, "examples": {} } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecurringTimeframe" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "get": { "summary": "Read All Timeframes for Domain (Shared)", "deprecated": false, "description": "", "tags": [ "Timeframes/Domain (Shared)" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RecurringTimeframe" } } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/timeframes/{id}": { "post": { "summary": "Create Additional Date Ranges within Specific Dates Timeframe", "deprecated": false, "description": "When creating additional date ranges within a Specific Dates timeframe it is not necessary to supply a ```timeframe-id``` for the new date ranges. These ```timeframe-id```s will be generated automatically.", "tags": [ "Timeframes/Domain (Shared)/Specific Dates" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "id", "in": "path", "description": "```timeframe-id``` for the timeframe to modify", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "timeframe-specific-dates-array": { "type": "array", "items": { "$ref": "#/components/schemas/TimeframeSpecificDate" } }, "timeframe-days-of-week-array": { "type": "array", "items": { "$ref": "#/components/schemas/TimeframeDOW" } } } }, "examples": {} } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "put": { "summary": "Replace All Date Ranges in Specific Dates Timeframe", "deprecated": false, "description": "If a new array of specific date ranges is supplied in the update request for a Specific Dates timeframe, it will replace all existing specific date ranges in the timeframe, meaning that any existing specific date ranges in that timeframe will be removed. To update individual specific date ranges within a Specific Dates timeframe, refer to \"Update Date Ranges within Specific Dates Timeframe.\" It is not necessary to supply a ```timeframe-id``` for the new date ranges. These ```timeframe-id```s will be generated automatically.", "tags": [ "Timeframes/Domain (Shared)/Specific Dates" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "id", "in": "path", "description": "```timeframe-id``` of the timeframe to modify", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "timeframe-specific-dates-array": { "type": "array", "items": { "$ref": "#/components/schemas/TimeframeSpecificDate" } } } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "delete": { "summary": "Delete Date Range within Specific Dates Timeframe", "deprecated": false, "description": "In order to delete a date range within a Specific Dates timeframe, supply the ```timeframe-id``` of the particular range to be deleted as the parameter ```child_id``` within the request.", "tags": [ "Timeframes/Domain (Shared)/Specific Dates" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "id", "in": "path", "description": "```timeframe-id``` of the timeframe to modify", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "child_id": { "type": "string", "description": "The ```id``` of the date range you wish to delete within the timeframe." } }, "required": [ "child_id" ] } } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "get": { "summary": "Read Specific Timeframe for Domain (Shared)", "deprecated": false, "description": "", "tags": [ "Timeframes/Domain (Shared)" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "id", "in": "path", "description": "```timeframe-id``` of the timeframe to read", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/timeframes": { "post": { "summary": "Create Always Timeframe", "deprecated": false, "description": "", "tags": [ "Timeframes/User/Always" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "synchronous": { "$ref": "#/components/schemas/Synchronous" }, "timeframe-name": { "type": "string" }, "timeframe-type": { "$ref": "#/components/schemas/RecurringTimeframeType" } }, "required": [ "synchronous" ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "get": { "summary": "Read All Timeframes for User", "deprecated": false, "description": "", "tags": [ "Timeframes/User" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RecurringTimeframe" } } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/timeframes/{id}": { "post": { "summary": "Create Additional Date Ranges within Specific Dates Timeframe", "deprecated": false, "description": "When creating additional date ranges within a Specific Dates timeframe it is not necessary to supply a ```timeframe-id``` for the new date ranges. These ```timeframe-id```s will be generated automatically.", "tags": [ "Timeframes/User/Specific Dates" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "id", "in": "path", "description": "```timeframe-id``` for the timeframe to modify", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "timeframe-specific-dates-array": { "type": "array", "items": { "$ref": "#/components/schemas/TimeframeSpecificDate" } }, "timeframe-days-of-week-array": { "type": "array", "items": { "$ref": "#/components/schemas/TimeframeDOW" } } } } } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "put": { "summary": "Replace All Date Ranges in Specific Dates Timeframe", "deprecated": false, "description": "If a new array of specific date ranges is supplied in the update request for a Specific Dates timeframe, it will replace all existing specific date ranges in the timeframe, meaning that any existing specific date ranges in that timeframe will be removed. To update individual specific date ranges within a Specific Dates timeframe, refer to \"Update Date Ranges within Specific Dates Timeframe.\" It is not necessary to supply a ```timeframe-id``` for the new date ranges. These ```timeframe-id```s will be generated automatically.", "tags": [ "Timeframes/User/Specific Dates" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "id", "in": "path", "description": "```timeframe-id``` of the timeframe to modify", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "timeframe-specific-dates-array": { "type": "array", "items": { "$ref": "#/components/schemas/TimeframeSpecificDate" } } } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "delete": { "summary": "Delete Date Range within Specific Dates Timeframe", "deprecated": false, "description": "In order to delete a date range within a Specific Dates timeframe, supply the ```timeframe-id``` of the particular range to be deleted as the parameter ```child_id``` within the request.", "tags": [ "Timeframes/User/Specific Dates" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "id", "in": "path", "description": "```timeframe-id``` of the timeframe to modify", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "child_id": { "type": "string", "description": "The ```id``` of the date range you wish to delete within the timeframe." } }, "required": [ "child_id" ] } } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "get": { "summary": "Read Specific Timeframe for User", "deprecated": false, "description": "", "tags": [ "Timeframes/User" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "id", "in": "path", "description": "```timeframe-id``` of the timeframe to read", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/": { "delete": { "summary": "Delete All Timeframes for User", "deprecated": false, "description": "", "tags": [ "Timeframes/User" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/holidays/countries": { "get": { "summary": "Read List of Supported Countries", "deprecated": false, "description": "Retrieve a list of supported country codes to be used when reading holiday information.", "tags": [ "Timeframes/Holiday Information" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "country_name": { "type": "string" }, "iso-3166": { "type": "string" }, "total_holidays": { "type": "integer" }, "supported_languages": { "type": "integer" }, "uuid": { "type": "string" }, "flag_unicode": { "type": "string" } }, "required": [ "country_name", "iso-3166", "total_holidays", "supported_languages", "uuid", "flag_unicode" ] } }, "example": [ { "country_name": "Afghanistan", "iso-3166": "AF", "total_holidays": 24, "supported_languages": 2, "uuid": "f0357a3f154bc2ffe2bff55055457068", "flag_unicode": "🇦🇫" }, { "country_name": "Albania", "iso-3166": "AL", "total_holidays": 33, "supported_languages": 4, "uuid": "97282b278e5d51866f8e57204e4820e5", "flag_unicode": "🇦🇱" }, { "country_name": "Algeria", "iso-3166": "DZ", "total_holidays": 16, "supported_languages": 5, "uuid": "0de7b6a61a70688b26e6eeb3113531a3", "flag_unicode": "🇩🇿" }, { "country_name": "American Samoa", "iso-3166": "AS", "total_holidays": 17, "supported_languages": 2, "uuid": "f970e2767d0cfe75876ea857f92e319b", "flag_unicode": "🇦🇸" }, { "country_name": "Andorra", "iso-3166": "AD", "total_holidays": 28, "supported_languages": 4, "uuid": "523af537946b79c4f8369ed39ba78605", "flag_unicode": "🇦🇩" }, { "country_name": "Angola", "iso-3166": "AO", "total_holidays": 18, "supported_languages": 4, "uuid": "adac5e63f80f8629e9573527b25891d3", "flag_unicode": "🇦🇴" }, { "country_name": "Anguilla", "iso-3166": "AI", "total_holidays": 19, "supported_languages": 2, "uuid": "4921c0e2d1f6005abe1f9ec2e2041909", "flag_unicode": "🇦🇮" }, { "country_name": "Antigua and Barbuda", "iso-3166": "AG", "total_holidays": 15, "supported_languages": 2, "uuid": "4e42f7dd43ecbfe104de58610557c5ba", "flag_unicode": "🇦🇬" }, { "country_name": "Argentina", "iso-3166": "AR", "total_holidays": 41, "supported_languages": 3, "uuid": "c582dec943ff7b743aa0691df291cea6", "flag_unicode": "🇦🇷" }, { "country_name": "Armenia", "iso-3166": "AM", "total_holidays": 37, "supported_languages": 5, "uuid": "c04cd38aeb30f3ad1f8ab4e64a0ded7b", "flag_unicode": "🇦🇲" }, { "country_name": "Aruba", "iso-3166": "AW", "total_holidays": 15, "supported_languages": 3, "uuid": "b787d22d9cb06342658bf546039117bc", "flag_unicode": "🇦🇼" }, { "country_name": "Australia", "iso-3166": "AU", "total_holidays": 104, "supported_languages": 2, "uuid": "8bcc25c96aa5a71f7a76309077753e67", "flag_unicode": "🇦🇺" }, { "country_name": "Austria", "iso-3166": "AT", "total_holidays": 36, "supported_languages": 2, "uuid": "7d0db380a5b95a8ba1da0bca241abda1", "flag_unicode": "🇦🇹" }, { "country_name": "Azerbaijan", "iso-3166": "AZ", "total_holidays": 33, "supported_languages": 3, "uuid": "cc8c0a97c2dfcd73caff160b65aa39e2", "flag_unicode": "🇦🇿" }, { "country_name": "Bahrain", "iso-3166": "BH", "total_holidays": 21, "supported_languages": 4, "uuid": "c08bba7a0c0386f1551e8474d853ecbf", "flag_unicode": "🇧🇭" }, { "country_name": "Bangladesh", "iso-3166": "BD", "total_holidays": 63, "supported_languages": 4, "uuid": "c419b06b4c6579b50ff05adb3b8424f1", "flag_unicode": "🇧🇩" }, { "country_name": "Barbados", "iso-3166": "BB", "total_holidays": 25, "supported_languages": 3, "uuid": "21ad0bd836b90d08f4cf640b4c298e7c", "flag_unicode": "🇧🇧" }, { "country_name": "Belarus", "iso-3166": "BY", "total_holidays": 32, "supported_languages": 3, "uuid": "df3f079de6961496f0460dcfdbf9bca3", "flag_unicode": "🇧🇾" }, { "country_name": "Belgium", "iso-3166": "BE", "total_holidays": 32, "supported_languages": 4, "uuid": "910955a907e739b81ec8855763108a29", "flag_unicode": "🇧🇪" }, { "country_name": "Belize", "iso-3166": "BZ", "total_holidays": 19, "supported_languages": 2, "uuid": "b005ad12944422688084f19bf5e19729", "flag_unicode": "🇧🇿" }, { "country_name": "Benin", "iso-3166": "BJ", "total_holidays": 22, "supported_languages": 3, "uuid": "39b9df3a0fb3356d11a63e22260e96ab", "flag_unicode": "🇧🇯" }, { "country_name": "Bermuda", "iso-3166": "BM", "total_holidays": 23, "supported_languages": 3, "uuid": "084243855820f9ca47f466f645784636", "flag_unicode": "🇧🇲" }, { "country_name": "Bhutan", "iso-3166": "BT", "total_holidays": 26, "supported_languages": 2, "uuid": "6920626369b1f05844f5e3d6f93b5f6e", "flag_unicode": "🇧🇹" }, { "country_name": "Bolivia", "iso-3166": "BO", "total_holidays": 24, "supported_languages": 3, "uuid": "ad7532d5b3860a408fbe01f9455dca36", "flag_unicode": "🇧🇴" }, { "country_name": "Bosnia and Herzegovina", "iso-3166": "BA", "total_holidays": 38, "supported_languages": 7, "uuid": "07159c47ee1b19ae4fb9c40d480856c4", "flag_unicode": "🇧🇦" }, { "country_name": "Botswana", "iso-3166": "BW", "total_holidays": 21, "supported_languages": 2, "uuid": "823355b63ab3af0a0e4d1367e89abd1c", "flag_unicode": "🇧🇼" }, { "country_name": "Brazil", "iso-3166": "BR", "total_holidays": 29, "supported_languages": 4, "uuid": "dc634e2072827fe0b5be9a2063390544", "flag_unicode": "🇧🇷" }, { "country_name": "British Virgin Islands", "iso-3166": "VG", "total_holidays": 19, "supported_languages": 2, "uuid": "1815235d384d2912d4668c73298f1e52", "flag_unicode": "🇻🇬" }, { "country_name": "Brunei", "iso-3166": "BN", "total_holidays": 23, "supported_languages": 3, "uuid": "4e58188ff528dea1eec738fffc0e118d", "flag_unicode": "🇧🇳" }, { "country_name": "Bulgaria", "iso-3166": "BG", "total_holidays": 28, "supported_languages": 4, "uuid": "5523c88dd347d1b7cc617f632b7efdb7", "flag_unicode": "🇧🇬" }, { "country_name": "Burkina Faso", "iso-3166": "BF", "total_holidays": 18, "supported_languages": 3, "uuid": "c9f9d7dd806cf4122041837a80f47c64", "flag_unicode": "🇧🇫" }, { "country_name": "Burundi", "iso-3166": "BI", "total_holidays": 18, "supported_languages": 3, "uuid": "99d4fb3db1563c87da2cdfc0158b37c3", "flag_unicode": "🇧🇮" }, { "country_name": "Cabo Verde", "iso-3166": "CV", "total_holidays": 15, "supported_languages": 3, "uuid": "de3ec0aa2234aa1e3ee275bbc715c6c9", "flag_unicode": "🇨🇻" }, { "country_name": "Cambodia", "iso-3166": "KH", "total_holidays": 36, "supported_languages": 3, "uuid": "fa46ec0b4924e8c2194a53ef61b94039", "flag_unicode": "🇰🇭" }, { "country_name": "Cameroon", "iso-3166": "CM", "total_holidays": 18, "supported_languages": 4, "uuid": "820eb5b696ea2a657c0db1e258dc7d81", "flag_unicode": "🇨🇲" }, { "country_name": "Canada", "iso-3166": "CA", "total_holidays": 118, "supported_languages": 3, "uuid": "5435c69ed3bcc5b2e4d580e393e373d3", "flag_unicode": "🇨🇦" }, { "country_name": "Cayman Islands", "iso-3166": "KY", "total_holidays": 24, "supported_languages": 2, "uuid": "9e854e5865924fe3d61fe89d56220808", "flag_unicode": "🇰🇾" }, { "country_name": "Central African Republic", "iso-3166": "CF", "total_holidays": 18, "supported_languages": 3, "uuid": "4e29342d9904d64e9e25fd3b92558e2f", "flag_unicode": "🇨🇫" }, { "country_name": "Chad", "iso-3166": "TD", "total_holidays": 19, "supported_languages": 4, "uuid": "626726e60bd1215f36719a308a25b798", "flag_unicode": "🇹🇩" }, { "country_name": "Chile", "iso-3166": "CL", "total_holidays": 23, "supported_languages": 3, "uuid": "161747ec4dc9f55f1760195593742232", "flag_unicode": "🇨🇱" }, { "country_name": "China", "iso-3166": "CN", "total_holidays": 44, "supported_languages": 4, "uuid": "7efdfc94655a25dcea3ec85e9bb703fa", "flag_unicode": "🇨🇳" }, { "country_name": "Colombia", "iso-3166": "CO", "total_holidays": 38, "supported_languages": 3, "uuid": "ab6c040066603ef2519d512b21dce9ab", "flag_unicode": "🇨🇴" }, { "country_name": "Comoros", "iso-3166": "KM", "total_holidays": 17, "supported_languages": 4, "uuid": "9b05de73d43f8c4ec1110c6bcc5312bc", "flag_unicode": "🇰🇲" }, { "country_name": "Congo", "iso-3166": "CG", "total_holidays": 17, "supported_languages": 3, "uuid": "6e9cf3eef65da697796cf33f27eb0f57", "flag_unicode": "🇨🇬" }, { "country_name": "Congo Democratic Republic", "iso-3166": "CD", "total_holidays": 22, "supported_languages": 3, "uuid": "6865aeb3a9ed28f9a79ec454b259e5d0", "flag_unicode": "🇨🇩" }, { "country_name": "Cook Islands", "iso-3166": "CK", "total_holidays": 16, "supported_languages": 2, "uuid": "d5a5b3dd1ccb90d30360f0c068fd43fc", "flag_unicode": "🇨🇰" }, { "country_name": "Costa Rica", "iso-3166": "CR", "total_holidays": 23, "supported_languages": 3, "uuid": "324d8a1d3f81e730d5099a48cee0c5b6", "flag_unicode": "🇨🇷" }, { "country_name": "Cote d'Ivoire", "iso-3166": "CI", "total_holidays": 18, "supported_languages": 4, "uuid": "35ea51baf1fe7f0142ad5f950855dde0", "flag_unicode": "🇨🇮" }, { "country_name": "Croatia", "iso-3166": "HR", "total_holidays": 23, "supported_languages": 4, "uuid": "adab7b701f23bb82014c8506d3dc784e", "flag_unicode": "🇭🇷" }, { "country_name": "Cuba", "iso-3166": "CU", "total_holidays": 22, "supported_languages": 3, "uuid": "a4dbfd6aef3b4045fe61aa0146debdf8", "flag_unicode": "🇨🇺" }, { "country_name": "Curaçao", "iso-3166": "CW", "total_holidays": 18, "supported_languages": 3, "uuid": "0707ba092e91260b305c326e6a353593", "flag_unicode": "🇨🇼" }, { "country_name": "Cyprus", "iso-3166": "CY", "total_holidays": 26, "supported_languages": 5, "uuid": "471c1f3fc1dd7bb8cd0341b03e4be59e", "flag_unicode": "🇨🇾" }, { "country_name": "Czechia", "iso-3166": "CZ", "total_holidays": 32, "supported_languages": 3, "uuid": "9c049173fad5f4f89c68231237df85b8", "flag_unicode": "🇨🇿" }, { "country_name": "Denmark", "iso-3166": "DK", "total_holidays": 25, "supported_languages": 3, "uuid": "0ecbf9426bcfbd9a086ded5fc8c4eca8", "flag_unicode": "🇩🇰" }, { "country_name": "Djibouti", "iso-3166": "DJ", "total_holidays": 16, "supported_languages": 4, "uuid": "64ca60972a6ec926d1c4b9d31080c687", "flag_unicode": "🇩🇯" }, { "country_name": "Dominica", "iso-3166": "DM", "total_holidays": 19, "supported_languages": 2, "uuid": "608e7dc116de7157306012b4f0be82ac", "flag_unicode": "🇩🇲" }, { "country_name": "Dominican Republic", "iso-3166": "DO", "total_holidays": 21, "supported_languages": 3, "uuid": "d4579b2688d675235f402f6b4b43bcbf", "flag_unicode": "🇩🇴" }, { "country_name": "East Timor", "iso-3166": "TL", "total_holidays": 19, "supported_languages": 2, "uuid": "313a21d5badc6f5632238ebf8c7690f6", "flag_unicode": "🇹🇱" }, { "country_name": "Ecuador", "iso-3166": "EC", "total_holidays": 26, "supported_languages": 3, "uuid": "2f53e6f3f2acb041a4e0737e58c45321", "flag_unicode": "🇪🇨" }, { "country_name": "Egypt", "iso-3166": "EG", "total_holidays": 30, "supported_languages": 4, "uuid": "2a6a84e9e44441afbd75cc19ce28be37", "flag_unicode": "🇪🇬" }, { "country_name": "El Salvador", "iso-3166": "SV", "total_holidays": 29, "supported_languages": 3, "uuid": "743541121c12a113af807d1582c74bea", "flag_unicode": "🇸🇻" }, { "country_name": "Equatorial Guinea", "iso-3166": "GQ", "total_holidays": 19, "supported_languages": 3, "uuid": "b84a1ed8db3d3bf378f49becdea153b2", "flag_unicode": "🇬🇶" }, { "country_name": "Eritrea", "iso-3166": "ER", "total_holidays": 20, "supported_languages": 3, "uuid": "818f9c45cfa30eeff277ef38bcbe9910", "flag_unicode": "🇪🇷" }, { "country_name": "Estonia", "iso-3166": "EE", "total_holidays": 16, "supported_languages": 4, "uuid": "08a4415e9d594ff960030b921d42b91e", "flag_unicode": "🇪🇪" }, { "country_name": "Ethiopia", "iso-3166": "ET", "total_holidays": 17, "supported_languages": 3, "uuid": "4de1b7a4dc53e4a84c25ffb7cdb580ee", "flag_unicode": "🇪🇹" }, { "country_name": "Falkland Islands", "iso-3166": "FK", "total_holidays": 17, "supported_languages": 2, "uuid": "ef1cb6e72d149b184cc241037203f60b", "flag_unicode": "🇫🇰" }, { "country_name": "Faroe Islands", "iso-3166": "FO", "total_holidays": 23, "supported_languages": 3, "uuid": "eed807024939b808083f0031a56e9872", "flag_unicode": "🇫🇴" }, { "country_name": "Fiji", "iso-3166": "FJ", "total_holidays": 16, "supported_languages": 2, "uuid": "6fac3ab603bb3fb46e4277786393194c", "flag_unicode": "🇫🇯" }, { "country_name": "Finland", "iso-3166": "FI", "total_holidays": 23, "supported_languages": 5, "uuid": "75778bf8fde7266d416b0089e7b8b793", "flag_unicode": "🇫🇮" }, { "country_name": "France", "iso-3166": "FR", "total_holidays": 25, "supported_languages": 4, "uuid": "82a9e4d26595c87ab6e442391d8c5bba", "flag_unicode": "🇫🇷" }, { "country_name": "French Polynesia", "iso-3166": "PF", "total_holidays": 17, "supported_languages": 3, "uuid": "7287aa2c53d0a440da9db5614937e36f", "flag_unicode": "🇵🇫" }, { "country_name": "Gabon", "iso-3166": "GA", "total_holidays": 19, "supported_languages": 3, "uuid": "32d7508fe69220cb40af28441ef746d9", "flag_unicode": "🇬🇦" }, { "country_name": "Gambia", "iso-3166": "GM", "total_holidays": 19, "supported_languages": 2, "uuid": "92073d2fe26e543ce222cc0fb0b7d7a0", "flag_unicode": "🇬🇲" }, { "country_name": "Georgia", "iso-3166": "GE", "total_holidays": 25, "supported_languages": 4, "uuid": "0ba64a0dea00947916dfb6a66866e1ca", "flag_unicode": "🇬🇪" }, { "country_name": "Germany", "iso-3166": "DE", "total_holidays": 78, "supported_languages": 2, "uuid": "5f02f0889301fd7be1ac972c11bf3e7d", "flag_unicode": "🇩🇪" }, { "country_name": "Ghana", "iso-3166": "GH", "total_holidays": 26, "supported_languages": 3, "uuid": "19b19ffc30caef1c9376cd2982992a59", "flag_unicode": "🇬🇭" }, { "country_name": "Gibraltar", "iso-3166": "GI", "total_holidays": 26, "supported_languages": 4, "uuid": "28dd376c5a44acc92e450ee338260c56", "flag_unicode": "🇬🇮" }, { "country_name": "Greece", "iso-3166": "GR", "total_holidays": 24, "supported_languages": 4, "uuid": "d692bc40d83423d24d3a37582f58468c", "flag_unicode": "🇬🇷" }, { "country_name": "Greenland", "iso-3166": "GL", "total_holidays": 21, "supported_languages": 4, "uuid": "ce1d5a2480e0f4a2d1c1c7968cc66c13", "flag_unicode": "🇬🇱" }, { "country_name": "Grenada", "iso-3166": "GD", "total_holidays": 20, "supported_languages": 2, "uuid": "a6be8a33b7c987f4ffb76d9c9805c7eb", "flag_unicode": "🇬🇩" }, { "country_name": "Guam", "iso-3166": "GU", "total_holidays": 19, "supported_languages": 2, "uuid": "d2a460df08a4fb7a558f635b540d90cb", "flag_unicode": "🇬🇺" }, { "country_name": "Guatemala", "iso-3166": "GT", "total_holidays": 25, "supported_languages": 4, "uuid": "1bfad22f0925978f310a37440bfdff43", "flag_unicode": "🇬🇹" }, { "country_name": "Guernsey", "iso-3166": "GG", "total_holidays": 18, "supported_languages": 2, "uuid": "73c18c59a39b18382081ec00bb456d43", "flag_unicode": "🇬🇬" }, { "country_name": "Guinea", "iso-3166": "GN", "total_holidays": 16, "supported_languages": 3, "uuid": "5123dd8b087b644fdb8f8603acd1bad4", "flag_unicode": "🇬🇳" }, { "country_name": "Guinea-Bissau", "iso-3166": "GW", "total_holidays": 13, "supported_languages": 3, "uuid": "3f071f4f163d68551f4fc1544c7f69a6", "flag_unicode": "🇬🇼" }, { "country_name": "Guyana", "iso-3166": "GY", "total_holidays": 23, "supported_languages": 2, "uuid": "5e08be988691054c937b997b4cb6ad97", "flag_unicode": "🇬🇾" }, { "country_name": "Haiti", "iso-3166": "HT", "total_holidays": 23, "supported_languages": 4, "uuid": "eb5e48e74123cacc52761302ea4a7d22", "flag_unicode": "🇭🇹" }, { "country_name": "Honduras", "iso-3166": "HN", "total_holidays": 24, "supported_languages": 3, "uuid": "59ca4f8bbb9713c2eb59db115fcdb664", "flag_unicode": "🇭🇳" }, { "country_name": "Hong Kong", "iso-3166": "HK", "total_holidays": 30, "supported_languages": 3, "uuid": "ae4171856a75f7b67d51fc0e1f95902e", "flag_unicode": "🇭🇰" }, { "country_name": "Hungary", "iso-3166": "HU", "total_holidays": 26, "supported_languages": 4, "uuid": "18bd9197cb1d833bc352f47535c00320", "flag_unicode": "🇭🇺" }, { "country_name": "Iceland", "iso-3166": "IS", "total_holidays": 28, "supported_languages": 4, "uuid": "a2a551a6458a8de22446cc76d639a9e9", "flag_unicode": "🇮🇸" }, { "country_name": "India", "iso-3166": "IN", "total_holidays": 72, "supported_languages": 4, "uuid": "13b5bfe96f3e2fe411c9f66f4a582adf", "flag_unicode": "🇮🇳" }, { "country_name": "Indonesia", "iso-3166": "ID", "total_holidays": 35, "supported_languages": 4, "uuid": "b80bb7740288fda1f201890375a60c8f", "flag_unicode": "🇮🇩" }, { "country_name": "Iran", "iso-3166": "IR", "total_holidays": 26, "supported_languages": 3, "uuid": "d74eea4899a61f9fcbc527ef988ea0ff", "flag_unicode": "🇮🇷" }, { "country_name": "Iraq", "iso-3166": "IQ", "total_holidays": 25, "supported_languages": 4, "uuid": "795237fd9d107e63cd19b0db0f2fba2f", "flag_unicode": "🇮🇶" }, { "country_name": "Ireland", "iso-3166": "IE", "total_holidays": 17, "supported_languages": 4, "uuid": "25400724d7370b0b29c9369d9af3dd21", "flag_unicode": "🇮🇪" }, { "country_name": "Isle of Man", "iso-3166": "IM", "total_holidays": 16, "supported_languages": 2, "uuid": "73bebce395b6f1efedcf6842fbdb4d76", "flag_unicode": "🇮🇲" }, { "country_name": "Israel", "iso-3166": "IL", "total_holidays": 54, "supported_languages": 5, "uuid": "4605f628f91de21e4b5f9433f46e29eb", "flag_unicode": "🇮🇱" }, { "country_name": "Italy", "iso-3166": "IT", "total_holidays": 24, "supported_languages": 3, "uuid": "0d149b90e7394297301c90191ae775f0", "flag_unicode": "🇮🇹" }, { "country_name": "Jamaica", "iso-3166": "JM", "total_holidays": 20, "supported_languages": 4, "uuid": "3da770cc56ed4407b6aaf10ad4e72b4d", "flag_unicode": "🇯🇲" }, { "country_name": "Japan", "iso-3166": "JP", "total_holidays": 36, "supported_languages": 3, "uuid": "55add3d845bfcd87a9b0949b0da49c0a", "flag_unicode": "🇯🇵" }, { "country_name": "Jersey", "iso-3166": "JE", "total_holidays": 15, "supported_languages": 2, "uuid": "79563e90630af3525dff01b6638b0886", "flag_unicode": "🇯🇪" }, { "country_name": "Jordan", "iso-3166": "JO", "total_holidays": 29, "supported_languages": 4, "uuid": "674f33841e2309ffdd24c85dc3b999de", "flag_unicode": "🇯🇴" }, { "country_name": "Kazakhstan", "iso-3166": "KZ", "total_holidays": 26, "supported_languages": 5, "uuid": "9008f9e2758f08fe920b1765e72734d5", "flag_unicode": "🇰🇿" }, { "country_name": "Kenya", "iso-3166": "KE", "total_holidays": 22, "supported_languages": 4, "uuid": "25bc6654798eb508fa0b6343212a74fe", "flag_unicode": "🇰🇪" }, { "country_name": "Kiribati", "iso-3166": "KI", "total_holidays": 19, "supported_languages": 2, "uuid": "988287f7a1eb966ffc4e19bdbdeec7c3", "flag_unicode": "🇰🇮" }, { "country_name": "Kosovo", "iso-3166": "XK", "total_holidays": 30, "supported_languages": 5, "uuid": "a2d8fced03cb2e20ef8e1226935c9c92", "flag_unicode": "🇽🇰" }, { "country_name": "Kuwait", "iso-3166": "KW", "total_holidays": 19, "supported_languages": 4, "uuid": "048685d96262085442a1d5bb4a14bc3b", "flag_unicode": "🇰🇼" }, { "country_name": "Kyrgyzstan", "iso-3166": "KG", "total_holidays": 22, "supported_languages": 4, "uuid": "ebe86682666f2ab3da0843ed3097e4b3", "flag_unicode": "🇰🇬" }, { "country_name": "Laos", "iso-3166": "LA", "total_holidays": 22, "supported_languages": 2, "uuid": "c9089f3c9adaf0186f6ffb1ee8d6501c", "flag_unicode": "🇱🇦" }, { "country_name": "Latvia", "iso-3166": "LV", "total_holidays": 27, "supported_languages": 4, "uuid": "85d1a9c488d7117ea86291a755e5d43c", "flag_unicode": "🇱🇻" }, { "country_name": "Lebanon", "iso-3166": "LB", "total_holidays": 36, "supported_languages": 5, "uuid": "26403ec6d537fa31f63e294b44831734", "flag_unicode": "🇱🇧" }, { "country_name": "Lesotho", "iso-3166": "LS", "total_holidays": 15, "supported_languages": 2, "uuid": "44ba5ca65651b4f36f1927576dd35436", "flag_unicode": "🇱🇸" }, { "country_name": "Liberia", "iso-3166": "LR", "total_holidays": 17, "supported_languages": 3, "uuid": "58791f322c1bfc3de6141788d3b8666f", "flag_unicode": "🇱🇷" }, { "country_name": "Libya", "iso-3166": "LY", "total_holidays": 18, "supported_languages": 5, "uuid": "e728b47751c6555942cb60f97d1e4553", "flag_unicode": "🇱🇾" }, { "country_name": "Liechtenstein", "iso-3166": "LI", "total_holidays": 28, "supported_languages": 3, "uuid": "d70c1e5d44de8a9150eb91ecff563578", "flag_unicode": "🇱🇮" }, { "country_name": "Lithuania", "iso-3166": "LT", "total_holidays": 27, "supported_languages": 3, "uuid": "d91af6958918af87d6a057c1cdf5b225", "flag_unicode": "🇱🇹" }, { "country_name": "Luxembourg", "iso-3166": "LU", "total_holidays": 20, "supported_languages": 4, "uuid": "3e7e122bf08f48432c961ba491089dc9", "flag_unicode": "🇱🇺" }, { "country_name": "Macau", "iso-3166": "MO", "total_holidays": 33, "supported_languages": 4, "uuid": "27c9d5187cd283f8d160ec1ed2b5ac89", "flag_unicode": "🇲🇴" }, { "country_name": "Madagascar", "iso-3166": "MG", "total_holidays": 18, "supported_languages": 3, "uuid": "b351bb9b0af6e4fc678749675c53ad67", "flag_unicode": "🇲🇬" }, { "country_name": "Malawi", "iso-3166": "MW", "total_holidays": 19, "supported_languages": 2, "uuid": "38fed7107cee058098ca06304c1beb90", "flag_unicode": "🇲🇼" }, { "country_name": "Malaysia", "iso-3166": "MY", "total_holidays": 64, "supported_languages": 4, "uuid": "6864f389d9876436bc8778ff071d1b6c", "flag_unicode": "🇲🇾" }, { "country_name": "Maldives", "iso-3166": "MV", "total_holidays": 27, "supported_languages": 2, "uuid": "94d035945b3d82182669c4d3f6daa104", "flag_unicode": "🇲🇻" }, { "country_name": "Mali", "iso-3166": "ML", "total_holidays": 17, "supported_languages": 3, "uuid": "9830e1f81f623b33106acc186b93374e", "flag_unicode": "🇲🇱" }, { "country_name": "Malta", "iso-3166": "MT", "total_holidays": 21, "supported_languages": 4, "uuid": "710998fd1b7c0235170265650770a4b1", "flag_unicode": "🇲🇹" }, { "country_name": "Marshall Islands", "iso-3166": "MH", "total_holidays": 17, "supported_languages": 2, "uuid": "ed8f5b7e74398143b43a93dc753618ae", "flag_unicode": "🇲🇭" }, { "country_name": "Martinique", "iso-3166": "MQ", "total_holidays": 19, "supported_languages": 3, "uuid": "1d8a4975693ef1eb9ca54878098d608f", "flag_unicode": "🇲🇶" }, { "country_name": "Mauritania", "iso-3166": "MR", "total_holidays": 12, "supported_languages": 4, "uuid": "d9394066970e44ae252fd0347e58c03e", "flag_unicode": "🇲🇷" }, { "country_name": "Mauritius", "iso-3166": "MU", "total_holidays": 27, "supported_languages": 3, "uuid": "89aa4b196b48c8a13a6549bb1eaebd80", "flag_unicode": "🇲🇺" }, { "country_name": "Mayotte", "iso-3166": "YT", "total_holidays": 19, "supported_languages": 3, "uuid": "fa0ed5b5c600145bdd9a299952b99651", "flag_unicode": "🇾🇹" }, { "country_name": "Mexico", "iso-3166": "MX", "total_holidays": 45, "supported_languages": 3, "uuid": "3d26b0b17065c2cf29c06c010184c684", "flag_unicode": "🇲🇽" }, { "country_name": "Micronesia", "iso-3166": "FM", "total_holidays": 24, "supported_languages": 2, "uuid": "0ab34ca97d9946591bf89817789cb5de", "flag_unicode": "🇫🇲" }, { "country_name": "Moldova", "iso-3166": "MD", "total_holidays": 45, "supported_languages": 4, "uuid": "793914c9c583d9d86d0f4ed8c521b0c1", "flag_unicode": "🇲🇩" }, { "country_name": "Monaco", "iso-3166": "MC", "total_holidays": 24, "supported_languages": 3, "uuid": "d6fd0924e324f50669ae0295adf59567", "flag_unicode": "🇲🇨" }, { "country_name": "Mongolia", "iso-3166": "MN", "total_holidays": 31, "supported_languages": 3, "uuid": "412566367c67448b599d1b7666f8ccfc", "flag_unicode": "🇲🇳" }, { "country_name": "Montenegro", "iso-3166": "ME", "total_holidays": 33, "supported_languages": 4, "uuid": "ab86a1e1ef70dff97959067b723c5c24", "flag_unicode": "🇲🇪" }, { "country_name": "Montserrat", "iso-3166": "MS", "total_holidays": 16, "supported_languages": 2, "uuid": "ee33e909372d935d190f4fcb2a92d542", "flag_unicode": "🇲🇸" }, { "country_name": "Morocco", "iso-3166": "MA", "total_holidays": 23, "supported_languages": 4, "uuid": "b74df323e3939b563635a2cba7a7afba", "flag_unicode": "🇲🇦" }, { "country_name": "Mozambique", "iso-3166": "MZ", "total_holidays": 16, "supported_languages": 3, "uuid": "4f3dd0ffb3e41c5f74b5b0d8c1f10bb5", "flag_unicode": "🇲🇿" }, { "country_name": "Myanmar", "iso-3166": "MM", "total_holidays": 35, "supported_languages": 3, "uuid": "b3cd915d758008bd19d0f2428fbb354a", "flag_unicode": "🇲🇲" }, { "country_name": "Namibia", "iso-3166": "NA", "total_holidays": 18, "supported_languages": 3, "uuid": "6ec66e124fb93c190e9207b0b82f542a", "flag_unicode": "🇳🇦" }, { "country_name": "Nauru", "iso-3166": "NR", "total_holidays": 18, "supported_languages": 2, "uuid": "0ab3e5d0801aea3f3758bcbd812e8f10", "flag_unicode": "🇳🇷" }, { "country_name": "Nepal", "iso-3166": "NP", "total_holidays": 52, "supported_languages": 2, "uuid": "cf3fc916339b02ad9c14aca2425ccf53", "flag_unicode": "🇳🇵" }, { "country_name": "Netherlands", "iso-3166": "NL", "total_holidays": 21, "supported_languages": 3, "uuid": "1a13105b7e4eb5fb2e7c9515ac06aa48", "flag_unicode": "🇳🇱" }, { "country_name": "New Caledonia", "iso-3166": "NC", "total_holidays": 17, "supported_languages": 3, "uuid": "1e7342845e24eb3b5b3554490da1c128", "flag_unicode": "🇳🇨" }, { "country_name": "New Zealand", "iso-3166": "NZ", "total_holidays": 38, "supported_languages": 3, "uuid": "c97b334ffd41ea4997083f1949632bc1", "flag_unicode": "🇳🇿" }, { "country_name": "Nicaragua", "iso-3166": "NI", "total_holidays": 22, "supported_languages": 3, "uuid": "e6c151d449e1db05b1ffb5ad5ec656cf", "flag_unicode": "🇳🇮" }, { "country_name": "Niger", "iso-3166": "NE", "total_holidays": 18, "supported_languages": 3, "uuid": "d4f917633649a3c47c7ab917fa990146", "flag_unicode": "🇳🇪" }, { "country_name": "Nigeria", "iso-3166": "NG", "total_holidays": 36, "supported_languages": 3, "uuid": "66e10e9ff65ef479654dde3968d3440d", "flag_unicode": "🇳🇬" }, { "country_name": "North Korea", "iso-3166": "KP", "total_holidays": 21, "supported_languages": 3, "uuid": "26b568e4192a164d5b3eacdbd632bc2e", "flag_unicode": "🇰🇵" }, { "country_name": "North Macedonia", "iso-3166": "MK", "total_holidays": 46, "supported_languages": 4, "uuid": "07d935680b6501b2e42fe4baea021389", "flag_unicode": "🇲🇰" }, { "country_name": "Northern Mariana Islands", "iso-3166": "MP", "total_holidays": 20, "supported_languages": 2, "uuid": "1f2dfa567dcf95833eddf7aec167fec7", "flag_unicode": "🇲🇵" }, { "country_name": "Norway", "iso-3166": "NO", "total_holidays": 44, "supported_languages": 4, "uuid": "7fa3b767c460b54a2be4d49030b349c7", "flag_unicode": "🇳🇴" }, { "country_name": "Oman", "iso-3166": "OM", "total_holidays": 22, "supported_languages": 4, "uuid": "d58da82289939d8c4ec4f40689c2847e", "flag_unicode": "🇴🇲" }, { "country_name": "Pakistan", "iso-3166": "PK", "total_holidays": 55, "supported_languages": 4, "uuid": "1cd3c693132f4c31b5b5e5f4c5eed6bd", "flag_unicode": "🇵🇰" }, { "country_name": "Palau", "iso-3166": "PW", "total_holidays": 17, "supported_languages": 2, "uuid": "8fe4c11451281c094a6578e6ddbf5eed", "flag_unicode": "🇵🇼" }, { "country_name": "Panama", "iso-3166": "PA", "total_holidays": 28, "supported_languages": 3, "uuid": "e529a9cea4a728eb9c5828b13b22844c", "flag_unicode": "🇵🇦" }, { "country_name": "Papua New Guinea", "iso-3166": "PG", "total_holidays": 15, "supported_languages": 2, "uuid": "235ec52392b77977539cf78b62e708d3", "flag_unicode": "🇵🇬" }, { "country_name": "Paraguay", "iso-3166": "PY", "total_holidays": 20, "supported_languages": 3, "uuid": "dfed5bc177b87ab317c584e06566adc6", "flag_unicode": "🇵🇾" }, { "country_name": "Peru", "iso-3166": "PE", "total_holidays": 30, "supported_languages": 4, "uuid": "dd07de8561395a7c37f8fcc1752d45e1", "flag_unicode": "🇵🇪" }, { "country_name": "Philippines", "iso-3166": "PH", "total_holidays": 35, "supported_languages": 4, "uuid": "da984e42a5899bbdac496ef0cbadcee2", "flag_unicode": "🇵🇭" }, { "country_name": "Poland", "iso-3166": "PL", "total_holidays": 25, "supported_languages": 4, "uuid": "288404204e3d452229308317344a285d", "flag_unicode": "🇵🇱" }, { "country_name": "Portugal", "iso-3166": "PT", "total_holidays": 41, "supported_languages": 4, "uuid": "fc9fdf084e290f26a270390dc49061a2", "flag_unicode": "🇵🇹" }, { "country_name": "Puerto Rico", "iso-3166": "PR", "total_holidays": 30, "supported_languages": 3, "uuid": "64e1e1cbe1ca8e88ef3a838a3e7b57d6", "flag_unicode": "🇵🇷" }, { "country_name": "Qatar", "iso-3166": "QA", "total_holidays": 23, "supported_languages": 4, "uuid": "8264ee52f589f4c0191aa94f87aa1aeb", "flag_unicode": "🇶🇦" }, { "country_name": "Reunion", "iso-3166": "RE", "total_holidays": 16, "supported_languages": 3, "uuid": "12eccbdd9b32918131341f38907cbbb5", "flag_unicode": "🇷🇪" }, { "country_name": "Romania", "iso-3166": "RO", "total_holidays": 35, "supported_languages": 3, "uuid": "3605c251087b88216c9bca890e07ad9c", "flag_unicode": "🇷🇴" }, { "country_name": "Russia", "iso-3166": "RU", "total_holidays": 31, "supported_languages": 4, "uuid": "89484b14b36a8d5329426a3d944d2983", "flag_unicode": "🇷🇺" }, { "country_name": "Rwanda", "iso-3166": "RW", "total_holidays": 17, "supported_languages": 4, "uuid": "038c0dc8a958ffea17af047244fb6960", "flag_unicode": "🇷🇼" }, { "country_name": "Saint Helena", "iso-3166": "SH", "total_holidays": 14, "supported_languages": 2, "uuid": "77cbc257e66302866cf6191754c0c8e3", "flag_unicode": "🇸🇭" }, { "country_name": "Saint Kitts and Nevis", "iso-3166": "KN", "total_holidays": 16, "supported_languages": 2, "uuid": "8c7e6965b4169689a88b313bbe7450f9", "flag_unicode": "🇰🇳" }, { "country_name": "Saint Lucia", "iso-3166": "LC", "total_holidays": 17, "supported_languages": 2, "uuid": "196accbcf32b0a8e6bef92e1a37d0fc0", "flag_unicode": "🇱🇨" }, { "country_name": "Saint Martin", "iso-3166": "MF", "total_holidays": 19, "supported_languages": 3, "uuid": "ea81aa7df47d74c6737bf98fabf3ff82", "flag_unicode": "🇲🇫" }, { "country_name": "Saint Pierre and Miquelon", "iso-3166": "PM", "total_holidays": 17, "supported_languages": 3, "uuid": "5109d85d95fece7816d9704e6e5b1279", "flag_unicode": "🇵🇲" }, { "country_name": "Saint Vincent and the Grenadines", "iso-3166": "VC", "total_holidays": 16, "supported_languages": 2, "uuid": "c56e52594d4ebe7f6cb2b96c4637b486", "flag_unicode": "🇻🇨" }, { "country_name": "Samoa", "iso-3166": "WS", "total_holidays": 17, "supported_languages": 2, "uuid": "742523daef59db4b718409f46de05d0c", "flag_unicode": "🇼🇸" }, { "country_name": "San Marino", "iso-3166": "SM", "total_holidays": 28, "supported_languages": 4, "uuid": "ed79acb0cd3d7f8320c53c7798335ef0", "flag_unicode": "🇸🇲" }, { "country_name": "Sao Tome and Principe", "iso-3166": "ST", "total_holidays": 12, "supported_languages": 3, "uuid": "627fcdb6cc9a5e16d657ca6cdef0a6bb", "flag_unicode": "🇸🇹" }, { "country_name": "Saudi Arabia", "iso-3166": "SA", "total_holidays": 16, "supported_languages": 3, "uuid": "c12e01f2a13ff5587e1e9e4aedb8242d", "flag_unicode": "🇸🇦" }, { "country_name": "Senegal", "iso-3166": "SN", "total_holidays": 20, "supported_languages": 3, "uuid": "afbe94cdbe69a93efabc9f1325fc7dff", "flag_unicode": "🇸🇳" }, { "country_name": "Serbia", "iso-3166": "RS", "total_holidays": 23, "supported_languages": 5, "uuid": "3a2d7564baee79182ebc7b65084aabd1", "flag_unicode": "🇷🇸" }, { "country_name": "Seychelles", "iso-3166": "SC", "total_holidays": 19, "supported_languages": 3, "uuid": "d54185b71f614c30a396ac4bc44d3269", "flag_unicode": "🇸🇨" }, { "country_name": "Sierra Leone", "iso-3166": "SL", "total_holidays": 15, "supported_languages": 3, "uuid": "54a2bf8c09ace67d3513aaa1aa7aa0f3", "flag_unicode": "🇸🇱" }, { "country_name": "Singapore", "iso-3166": "SG", "total_holidays": 33, "supported_languages": 6, "uuid": "5dae429688af1c521ad87ac394192c6d", "flag_unicode": "🇸🇬" }, { "country_name": "Sint Maarten", "iso-3166": "SX", "total_holidays": 18, "supported_languages": 2, "uuid": "2c38b9e45cec1b324dde4e3d5b22c648", "flag_unicode": "🇸🇽" }, { "country_name": "Slovakia", "iso-3166": "SK", "total_holidays": 36, "supported_languages": 3, "uuid": "41d6ad0761a5d27a9e1bd567041ce9e9", "flag_unicode": "🇸🇰" }, { "country_name": "Slovenia", "iso-3166": "SI", "total_holidays": 23, "supported_languages": 3, "uuid": "ac5585d98646d255299c359140537783", "flag_unicode": "🇸🇮" }, { "country_name": "Solomon Islands", "iso-3166": "SB", "total_holidays": 31, "supported_languages": 2, "uuid": "26148d621ef74844918af182d63976b6", "flag_unicode": "🇸🇧" }, { "country_name": "Somalia", "iso-3166": "SO", "total_holidays": 16, "supported_languages": 5, "uuid": "b807023f87e63b8ada92f79f546ff9cc", "flag_unicode": "🇸🇴" }, { "country_name": "South Africa", "iso-3166": "ZA", "total_holidays": 41, "supported_languages": 4, "uuid": "959848ca10cc8a60da818ac11523dc63", "flag_unicode": "🇿🇦" }, { "country_name": "South Korea", "iso-3166": "KR", "total_holidays": 31, "supported_languages": 3, "uuid": "dcf0d7d2cd120bf42580d43f29785dd3", "flag_unicode": "🇰🇷" }, { "country_name": "South Sudan", "iso-3166": "SS", "total_holidays": 21, "supported_languages": 2, "uuid": "3691308f2a4c2f6983f2880d32e29c84", "flag_unicode": "🇸🇸" }, { "country_name": "Spain", "iso-3166": "ES", "total_holidays": 70, "supported_languages": 3, "uuid": "12470fe406d44017d96eab37dd65fc14", "flag_unicode": "🇪🇸" }, { "country_name": "Sri Lanka", "iso-3166": "LK", "total_holidays": 42, "supported_languages": 4, "uuid": "d0fa06cd93335c8cae357ffe5cd1c4e9", "flag_unicode": "🇱🇰" }, { "country_name": "St. Barts", "iso-3166": "BL", "total_holidays": 22, "supported_languages": 3, "uuid": "fd18772cbac19277b20dcccc1b90efb9", "flag_unicode": "🇧🇱" }, { "country_name": "Sudan", "iso-3166": "SD", "total_holidays": 19, "supported_languages": 3, "uuid": "6226f7cbe59e99a90b5cef6f94f966fd", "flag_unicode": "🇸🇩" }, { "country_name": "Suriname", "iso-3166": "SR", "total_holidays": 20, "supported_languages": 3, "uuid": "e22428ccf96cda9674a939c209ad1000", "flag_unicode": "🇸🇷" }, { "country_name": "Sweden", "iso-3166": "SE", "total_holidays": 34, "supported_languages": 4, "uuid": "efad7abb323e3d4016284c8a6da076a1", "flag_unicode": "🇸🇪" }, { "country_name": "Switzerland", "iso-3166": "CH", "total_holidays": 41, "supported_languages": 5, "uuid": "d88fc6edf21ea464d35ff76288b84103", "flag_unicode": "🇨🇭" }, { "country_name": "Syria", "iso-3166": "SY", "total_holidays": 21, "supported_languages": 4, "uuid": "1548af1c94ad45584324df8f08baf227", "flag_unicode": "🇸🇾" }, { "country_name": "Taiwan", "iso-3166": "TW", "total_holidays": 51, "supported_languages": 4, "uuid": "255a5cac7685572274d02f04c37be771", "flag_unicode": "🇹🇼" }, { "country_name": "Tajikistan", "iso-3166": "TJ", "total_holidays": 17, "supported_languages": 3, "uuid": "456c2e75fe0faa57fd1cfd87117e0963", "flag_unicode": "🇹🇯" }, { "country_name": "Tanzania", "iso-3166": "TZ", "total_holidays": 23, "supported_languages": 4, "uuid": "73bb4387b3075739eacb9cd62ac4049c", "flag_unicode": "🇹🇿" }, { "country_name": "Thailand", "iso-3166": "TH", "total_holidays": 43, "supported_languages": 4, "uuid": "1fdc0f893412ce55f0d2811821b84d3b", "flag_unicode": "🇹🇭" }, { "country_name": "The Bahamas", "iso-3166": "BS", "total_holidays": 24, "supported_languages": 3, "uuid": "7c9df801238abe28cae2675fd3166a1a", "flag_unicode": "🇧🇸" }, { "country_name": "Togo", "iso-3166": "TG", "total_holidays": 19, "supported_languages": 3, "uuid": "1f0eb0985870635e62fa2f68a223b173", "flag_unicode": "🇹🇬" }, { "country_name": "Tonga", "iso-3166": "TO", "total_holidays": 19, "supported_languages": 2, "uuid": "01b6e20344b68835c5ed1ddedf20d531", "flag_unicode": "🇹🇴" }, { "country_name": "Trinidad and Tobago", "iso-3166": "TT", "total_holidays": 27, "supported_languages": 5, "uuid": "accc9105df5383111407fd5b41255e23", "flag_unicode": "🇹🇹" }, { "country_name": "Tunisia", "iso-3166": "TN", "total_holidays": 19, "supported_languages": 5, "uuid": "aafb96b2fa8806be307c4496867bad56", "flag_unicode": "🇹🇳" }, { "country_name": "Turkey", "iso-3166": "TR", "total_holidays": 24, "supported_languages": 3, "uuid": "e7d707a26e7f7b6ff52c489c60e429b1", "flag_unicode": "🇹🇷" }, { "country_name": "Turkmenistan", "iso-3166": "TM", "total_holidays": 23, "supported_languages": 2, "uuid": "6a962563e235e1789e663e356ac8d9e4", "flag_unicode": "🇹🇲" }, { "country_name": "Turks and Caicos Islands", "iso-3166": "TC", "total_holidays": 18, "supported_languages": 2, "uuid": "5c4fefda27cfe84c3999be13e6b8608a", "flag_unicode": "🇹🇨" }, { "country_name": "Tuvalu", "iso-3166": "TV", "total_holidays": 17, "supported_languages": 2, "uuid": "c9a1fdac6e082dd89e7173244f34d7b3", "flag_unicode": "🇹🇻" }, { "country_name": "US Virgin Islands", "iso-3166": "VI", "total_holidays": 29, "supported_languages": 2, "uuid": "35b36b28916d38b34abddf832e286126", "flag_unicode": "🇻🇮" }, { "country_name": "Uganda", "iso-3166": "UG", "total_holidays": 21, "supported_languages": 3, "uuid": "2a0617accf8bb8625c43e2ffeb5b8d5b", "flag_unicode": "🇺🇬" }, { "country_name": "Ukraine", "iso-3166": "UA", "total_holidays": 37, "supported_languages": 5, "uuid": "5269f4d75f5bc75f0f94bab2100a5531", "flag_unicode": "🇺🇦" }, { "country_name": "United Arab Emirates", "iso-3166": "AE", "total_holidays": 23, "supported_languages": 4, "uuid": "b6bb43df4525b928a105fb5741bddbea", "flag_unicode": "🇦🇪" }, { "country_name": "United Kingdom", "iso-3166": "GB", "total_holidays": 95, "supported_languages": 2, "uuid": "7885444af42e4b30c518c5be17c8850b", "flag_unicode": "🇬🇧" }, { "country_name": "United States", "iso-3166": "US", "total_holidays": 418, "supported_languages": 7, "uuid": "0b3b97fa66886c5688ee4ae80ec0c3c2", "flag_unicode": "🇺🇸" }, { "country_name": "Uruguay", "iso-3166": "UY", "total_holidays": 25, "supported_languages": 3, "uuid": "1b23f8a4c97cc55f757ec2aae921f03d", "flag_unicode": "🇺🇾" }, { "country_name": "Uzbekistan", "iso-3166": "UZ", "total_holidays": 14, "supported_languages": 4, "uuid": "8b3274b755aa033902f57fb557e25923", "flag_unicode": "🇺🇿" }, { "country_name": "Vanuatu", "iso-3166": "VU", "total_holidays": 18, "supported_languages": 3, "uuid": "0730b75e96c0453b1b196be7ff4fa194", "flag_unicode": "🇻🇺" }, { "country_name": "Vatican City (Holy See)", "iso-3166": "VA", "total_holidays": 29, "supported_languages": 4, "uuid": "43b1cc1db7be63d899dd4280f578691a", "flag_unicode": "🇻🇦" }, { "country_name": "Venezuela", "iso-3166": "VE", "total_holidays": 42, "supported_languages": 3, "uuid": "eabb18f0a40c9b3552370c9e1bc1d61e", "flag_unicode": "🇻🇪" }, { "country_name": "Vietnam", "iso-3166": "VN", "total_holidays": 32, "supported_languages": 4, "uuid": "5e9c52c6d618881e7d9d62a294c4979c", "flag_unicode": "🇻🇳" }, { "country_name": "Wallis and Futuna", "iso-3166": "WF", "total_holidays": 16, "supported_languages": 3, "uuid": "c1b291cb8522236e421731b509c9fcdd", "flag_unicode": "🇼🇫" }, { "country_name": "Yemen", "iso-3166": "YE", "total_holidays": 22, "supported_languages": 4, "uuid": "00c66f1a036bd8f9cb709cb8d925d3d9", "flag_unicode": "🇾🇪" }, { "country_name": "Zambia", "iso-3166": "ZM", "total_holidays": 22, "supported_languages": 2, "uuid": "d9c2967765305ff512a5ab979ed1f7a0", "flag_unicode": "🇿🇲" }, { "country_name": "Zimbabwe", "iso-3166": "ZW", "total_holidays": 22, "supported_languages": 2, "uuid": "a1555463c361e7036a274a8b44e29192", "flag_unicode": "🇿🇼" }, { "country_name": "eSwatini", "iso-3166": "SZ", "total_holidays": 17, "supported_languages": 2, "uuid": "7dabf5c198b0bab2eaa42bb03a113e55", "flag_unicode": "🇸🇿" } ] } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/holidays/regions": { "get": { "summary": "Read List of Supported Regions", "deprecated": false, "description": "Retrieve a list of supported region codes by country, to be used when reading holiday information.", "tags": [ "Timeframes/Holiday Information" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": { "US": { "US-AL": "Alabama", "US-AK": "Alaska", "US-AZ": "Arizona", "US-AR": "Arkansas", "US-CA": "California", "US-CO": "Colorado", "US-CT": "Connecticut", "US-DE": "Delaware", "US-FL": "Florida", "US-GA": "Georgia", "US-HI": "Hawaii", "US-ID": "Idaho", "US-IL": "Illinois", "US-IN": "Indiana", "US-IA": "Iowa", "US-KS": "Kansas", "US-KY": "Kentucky", "US-LA": "Louisiana", "US-ME": "Maine", "US-MD": "Maryland", "US-MA": "Massachusetts", "US-MI": "Michigan", "US-MN": "Minnesota", "US-MS": "Mississippi", "US-MO": "Missouri", "US-MT": "Montana", "US-NE": "Nebraska", "US-NV": "Nevada", "US-NH": "New Hampshire", "US-NJ": "New Jersey", "US-NM": "New Mexico", "US-NY": "New York", "US-NC": "North Carolina", "US-ND": "North Dakota", "US-OH": "Ohio", "US-OK": "Oklahoma", "US-OR": "Oregon", "US-PA": "Pennsylvania", "US-RI": "Rhode Island", "US-SC": "South Carolina", "US-SD": "South Dakota", "US-TN": "Tennessee", "US-TX": "Texas", "US-UT": "Utah", "US-VT": "Vermont", "US-VA": "Virginia", "US-WA": "Washington", "US-WV": "West Virginia", "US-WI": "Wisconsin", "US-WY": "Wyoming", "US-DC": "District of Columbia" }, "CA": { "CA-AB": "Alberta", "CA-BC": "British Columbia", "CA-MB": "Manitoba", "CA-NB": "New Brunswick", "CA-NL": "Newfoundland and Labrador", "CA-NT": "Northwest Territories", "CA-NS": "Nova Scotia", "CA-NU": "Nunavut", "CA-ON": "Ontario", "CA-PE": "Prince Edward Island", "CA-QC": "Quebec", "CA-SK": "Saskatchewan", "CA-YT": "Yukon" }, "MX": { "MX-AGU": "Aguascalientes", "MX-BCN": "Baja California", "MX-BCS": "Baja California Sur", "MX-CAM": "Campeche", "MX-CMX": "Ciudad de México", "MX-COA": "Coahuila de Zaragoza", "MX-COL": "Colima", "MX-CHP": "Chiapas", "MX-CHH": "Chihuahua", "MX-DUR": "Durango", "MX-GUA": "Guanajuato", "MX-GRO": "Guerrero", "MX-HID": "Hidalgo", "MX-JAL": "Jalisco", "MX-MEX": "México", "MX-MIC": "Michoacán de Ocampo", "MX-MOR": "Morelos", "MX-NAY": "Nayarit", "MX-NLE": "Nuevo León", "MX-OAX": "Oaxaca", "MX-PUE": "Puebla", "MX-QUE": "Querétaro", "MX-ROO": "Quintana Roo", "MX-SLP": "San Luis Potosí", "MX-SIN": "Sinaloa", "MX-SON": "Sonora", "MX-TAB": "Tabasco", "MX-TAM": "Tamaulipas", "MX-TLA": "Tlaxcala", "MX-VER": "Veracruz de Ignacio de la Llave", "MX-YUC": "Yucatán", "MX-ZAC": "Zacatecas" } } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/holidays/{country}/{year}": { "get": { "summary": "Read Holiday Information by Country", "deprecated": false, "description": "In order to create holidays in a Holiday timeframe or a Custom timeframe, it is necessary to supply a series of parameters for each holiday that can be obtained via this endpoint.", "tags": [ "Timeframes/Holiday Information" ], "parameters": [ { "name": "country", "in": "path", "description": "The country from which to read holidays - format: ISO-3166 A-2", "required": true, "schema": { "type": "string" } }, { "name": "year", "in": "path", "description": "The year in which to read holidays - format: YYYY", "required": true, "schema": { "type": "string" } }, { "name": "language", "in": "query", "description": "Language formatted according to ISO 639-1", "required": false, "example": "", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": {} } }, "example": [ { "uuid": "c7ceeccbead419df7dbd82f7f213162d", "name": "New Year's Day", "description": "New Year's Day is the first day of the Gregorian calendar, which is widely used in many countries such as the USA.", "country": "us", "date": 20400101, "type": [ "National holiday" ], "primary_type": "Federal Holiday", "locations": "All", "states": "All" }, { "uuid": "c7ceeccbead419df7dbd82f7f213162d", "name": "New Year's Day", "description": "New Year's Day is the first day of the Gregorian calendar, which is widely used in many countries such as the USA.", "country": "us", "date": 20400101, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "MA, MS, NY, WI", "states": [ "us-ma", "us-ms", "us-ny", "us-wi" ] }, { "uuid": "c7ceeccbead419df7dbd82f7f213162d", "name": "New Year's Day", "description": "New Year's Day is the first day of the Gregorian calendar, which is widely used in many countries such as the USA.", "country": "us", "date": 20400101, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "TX", "states": [ "us-tx" ] }, { "uuid": "c7ceeccbead419df7dbd82f7f213162d", "name": "New Year's Day", "description": "New Year's Day is the first day of the Gregorian calendar, which is widely used in many countries such as the USA.", "country": "us", "date": 20400101, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "RI", "states": [ "us-ri" ] }, { "uuid": "c7ceeccbead419df7dbd82f7f213162d", "name": "New Year's Day", "description": "New Year's Day is the first day of the Gregorian calendar, which is widely used in many countries such as the USA.", "country": "us", "date": 20400101, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "All except MA, MS, NY, RI, TX, WI", "states": [ "us-al", "us-ak", "us-az", "us-ar", "us-ca", "us-co", "us-ct", "us-fl", "us-de", "us-dc", "us-ga", "us-hi", "us-id", "us-il", "us-in", "us-ia", "us-ks", "us-ky", "us-la", "us-md", "us-me", "us-mi", "us-mn", "us-mo", "us-mt", "us-ne", "us-nv", "us-nj", "us-nh", "us-nm", "us-nc", "us-nd", "us-oh", "us-ok", "us-or", "us-pa", "us-sc", "us-sd", "us-tn", "us-ut", "us-vt", "us-va", "us-wa", "us-wv", "us-wy" ] }, { "uuid": "c7ceeccbead419df7dbd82f7f213162d", "name": "New Year's Day (substitute)", "description": "New Year's Day is the first day of the Gregorian calendar, which is widely used in many countries such as the USA.", "country": "us", "date": 20400102, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "RI", "states": [ "us-ri" ] }, { "uuid": "c7ceeccbead419df7dbd82f7f213162d", "name": "New Year's Day (substitute)", "description": "New Year's Day is the first day of the Gregorian calendar, which is widely used in many countries such as the USA.", "country": "us", "date": 20400102, "type": [ "National holiday" ], "primary_type": "Federal Holiday", "locations": "All", "states": "All" }, { "uuid": "c7ceeccbead419df7dbd82f7f213162d", "name": "New Year's Day (substitute)", "description": "New Year's Day is the first day of the Gregorian calendar, which is widely used in many countries such as the USA.", "country": "us", "date": 20400102, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "MA, MS, NY, WI", "states": [ "us-ma", "us-ms", "us-ny", "us-wi" ] }, { "uuid": "c7ceeccbead419df7dbd82f7f213162d", "name": "New Year's Day (substitute)", "description": "New Year's Day is the first day of the Gregorian calendar, which is widely used in many countries such as the USA.", "country": "us", "date": 20400102, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "All except MA, MS, NY, RI, TX, WI", "states": [ "us-al", "us-ak", "us-az", "us-ar", "us-ca", "us-co", "us-ct", "us-fl", "us-de", "us-dc", "us-ga", "us-hi", "us-id", "us-il", "us-in", "us-ia", "us-ks", "us-ky", "us-la", "us-md", "us-me", "us-mi", "us-mn", "us-mo", "us-mt", "us-ne", "us-nv", "us-nj", "us-nh", "us-nm", "us-nc", "us-nd", "us-oh", "us-ok", "us-or", "us-pa", "us-sc", "us-sd", "us-tn", "us-ut", "us-vt", "us-va", "us-wa", "us-wv", "us-wy" ] }, { "uuid": "0f1c517efbd1f00188cbc735494fe054", "name": "World Braille Day", "description": "World Braille Day celebrates the life and achievements of Louis Braille, who invented the braille code for the visually impaired.", "country": "us", "date": 20400104, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "8ef4c82bb8f36c34598c7f84d7c3de63", "name": "Epiphany", "description": "Many people in the United States annually observe Epiphany, or Three Kings’ Day, on January 6. It is a Christian observance and a public holiday in the US Virgin Islands.", "country": "us", "date": 20400106, "type": [ "Christian" ], "primary_type": "Christian", "locations": "All", "states": "All" }, { "uuid": "87b398137d56f27708c2a1889bf00542", "name": "Orthodox Christmas Day", "description": "Many Orthodox Christian churches in countries such as the United States observe Christmas Day on or near January 7 in the Gregorian calendar.", "country": "us", "date": 20400107, "type": [ "Orthodox" ], "primary_type": "Orthodox", "locations": "All", "states": "All" }, { "uuid": "fb03de8e2d2ad6a948f0e9b9cae9c955", "name": "International Programmers' Day", "description": "Many people celebrate International Programmers’ Day on January 7, while others observe this event on the 256th day of the year, usually on September 13 or on September 12 in leap years.", "country": "us", "date": 20400107, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "23955fdefc5cee648b00e04582a8d18c", "name": "Estelle Reel Day", "description": "Estelle Reel Day is a state observance in the USA", "country": "us", "date": 20400107, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "WY", "states": [ "us-wy" ] }, { "uuid": "f39e782ebce1fdd3936bc0c916b6201d", "name": "Battle of New Orleans", "description": "Battle of New Orleans is a state legal holiday in the USA", "country": "us", "date": 20400108, "type": [ "Local observance" ], "primary_type": "State Legal Holiday", "locations": "LA", "states": [ "us-la" ] }, { "uuid": "665c152272d175232dd08ef4c1fb32f8", "name": "Friday the 13th", "description": "Friday the 13th is a day full of superstitious beliefs in communities worldwide.", "country": "us", "date": 20400113, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "46ff4a6a6d3fb649bc0ed01a08951795", "name": "Stephen Foster Memorial Day", "description": "Stephen Foster Memorial Day is annually observed in the United States on January 13. The day remembers the achievements of Stephen Foster, who is known as the “father of American music”.", "country": "us", "date": 20400113, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "0d8a4641ee056e9daf3c2e0dfc4e4aef", "name": "Orthodox New Year", "description": "Many Orthodox Christian churches in countries such as the United States celebrate New Year’s Day on January 14 in the Gregorian calendar.", "country": "us", "date": 20400114, "type": [ "Orthodox" ], "primary_type": "Orthodox", "locations": "All", "states": "All" }, { "uuid": "27b0805621a4b2526e412fb13518e74f", "name": "World Religion Day", "description": "World Religion Day fosters interfaith dialogue and understanding of all religions.", "country": "us", "date": 20400115, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "43c8758a146176457ac68e28dd54f246", "name": "Muharram", "description": "The first day of Muharram, which is the first month in the Islamic calendar, marks the start of the Islamic New Year.", "country": "us", "date": 20400116, "type": [ "Muslim" ], "primary_type": "Muslim", "locations": "All", "states": "All" }, { "uuid": "1e7dabcd1fd349828dc111290e99225d", "name": "Martin Luther King Jr. Day", "description": "Martin Luther King Day marks the anniversary of the date of birth of the influential American civil right leader of the same name.", "country": "us", "date": 20400116, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "All", "states": [ "us-al", "us-ak", "us-az", "us-ar", "us-ca", "us-co", "us-ct", "us-fl", "us-de", "us-dc", "us-ga", "us-hi", "us-id", "us-il", "us-in", "us-ia", "us-ks", "us-ky", "us-la", "us-ma", "us-me", "us-md", "us-mi", "us-mn", "us-mo", "us-ms", "us-mt", "us-ne", "us-nh", "us-nv", "us-nj", "us-nm", "us-nc", "us-ny", "us-nd", "us-oh", "us-ok", "us-or", "us-pa", "us-ri", "us-sc", "us-sd", "us-tn", "us-tx", "us-ut", "us-vt", "us-va", "us-wa", "us-wv", "us-wy", "us-wi" ] }, { "uuid": "1e7dabcd1fd349828dc111290e99225d", "name": "Martin Luther King Jr. Day", "description": "Martin Luther King Day marks the anniversary of the date of birth of the influential American civil right leader of the same name.", "country": "us", "date": 20400116, "type": [ "National holiday" ], "primary_type": "Federal Holiday", "locations": "All", "states": "All" }, { "uuid": "7056b3c7e3395d198fb31dc0bdb73004", "name": "Robert E. Lee's Birthday", "description": "Robert E. Lee’s birthday is an annual official state holiday that is shared with Martin Luther King’s birthday in some parts of the US.", "country": "us", "date": 20400116, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "MS", "states": [ "us-ms" ] }, { "uuid": "7056b3c7e3395d198fb31dc0bdb73004", "name": "Robert E. Lee's Birthday", "description": "Robert E. Lee’s birthday is an annual official state holiday that is shared with Martin Luther King’s birthday in some parts of the US.", "country": "us", "date": 20400116, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "AL", "states": [ "us-al" ] }, { "uuid": "a5226e5c0da8a0d6af6a2dd5b57df0cf", "name": "Idaho Human Rights Day", "description": "Idaho Human Rights Day is a state holiday in Idaho, the United States, on the third Monday of January.", "country": "us", "date": 20400116, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "ID", "states": [ "us-id" ] }, { "uuid": "3acafcd24f7d9d9c39bbb907b2c2727f", "name": "Civil Rights Day", "description": "Civil Rights Day is on the third Monday of January in Arizona and New Hampshire. It honors civil rights activists such as Martin Luther King Jr.", "country": "us", "date": 20400116, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "AZ", "states": [ "us-az" ] }, { "uuid": "3acafcd24f7d9d9c39bbb907b2c2727f", "name": "Civil Rights Day", "description": "Civil Rights Day is on the third Monday of January in Arizona and New Hampshire. It honors civil rights activists such as Martin Luther King Jr.", "country": "us", "date": 20400116, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "NH", "states": [ "us-nh" ] }, { "uuid": "7056b3c7e3395d198fb31dc0bdb73004", "name": "Robert E. Lee's Birthday", "description": "Robert E. Lee’s birthday is an annual official state holiday that is shared with Martin Luther King’s birthday in some parts of the US.", "country": "us", "date": 20400119, "type": [ "Local observance" ], "primary_type": "State Legal Holiday", "locations": "FL", "states": [ "us-fl" ] }, { "uuid": "51b63887bae0c56a37fe351c71ca13f2", "name": "Confederate Heroes' Day", "description": "On Confederate Memorial Day remembers the soldiers who died fighting for the Confederate States of America during the American Civil War (1861-1865). It is a state holiday in some parts of the United States.", "country": "us", "date": 20400119, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "TX", "states": [ "us-tx" ] }, { "uuid": "2d7ba967dfe02bf3fd05e7ad7f6eaac8", "name": "International Day of Education", "description": "International Day of Education is a United Nations observance in the USA", "country": "us", "date": 20400124, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "64ec6edf1edf9e29e5c9ff8113991e0c", "name": "Ashura", "description": "Ashura is a Muslim in the USA", "country": "us", "date": 20400125, "type": [ "Muslim" ], "primary_type": "Muslim", "locations": "All", "states": "All" }, { "uuid": "15d3e7ef3b87bc969888a19a64a8e4f4", "name": "International Customs Day", "description": "International Customs Day celebrates custom personnel and agencies worldwide.", "country": "us", "date": 20400126, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "6b443d4b2ed9e79174b494fd608f62b9", "name": "International Day of Commemoration in Memory of the Victims of the Holocaust", "description": "The United Nations' (UN) International Day of Commemoration in Memory of the Victims of the Holocaust remembers those who died and suffered during the Holocaust before and during World War II. It is on January 27 each year.", "country": "us", "date": 20400127, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "bf0133ef3050230e9d27721ac1fae0c4", "name": "World Leprosy Day", "description": "World Leprosy Day brings awareness of leprosy, also known as Hansen's disease, and ways to prevent the disease.", "country": "us", "date": 20400129, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "7cdbaf9409f47b9f479f6bbcbfb990a1", "name": "Kansas Day", "description": "Kansas Day is an annual observance that commemorates the state's admission to the Union in 1861.", "country": "us", "date": 20400129, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "KS", "states": [ "us-ks" ] }, { "uuid": "23a6b27a4c41f4f62ed640db4d04d53b", "name": "Tu Bishvat/Tu B'Shevat", "description": "Tu B’Shevat, known as the “New Year for Trees”, is a Jewish festival similar to Arbor Day.", "country": "us", "date": 20400130, "type": [ "Hebrew" ], "primary_type": "Jewish holiday", "locations": "All", "states": "All" }, { "uuid": "e9e5c6a8d2cd5529c1014887bd6c2836", "name": "National Freedom Day", "description": "National Freedom Day in the United States is observed on February 1 each year.", "country": "us", "date": 20400201, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "3a4a5f3d76e8cf61bb5b954ab254e584", "name": "National Girls and Women in Sports Day", "description": "National Girls and Women in Sports Day is a observance in the USA", "country": "us", "date": 20400201, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "8d5f9a7ebe4775a286da701b6b82cbd2", "name": "First Day of Black History Month", "description": "First Day of Black History Month is a annual monthly observance in the USA", "country": "us", "date": 20400201, "type": [ "Observance" ], "primary_type": "Annual Monthly Observance", "locations": "All", "states": "All" }, { "uuid": "cb10d6664b97807899caddda8be90c8c", "name": "World Wetlands Day", "description": "World Wetlands Day raises awareness about the important role that the wetlands play in the environment and in our lives.", "country": "us", "date": 20400202, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "32d256bf335f157f224055f404c1274c", "name": "Groundhog Day", "description": "Many people in the United States observe Groundhog Day on February 2.", "country": "us", "date": 20400202, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "b60d2343a93474640b18524a86162390", "name": "Lunar New Year", "description": "Lunar New Year marks the first day of the New Year in the Chinese calendar.", "country": "us", "date": 20400203, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "CO", "states": [ "us-co" ] }, { "uuid": "c67421b4b4147727b3e4edeea9b4d779", "name": "National Wear Red Day", "description": "National Wear Red Day® raises public awareness of heart disease in women and ways to avoid and combat this problem.", "country": "us", "date": 20400203, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "699e6b9f877ba7c628aad8146877d1ea", "name": "International Day of Human Fraternity", "description": "International Day of Human Fraternity is a United Nations observance in the USA", "country": "us", "date": 20400204, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "a2613fab2d1800d30eb6a62e083c9ea5", "name": "World Cancer Day", "description": "World Cancer Day is an annual global event on February 4 to raise people’s awareness of cancer.", "country": "us", "date": 20400204, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "e398c79dbb022098a3cf13d43d8faa5a", "name": "Rosa Parks Day", "description": "The life of American civil rights leader Rosa Parks is celebrated in the United States on either February 4 or December 1.", "country": "us", "date": 20400204, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "NY", "states": [ "us-ny" ] }, { "uuid": "e398c79dbb022098a3cf13d43d8faa5a", "name": "Rosa Parks Day", "description": "The life of American civil rights leader Rosa Parks is celebrated in the United States on either February 4 or December 1.", "country": "us", "date": 20400204, "type": [ "Local observance" ], "primary_type": "Local observance", "locations": "MO", "states": [ "us-mo" ] }, { "uuid": "e398c79dbb022098a3cf13d43d8faa5a", "name": "Rosa Parks Day", "description": "The life of American civil rights leader Rosa Parks is celebrated in the United States on either February 4 or December 1.", "country": "us", "date": 20400204, "type": [ "Local observance" ], "primary_type": "Local observance", "locations": "CA", "states": [ "us-ca" ] }, { "uuid": "dc71f474fd6c74a9d7a9dfedd8310e10", "name": "International Day of Zero Tolerance for Female Genital Mutilation", "description": "The International Day of Zero Tolerance for Female Genital Mutilation is an awareness campaign to end a harmful practice that violates girls’ and women’s rights.", "country": "us", "date": 20400206, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "23e356faabe19cd285ed45f48c3a99be", "name": "Ronald Reagan Day", "description": "Ronald Reagan Day is a state observance in the USA", "country": "us", "date": 20400206, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "CA", "states": [ "us-ca" ] }, { "uuid": "958a38db1a5638269429acac65499b0a", "name": "World Pulses Day", "description": "World Pulses Day is a United Nations observance in the USA", "country": "us", "date": 20400210, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "97f62a16075dd4d3514620c9c979ccfe", "name": "International Day of Women and Girls in Science", "description": "The International Day of Women and Girls in Science is a UN holiday to recognize the critical role women and girls play in science and technology communities.", "country": "us", "date": 20400211, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "9029ee00d6bc7f0c142196ba30bf2531", "name": "World Day of the Sick", "description": "World Day of the Sick is a global event when people remember or pray for the sick.", "country": "us", "date": 20400211, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "49e5468df04dbe5abe08cf4c949d3462", "name": "Lincoln's Birthday", "description": "Lincoln’s Birthday is observed in the United States in honor of Abraham Lincoln, who was the nation’s 16th president and was known as the Great Emancipator.", "country": "us", "date": 20400212, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "CT, IL, NY, MO", "states": [ "us-ct", "us-il", "us-ny", "us-mo" ] }, { "uuid": "49e5468df04dbe5abe08cf4c949d3462", "name": "Lincoln's Birthday", "description": "Lincoln’s Birthday is observed in the United States in honor of Abraham Lincoln, who was the nation’s 16th president and was known as the Great Emancipator.", "country": "us", "date": 20400212, "type": [ "Local observance" ], "primary_type": "State Legal Holiday", "locations": "FL", "states": [ "us-fl" ] }, { "uuid": "dcfb91bf1ed480cdcd561a1dd6d74376", "name": "Georgia Day", "description": "Georgia Day is a state observance in the USA", "country": "us", "date": 20400212, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "GA", "states": [ "us-ga" ] }, { "uuid": "b60d2343a93474640b18524a86162390", "name": "Lunar New Year", "description": "Lunar New Year marks the first day of the New Year in the Chinese calendar.", "country": "us", "date": 20400212, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "WA", "states": [ "us-wa" ] }, { "uuid": "b60d2343a93474640b18524a86162390", "name": "Lunar New Year", "description": "Lunar New Year marks the first day of the New Year in the Chinese calendar.", "country": "us", "date": 20400212, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "CA", "states": [ "us-ca" ] }, { "uuid": "b60d2343a93474640b18524a86162390", "name": "Lunar New Year", "description": "Lunar New Year marks the first day of the New Year in the Chinese calendar.", "country": "us", "date": 20400212, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "d5cbb7ac3bbcc38a6b0303094720a3b1", "name": "Super Bowl", "description": "The Super Bowl is the championship game of the National Football League (NFL) in the United States. It is played every year in February.", "country": "us", "date": 20400212, "type": [ "Sporting event" ], "primary_type": "Sporting event", "locations": "All", "states": "All" }, { "uuid": "c49ffadc49c895f785de5b8acd68ab38", "name": "World Radio Day", "description": "World Radio Day is an annual United Nations (UN) event that promotes the importance of the radio in communicating information worldwide.", "country": "us", "date": 20400213, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "49e5468df04dbe5abe08cf4c949d3462", "name": "Lincoln's Birthday observed", "description": "Lincoln’s Birthday is observed in the United States in honor of Abraham Lincoln, who was the nation’s 16th president and was known as the Great Emancipator.", "country": "us", "date": 20400213, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "CT, IL, NY, MO", "states": [ "us-ct", "us-il", "us-ny", "us-mo" ] }, { "uuid": "7bf73c3771fd6395022e50eb52df622e", "name": "Valentine's Day", "description": "Valentine's Day is an occasion to celebrate romantic love.", "country": "us", "date": 20400214, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "1a32ea64f2a8cefe6f906d2c34a23946", "name": "Statehood Day", "description": "Statehood Day is a local observance in the USA", "country": "us", "date": 20400214, "type": [ "Local observance" ], "primary_type": "Local observance", "locations": "AZ", "states": [ "us-az" ] }, { "uuid": "122ba1693e23c5fdaff67257fb84d250", "name": "Shrove Tuesday/Mardi Gras", "description": "Shrove Tuesday is traditionally known as the day prior to Lent but it also serves as a day of celebration, known as Mardi Gras.", "country": "us", "date": 20400214, "type": [ "Observance", "Christian" ], "primary_type": "Christian", "locations": "All", "states": "All" }, { "uuid": "122ba1693e23c5fdaff67257fb84d250", "name": "Shrove Tuesday/Mardi Gras", "description": "Shrove Tuesday is traditionally known as the day prior to Lent but it also serves as a day of celebration, known as Mardi Gras.", "country": "us", "date": 20400214, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "MS (community)", "states": [ "us-ms" ] }, { "uuid": "122ba1693e23c5fdaff67257fb84d250", "name": "Shrove Tuesday/Mardi Gras", "description": "Shrove Tuesday is traditionally known as the day prior to Lent but it also serves as a day of celebration, known as Mardi Gras.", "country": "us", "date": 20400214, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "AL (partly)", "states": [ "us-al" ] }, { "uuid": "122ba1693e23c5fdaff67257fb84d250", "name": "Shrove Tuesday/Mardi Gras", "description": "Shrove Tuesday is traditionally known as the day prior to Lent but it also serves as a day of celebration, known as Mardi Gras.", "country": "us", "date": 20400214, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "LA", "states": [ "us-la" ] }, { "uuid": "122ba1693e23c5fdaff67257fb84d250", "name": "Shrove Tuesday/Mardi Gras", "description": "Shrove Tuesday is traditionally known as the day prior to Lent but it also serves as a day of celebration, known as Mardi Gras.", "country": "us", "date": 20400214, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "FL (community)", "states": [ "us-fl" ] }, { "uuid": "f1472fd95e2c34ed3b9a07c0f97205ad", "name": "Ash Wednesday", "description": "Ash Wednesday is a Christian observance that marks the first day of Lent, which is prior to Easter.", "country": "us", "date": 20400215, "type": [ "Christian" ], "primary_type": "Christian", "locations": "All", "states": "All" }, { "uuid": "ee34a81ba837643803ed54f74154e632", "name": "Susan B. Anthony's Birthday", "description": "Susan B Anthony Day is an national American observance that is legally recognized in some states.", "country": "us", "date": 20400215, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "FL, WI", "states": [ "us-fl", "us-wi" ] }, { "uuid": "ee34a81ba837643803ed54f74154e632", "name": "Susan B. Anthony Day", "description": "Susan B Anthony Day is an national American observance that is legally recognized in some states.", "country": "us", "date": 20400215, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "CO, NY", "states": [ "us-co", "us-ny" ] }, { "uuid": "fa248ee56c9ee535c588a8eff25c5793", "name": "Elizabeth Peratrovich Day", "description": "Elizabeth Peratrovich was one of the main driving forces behind the territory's Anti-Discrimination Act of 1945.", "country": "us", "date": 20400216, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "AK", "states": [ "us-ak" ] }, { "uuid": "a0b184b30fc948dbd2a2dfa1f257b1ec", "name": "World Day of Social Justice", "description": "The United Nations' (UN) World Day of Social Justice promotes poverty eradication, full employment and social integration. It is on February 20 each year.", "country": "us", "date": 20400220, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "a6701e379600f1cab280dd473ce59126", "name": "Presidents' Day", "description": "Washington's Birthday, or Presidents' Day, honors the life and work of the first president of the United States, George Washington.", "country": "us", "date": 20400220, "type": [ "National holiday" ], "primary_type": "Federal Holiday", "locations": "All", "states": "All" }, { "uuid": "a6701e379600f1cab280dd473ce59126", "name": "Presidents' Day", "description": "Presidents' Day is a state holiday in the USA", "country": "us", "date": 20400220, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "All except DE, FL, GA, IA, KS, KY, LA, NC, RI, WI", "states": [ "us-al", "us-ak", "us-az", "us-ar", "us-ca", "us-co", "us-ct", "us-hi", "us-id", "us-il", "us-in", "us-me", "us-md", "us-ma", "us-mi", "us-mn", "us-ms", "us-mo", "us-mt", "us-ne", "us-nv", "us-nh", "us-nj", "us-nm", "us-ny", "us-nd", "us-oh", "us-ok", "us-or", "us-pa", "us-sc", "us-sd", "us-tn", "us-tx", "us-ut", "us-vt", "us-va", "us-wa", "us-wv", "us-wy", "us-dc" ] }, { "uuid": "a6701e379600f1cab280dd473ce59126", "name": "Presidents‘ Day", "description": "Presidents‘ Day is a state legal holiday in the USA", "country": "us", "date": 20400220, "type": [ "Local holiday" ], "primary_type": "State Legal Holiday", "locations": "KS, LA, WI", "states": [ "us-ks", "us-la", "us-wi" ] }, { "uuid": "a6701e379600f1cab280dd473ce59126", "name": "Washington‘s Day", "description": "Washington‘s Day is a state legal holiday in the USA", "country": "us", "date": 20400220, "type": [ "Local holiday" ], "primary_type": "State Legal Holiday", "locations": "KY, NC, RI", "states": [ "us-ky", "us-nc", "us-ri" ] }, { "uuid": "1788ed4778f956929cc2cd81090cd72b", "name": "Daisy Gatson Bates Day", "description": "Daisy Gatson Bates Day is a state holiday in Arkansas, the United States, on the third Monday of February. It coincides with Washington’s Birthday.", "country": "us", "date": 20400220, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "AR", "states": [ "us-ar" ] }, { "uuid": "b1706bb7f06f07ffac562a2e25b1d3a5", "name": "International Mother Language Day", "description": "The United Nations' (UN) International Mother Language Day is annually held on February 21 to celebrate languages spoken worldwide. It also observes the human right to use these languages.", "country": "us", "date": 20400221, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "9707a671bd2bd8c47ea0626a5d98bf74", "name": "African-American Scientist and Inventor Day", "description": "African-American Scientist and Inventor Day is a state observance in the USA", "country": "us", "date": 20400225, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "VA", "states": [ "us-va" ] }, { "uuid": "fc713c8ec34b6b45fe89dc4e88afd287", "name": "George Rogers Clark Day", "description": "George Rogers Clark Day is a state observance in the USA", "country": "us", "date": 20400225, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "IN", "states": [ "us-in" ] }, { "uuid": "a1c690d1e8bac5f73914587d56e381d7", "name": "Purim", "description": "Purim commemorates a time when Jewish people were saved from death around the fourth century BCE, according to the Book of Esther.", "country": "us", "date": 20400228, "type": [ "Hebrew" ], "primary_type": "Jewish holiday", "locations": "All", "states": "All" }, { "uuid": "57f7c0c47330e043af82dcd90b559d14", "name": "Linus Pauling Day", "description": "Linus Pauling Day is a state holiday on February 28 in Oregon, USA.", "country": "us", "date": 20400228, "type": [ "Local observance" ], "primary_type": "Local observance", "locations": "OR", "states": [ "us-or" ] }, { "uuid": "64b7ec7f168c794d6a3fc6e4af7359fc", "name": "Zero Discrimination Day", "description": "Discrimination Day highlights the negative impacts of discrimination and promotes tolerance, compassion and peace.", "country": "us", "date": 20400301, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "e9bdd4e02c7fd652ebbde4067ceaf5e2", "name": "Self-Injury Awareness Day", "description": "", "country": "us", "date": 20400301, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "d713518ffa46c770d90fc0f2ce4775e1", "name": "St. David's Day", "description": "Many Welsh communities in the United States celebrate the life of their patron saint, St David, and their links with Wales on St David’s Day.", "country": "us", "date": 20400301, "type": [ "Observance", "Christian" ], "primary_type": "Christian", "locations": "All", "states": "All" }, { "uuid": "16edecb679e47deaec9f03996f1b71d4", "name": "First Day of Women's History Month", "description": "First Day of Women's History Month is a annual monthly observance in the USA", "country": "us", "date": 20400301, "type": [ "Observance" ], "primary_type": "Annual Monthly Observance", "locations": "All", "states": "All" }, { "uuid": "2fc1141034520ca47d7c92b3537d7797", "name": "First Day of Irish American Heritage Month", "description": "First Day of Irish American Heritage Month is a annual monthly observance in the USA", "country": "us", "date": 20400301, "type": [ "Observance" ], "primary_type": "Annual Monthly Observance", "locations": "All", "states": "All" }, { "uuid": "21c4dd1a80033b60c5a7a77cbdb7e23c", "name": "Texas Independence Day", "description": "Texas Independence Day is a legal holiday in Texas, in the United States.", "country": "us", "date": 20400302, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "TX", "states": [ "us-tx" ] }, { "uuid": "ce4959604d67ab1ed97a093a0d837d10", "name": "Read Across America Day", "description": "Read Across America Day is observed in the United States on March 2 each year.", "country": "us", "date": 20400302, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "5fdcb659f0a730261efe4583a4002f9c", "name": "Employee Appreciation Day", "description": "Employee Appreciation Day is a US unofficial observance that recognizes and appreciates employees in all industries, aimed at helping employers keep their staff.", "country": "us", "date": 20400302, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "3ca800641768dd4cbb5411b720a0c6db", "name": "World Wildlife Day", "description": "World Wildlife Day celebrates all flora and fauna, including animals, on Earth.", "country": "us", "date": 20400303, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "d6c017aa5e052d8f217d6138207c5e09", "name": "Casimir Pulaski Day", "description": "Casimir Pulaski Day is a day off for some schools and offices in Illinois, USA, on the first Monday of March each year.", "country": "us", "date": 20400304, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "WI", "states": [ "us-wi" ] }, { "uuid": "d6c017aa5e052d8f217d6138207c5e09", "name": "Casimir Pulaski Day", "description": "Casimir Pulaski Day is a day off for some schools and offices in Illinois, USA, on the first Monday of March each year.", "country": "us", "date": 20400305, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "IN", "states": [ "us-in" ] }, { "uuid": "d6c017aa5e052d8f217d6138207c5e09", "name": "Casimir Pulaski Day", "description": "Casimir Pulaski Day is a day off for some schools and offices in Illinois, USA, on the first Monday of March each year.", "country": "us", "date": 20400305, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "IL", "states": [ "us-il" ] }, { "uuid": "20e23c1358acf8a23b8c5c26fcf929ec", "name": "Town Meeting Day", "description": "The state of Vermont, in the USA, holds its Town Meeting Day on the first Tuesday of March each year.", "country": "us", "date": 20400306, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "VT", "states": [ "us-vt" ] }, { "uuid": "485e6b5351d1cce550f1ab1ae0d93c46", "name": "International Women's Day", "description": "International Women’s Day celebrates women’s achievements worldwide and throughout history.", "country": "us", "date": 20400308, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "ca663ac6fd25f47ba4119835935baa82", "name": "World Kidney Day", "description": "World Kidney Day is an annual observation that attempts to raise global awareness about the importance of kidney health and tries to bring attention to the unique challenges faced by those who suffer from Chronic Kidney Disease.", "country": "us", "date": 20400308, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "cfc59f372ec73c13d117402b0df28231", "name": "International Day of Women Judges", "description": "International Day of Women Judges is a United Nations observance in the USA", "country": "us", "date": 20400310, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "37ec9c7d8016af391a0e381a2aa3b716", "name": "Daylight Saving Time starts", "description": "Daylight Saving Time starts in the USA", "country": "us", "date": "20400311T02:00:0005:00", "type": [ "Clock change/Daylight Saving Time" ], "primary_type": "Clock change/Daylight Saving Time", "locations": "All", "states": "All" }, { "uuid": "dd21b27f202dbafcd0772c0724dcb96f", "name": "Long Covid Awareness Day", "description": "Long Covid Awareness Day is a worldwide observance in the USA", "country": "us", "date": 20400315, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "851d66eb24e27ad1fa25b26aec4b189d", "name": "Evacuation Day observed", "description": "Evacuation Day in Suffolk County, Massachusetts, commemorates the first major American military victory in the Revolutionary War, which saw the British troops evacuate Boston.", "country": "us", "date": 20400316, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "MA (partly)", "states": [ "us-ma" ] }, { "uuid": "1005bae3e160fa1cb37138c2222ededf", "name": "St. Patrick's Day", "description": "St Patrick's Day marks the life and deeds of St Patrick, one of Ireland's patron saints. It is an Irish-American celebration in the USA.", "country": "us", "date": 20400317, "type": [ "Observance", "Christian" ], "primary_type": "Christian", "locations": "All", "states": "All" }, { "uuid": "851d66eb24e27ad1fa25b26aec4b189d", "name": "Evacuation Day", "description": "Evacuation Day in Suffolk County, Massachusetts, commemorates the first major American military victory in the Revolutionary War, which saw the British troops evacuate Boston.", "country": "us", "date": 20400317, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "MA (partly)", "states": [ "us-ma" ] }, { "uuid": "8fbcb23131eef7d227b98a8c9b8f309b", "name": "French Language Day", "description": "French Language Day is a United Nations observance in the USA", "country": "us", "date": 20400320, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "955bc5735feb7bb97db9e8360be20d85", "name": "International Day of Happiness", "description": "International Day of Happiness aims to promote the idea that the pursuit of happiness is universal.", "country": "us", "date": 20400320, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "8510987907f8aa352d8180560c85d9f9", "name": "March Equinox", "description": "March Equinox in the USA (New York)", "country": "us", "date": "20400319T20:11:3804:00", "type": [ "Season" ], "primary_type": "Season", "locations": "All", "states": "All" }, { "uuid": "eaaafed6408b8193282174179250fba7", "name": "International Day for the Elimination of Racial Discrimination", "description": "The United Nations’ (UN) International Day for the Elimination of Racial Discrimination is annually observed on March 21.", "country": "us", "date": 20400321, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "bb91e6fa1ff5e0f5b1f55f41c1050a14", "name": "World Poetry Day", "description": "World Poetry Day celebrates poetry around the world on March 21 each year.", "country": "us", "date": 20400321, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "abbffc95387a24defc2e20e294a5a142", "name": "International Day of Nowruz", "description": "The UN’s International Day of Nowruz, also known as Nowruz, No-Ruz, No-Rooz or No Ruz, is observed on March 21 each year.", "country": "us", "date": 20400321, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "780685462642bf87da859089a0ac96f4", "name": "World Down Syndrome Day", "description": "World Down Syndrome Day is held on March 21 every year.", "country": "us", "date": 20400321, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "876b314204c02de43705533b258f642a", "name": "International Day of Forests", "description": "International Day of Forests raises awareness on forests and trees, including their role in climate change.", "country": "us", "date": 20400321, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "fb974895a73882064c531ca7b54874c7", "name": "World Water Day", "description": "World Water Day aims to increase people's awareness of the water's importance in all aspects of life.", "country": "us", "date": 20400322, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "bf82e5cc52a9690b9b8514aef979af82", "name": "World Meteorological Day", "description": "World Meteorological Day marks the anniversary of the World Meteorological Organization's establishment on March 23, 1950.", "country": "us", "date": 20400323, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "5a05df4c34ec8840c27cd0662577e880", "name": "World Tuberculosis Day", "description": "World Tuberculosis Day is annually held on March 24 to raise awareness of tuberculosis and ways to eradicate the disease.", "country": "us", "date": 20400324, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "8d77e7d7924bab5e2177fe046e46fe7f", "name": "International Day for the Right to the Truth concerning Gross Human Rights Violations and for the Dignity of Victims", "description": "March 24 is the UN’s International Day for the Right to the Truth concerning Gross Human Rights Violations and for the Dignity of Victims", "country": "us", "date": 20400324, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "3b770f7a07734afe90ae6473968820d5", "name": "Palm Sunday", "description": "Palm Sunday in the United States celebrates Jesus Christ’s entry into Jerusalem. It is also the Sunday before Easter Sunday.", "country": "us", "date": 20400325, "type": [ "Christian" ], "primary_type": "Christian", "locations": "All", "states": "All" }, { "uuid": "088093a1a3892379468590bdf6e03fc5", "name": "International Day of Remembrance of Slavery Victims and the Transatlantic Slave Trade", "description": "The International Day of Remembrance of the Victims of Slavery and the Transatlantic Slave Trade remembers the lives of Africans who were forced into slavery in North, Central and South America.", "country": "us", "date": 20400325, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "c6f4ffd1dfb913da3c705798da063e73", "name": "International Day of Solidarity with Detained and Missing Staff Members", "description": "The UN’s International Day of Solidarity with Detained and Missing Staff Members is annually held on March 25.", "country": "us", "date": 20400325, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "76a6888cb730fd7217d2131335ef0516", "name": "Maryland Day", "description": "Maryland Day commemorates the arrival of Lord Baltimore and the first colonists in Maryland, the United States, in the 17th century.", "country": "us", "date": 20400325, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "MD", "states": [ "us-md" ] }, { "uuid": "26b9b5d72f7f2e065ae0e2a5ae450d37", "name": "The Prophet's Birthday", "description": "Eid Milad ul-Nabi (Mawlid or Milad-un-Nabi) commemorates the Prophet Muhammed's birthday.", "country": "us", "date": 20400326, "type": [ "Muslim" ], "primary_type": "Muslim", "locations": "All", "states": "All" }, { "uuid": "76a6888cb730fd7217d2131335ef0516", "name": "Maryland Day observed", "description": "Maryland Day commemorates the arrival of Lord Baltimore and the first colonists in Maryland, the United States, in the 17th century.", "country": "us", "date": 20400326, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "MD", "states": [ "us-md" ] }, { "uuid": "52c235730755c8cb6584490b34366e88", "name": "Prince Jonah Kuhio Kalanianaole Day", "description": "Prince Jonah Kuhio Kalanianaole Day is annually held in Hawaii on March 26 to honor Prince Jonah Kuhio Kalanianaole.", "country": "us", "date": 20400326, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "HI", "states": [ "us-hi" ] }, { "uuid": "de3aea4165902a16700c5c217a47d4a5", "name": "Seward's Day", "description": "Seward’s Day is a state holiday in Alaska, in the United States, on the last Monday of March.", "country": "us", "date": 20400326, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "AK", "states": [ "us-ak" ] }, { "uuid": "c7c2b7d212e5ed3d4a1f6c334ca27506", "name": "Passover Eve", "description": "Passover Eve is a Jewish holiday in the USA", "country": "us", "date": 20400328, "type": [ "Hebrew" ], "primary_type": "Jewish holiday", "locations": "All", "states": "All" }, { "uuid": "2be7345.1.2e1299823d5a280a3ebec38", "name": "Maundy Thursday", "description": "Maundy Thursday, which is also known as Holy Thursday, is the day before Good Friday.", "country": "us", "date": 20400329, "type": [ "Christian" ], "primary_type": "Christian", "locations": "All", "states": "All" }, { "uuid": "6109146bf39e3e0998efbb7fb1083b3c", "name": "Passover (first day)", "description": "Passover marks the Israelites' liberation from slavery and their exodus from Egypt around 3000 years ago.", "country": "us", "date": 20400329, "type": [ "Hebrew" ], "primary_type": "Jewish holiday", "locations": "All", "states": "All" }, { "uuid": "979e13b6fb546db8a924c330e17a017f", "name": "National Vietnam War Veterans Day", "description": "National Vietnam War Veterans Day is an US observance to honor US military members who served during the Vietnam War.", "country": "us", "date": 20400329, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "5fa7e70350366e84ec47654ed016fa94", "name": "Good Friday", "description": "Good Friday commemorates Jesus Christ's crucifixion.", "country": "us", "date": 20400330, "type": [ "Local holiday", "Christian" ], "primary_type": "State Holiday", "locations": "CT, HI, DE, IN, KY, LA, NJ, NC, ND, TN, TX (optional)", "states": [ "us-ct", "us-hi", "us-de", "us-in", "us-ky", "us-la", "us-nj", "us-nc", "us-nd", "us-tn", "us-tx" ] }, { "uuid": "f374dccbca598d6d85f6001556ed87a7", "name": "Wyoming Veterans Welcome Home Day", "description": "Wyoming Veterans Welcome Home Day is a state observance in the USA", "country": "us", "date": 20400330, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "WY", "states": [ "us-wy" ] }, { "uuid": "6b39b8d94368615db98b389298225f53", "name": "State Holiday", "description": "State Holiday is a state holiday in the USA", "country": "us", "date": 20400330, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "GA", "states": [ "us-ga" ] }, { "uuid": "6377f444e2cfe70daf01e6ec6baad62f", "name": "Doctors' Day", "description": "Doctors' Day is a observance in the USA", "country": "us", "date": 20400330, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "3dce26b025ff4b65d1e5e01dc5815dbc", "name": "Vietnam Veterans Day", "description": "Vietnam Veterans Day is a state observance in the USA", "country": "us", "date": 20400330, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "DE", "states": [ "us-de" ] }, { "uuid": "3dce26b025ff4b65d1e5e01dc5815dbc", "name": "Vietnam Veteran Recognition Day", "description": "Vietnam Veteran Recognition Day is a state observance in the USA", "country": "us", "date": 20400330, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "WV", "states": [ "us-wv" ] }, { "uuid": "ed67c5df0566b88b20a5ac4e9e257235", "name": "Holy Saturday", "description": "Holy Saturday is the day before Easter Sunday in the United States.", "country": "us", "date": 20400331, "type": [ "Christian" ], "primary_type": "Christian", "locations": "All", "states": "All" }, { "uuid": "198c8f764f0994a812af88cb8424bb39", "name": "Earth Hour", "description": "Earth Hour is an annual event in which many people worldwide turn their lights off on the last Saturday in March.", "country": "us", "date": 20400331, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "9da50ce50a63bb66e5f322504c97ece9", "name": "International Transgender Day of Visibility", "description": "International Transgender Day of Visibility is a worldwide observance in the USA", "country": "us", "date": 20400331, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "250b4e9878eab087f9be991259604e04", "name": "César Chávez Day", "description": "César Chávez Day celebrates the birthday of César Estrada Chávez.", "country": "us", "date": 20400331, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "AZ (partly), MI (partly), NV (partly), NM (partly), UT (partly), WI (partly)", "states": [ "us-az", "us-mi", "us-nv", "us-nm", "us-ut", "us-wi" ] }, { "uuid": "250b4e9878eab087f9be991259604e04", "name": "César Chávez Day", "description": "César Chávez Day celebrates the birthday of César Estrada Chávez.", "country": "us", "date": 20400331, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "TX (optional)", "states": [ "us-tx" ] }, { "uuid": "250b4e9878eab087f9be991259604e04", "name": "César Chávez Day", "description": "César Chávez Day celebrates the birthday of César Estrada Chávez.", "country": "us", "date": 20400331, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "CO (optional)", "states": [ "us-co" ] }, { "uuid": "250b4e9878eab087f9be991259604e04", "name": "César Chávez Day", "description": "César Chávez Day celebrates the birthday of César Estrada Chávez.", "country": "us", "date": 20400331, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "WA", "states": [ "us-wa" ] }, { "uuid": "250b4e9878eab087f9be991259604e04", "name": "César Chávez Day", "description": "César Chávez Day celebrates the birthday of César Estrada Chávez.", "country": "us", "date": 20400331, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "CA", "states": [ "us-ca" ] }, { "uuid": "ada227e6a64f6d8d76b0e207b890c117", "name": "April Fool's Day", "description": "April Fool's Day, on April 1, is a day to play practical jokes and tricks.", "country": "us", "date": 20400401, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "5a8d5f4c9549f5f7cf22bef09ad022a3", "name": "Easter Sunday", "description": "Easter Sunday is an important day in the Christian church calendar because it celebrates Jesus Christ's resurrection, according to Christian belief.", "country": "us", "date": 20400401, "type": [ "Observance", "Christian" ], "primary_type": "Christian", "locations": "All", "states": "All" }, { "uuid": "29bba2ac1f7a3072f89699e5ca941a0b", "name": "World Autism Awareness Day", "description": "World Autism Awareness Day raises an awareness of issues surrounding people, particularly children, with autism worldwide.", "country": "us", "date": 20400402, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "83a0b2b4a129fa3277ad9e3d4e880d7d", "name": "Easter Monday", "description": "Easter Monday is the day after Easter Sunday. It is not a federal holiday in the United States of America (USA).", "country": "us", "date": 20400402, "type": [ "Observance", "Christian" ], "primary_type": "Christian", "locations": "All", "states": "All" }, { "uuid": "d68d0a194e47c94c45.1.277532a5ec13", "name": "Pascua Florida Day", "description": "Pascua Florida Day, which usually falls on April 2, is a state day in Florida, USA.", "country": "us", "date": 20400402, "type": [ "Local observance" ], "primary_type": "Local observance", "locations": "FL", "states": [ "us-fl" ] }, { "uuid": "4b3a2adfaf2d30ef7842315de7cf4bb3", "name": "United Nations' Mine Awareness Day", "description": "The United Nations' International Day for Mine Awareness and Assistance in Mine Action is annually observed on April 4.", "country": "us", "date": 20400404, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "b0f4f1e07426769544f863f509894f39", "name": "Last Day of Passover", "description": "The last day of Passover marks the end of the Passover period, which lasts for seven or eight days.", "country": "us", "date": 20400405, "type": [ "Hebrew" ], "primary_type": "Jewish holiday", "locations": "All", "states": "All" }, { "uuid": "fc95dea55959d986b4bc2a7061b6a7eb", "name": "International Day of Conscience", "description": "International Day of Conscience is a United Nations observance in the USA", "country": "us", "date": 20400405, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "0f4d689973f15e7d788c3259b9d999ad", "name": "International Day of Sport for Development and Peace", "description": "The International Day of Sport for Development and Peace aims to bring goodwill and positive social outcomes through sporting achievements.", "country": "us", "date": 20400406, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "8f570bcb8f1fcb5b0fd491e0e7e20f6a", "name": "National Tartan Day", "description": "National Tartan Day is annually observed on April 6 to honor the major role that Scottish Americans played in the founding of the United States of America.", "country": "us", "date": 20400406, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "68e72591a345cd35b0686b7480d19f3b", "name": "United Nations' World Health Day", "description": "The World Health Organization, the United Nations' the directing and coordinating authority for health, annually highlights one of its priorities for global health on World Health Day.", "country": "us", "date": 20400407, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "3387dd07d5cae6b01589ee0151c8d922", "name": "Day of Remembrance of the Victims of the Rwanda Genocide", "description": "The UN’s Day of Remembrance of the Victims of the Rwanda Genocide is observed on April 7 each year.", "country": "us", "date": 20400407, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "d7d793f722aa9a29554b3d3a30edf541", "name": "Yom HaShoah", "description": "Many people in the United States observe Yom Hashoah by remembering Holocaust victims who died during World War II.", "country": "us", "date": 20400410, "type": [ "Hebrew" ], "primary_type": "Jewish commemoration", "locations": "All", "states": "All" }, { "uuid": "8c3b1fc8d321766ebc631aac059df3c2", "name": "National Library Workers' Day", "description": "National Library Workers’ Day recognizes the efforts and achievements that librarians make to give Americans access to information via books, computers and other media.", "country": "us", "date": 20400410, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "a0a82308e54673f7172e6ef48a7f9ec5", "name": "International Day of Human Space Flight", "description": "The UN’s International Day of Human Space Flight is annually held on April 12.", "country": "us", "date": 20400412, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "665c152272d175232dd08ef4c1fb32f8", "name": "Friday the 13th", "description": "Friday the 13th is a day full of superstitious beliefs in communities worldwide.", "country": "us", "date": 20400413, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "e41f2f315046aa508495b76969f90cb9", "name": "Thomas Jefferson's Birthday", "description": "Americans celebrate president Thomas Jefferson's Birthday on April 13.", "country": "us", "date": 20400413, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "b0a7046c4b867ebf3ab235e5d0f53af4", "name": "World Chagas Disease Day", "description": "World Chagas Disease Day is a United Nations observance in the USA", "country": "us", "date": 20400414, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "44aa9724e42542f8281e15c5c15bbf7e", "name": "World Art Day", "description": "World Art Day is a worldwide observance in the USA", "country": "us", "date": 20400415, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "7be90aeb4a6a3ac7f94610c604750e7e", "name": "Father Damien Day", "description": "Father Damien Day or Saint Damien Day is an occasion for residents of the state of Hawaii to remember the life and deeds of a Belgian missionary.", "country": "us", "date": 20400415, "type": [ "Local observance" ], "primary_type": "Local observance", "locations": "HI", "states": [ "us-hi" ] }, { "uuid": "722bf29830633fb420ca6561e24d1ed6", "name": "Emancipation Day", "description": "People celebrate the end of slavery and citizens' rights on Emancipation Day in the United States.", "country": "us", "date": 20400416, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "DC", "states": [ "us-dc" ] }, { "uuid": "73c8789d5268add5e264710faed35a77", "name": "Patriots' Day", "description": "Patriots' Day commemorates the battles of Lexington and Concord in 1775, which were two of the earliest battles in the American Revolutionary War.", "country": "us", "date": 20400416, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "ME, MA", "states": [ "us-me", "us-ma" ] }, { "uuid": "3610f392fac7f59a23355567d386f13e", "name": "Boston Marathon", "description": "Boston Marathon is one of the world's oldest yearly marathon. It is held annually on Patriot's Day in the month of April.", "country": "us", "date": 20400416, "type": [ "Sporting event" ], "primary_type": "Sporting event", "locations": "All", "states": "All" }, { "uuid": "e142b3406c124aa5f40c7977569e3c20", "name": "Tax Day", "description": "Tax Day is the deadline for United States residents to file details of their income to the Internal Revenue Service (IRS) so that their liability for income tax can be assessed.", "country": "us", "date": 20400417, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "8d5ab0afb912667a6d2777a779375d3c", "name": "Yom Ha'atzmaut", "description": "Many Jewish communities in the United States celebrate Yom Ha’Atzmaut, which is Israel’s Independence Day, on the fifth day of the month of Iyar in the Jewish calendar.", "country": "us", "date": 20400418, "type": [ "Hebrew" ], "primary_type": "Jewish holiday", "locations": "All", "states": "All" }, { "uuid": "9277053091a076328bca1f6c6896c084", "name": "International Day for Monuments and Sites", "description": "The International Day for Monuments and Sites raises awareness on preserving and conserving historical and archeological heritage sites.", "country": "us", "date": 20400418, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "9382e5a05a5b1e4cd13fe5ef269cef3b", "name": "Chinese Language Day", "description": "Chinese Language Day is a United Nations observance that celebrates one of the organization’s 6 official languages – Chinese.", "country": "us", "date": 20400420, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "ddd4817543a9ce8eef4b547957ee65cd", "name": "Arbor Day", "description": "Arbor Day is a state observance in the USA", "country": "us", "date": 20400420, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "CO", "states": [ "us-co" ] }, { "uuid": "cde65fb50e049d5981eef1d1612b333f", "name": "World Creativity and Innovation Day", "description": "World Creativity and Innovation Day is a United Nations observance in the USA", "country": "us", "date": 20400421, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "d344509436614d8ab1bd007b1fe3d48a", "name": "San Jacinto Day", "description": "San Jacinto Day commemorates the Battle of San Jacinto in what is now Harris County, Texas.", "country": "us", "date": 20400421, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "TX", "states": [ "us-tx" ] }, { "uuid": "a8a83fdc73f86d3e8ebdb752e970bd1a", "name": "Earth Day", "description": "The United Nations' International Mother Earth Day promotes environmental awareness and calls for the protection of our planet.", "country": "us", "date": 20400422, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "1f469b26dfdd01a6ec5c7b7345709c8d", "name": "Oklahoma Day", "description": "Oklahoma Day in the United States marks the anniversary of the opening of Oklahoma's lands to European settlers.", "country": "us", "date": 20400422, "type": [ "Local observance" ], "primary_type": "Local observance", "locations": "OK", "states": [ "us-ok" ] }, { "uuid": "026a6504f11a3de6c26866ced39047af", "name": "World Book and Copyright Day", "description": "World Book and Copyright Day is an occasion to celebrate the contribution of books and authors to our global culture and the connection between copyright and books.", "country": "us", "date": 20400423, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "df803326fc9e00877841891948fe6483", "name": "World Spanish Language Day", "description": "World Spanish Language Day is a United Nations observance in the USA", "country": "us", "date": 20400423, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "148978f16a6c4d9eab18dcfb487a8e99", "name": "English Language Day", "description": "English Language Day promotes the history, culture and accomplishments of the English language.", "country": "us", "date": 20400423, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "51b63887bae0c56a37fe351c71ca13f2", "name": "Confederate Memorial Day", "description": "On Confederate Memorial Day remembers the soldiers who died fighting for the Confederate States of America during the American Civil War (1861-1865). It is a state holiday in some parts of the United States.", "country": "us", "date": 20400423, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "AL", "states": [ "us-al" ] }, { "uuid": "5c916721004f371815a027d354e19b1c", "name": "International Day of Multilateralism and Diplomacy for Peace", "description": "International Day of Multilateralism and Diplomacy for Peace is a United Nations observance in the USA", "country": "us", "date": 20400424, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "e9191d2b383381759c3d3d66a5bb0472", "name": "International Delegate's Day", "description": "International Delegate's Day is a United Nations observance in the USA", "country": "us", "date": 20400425, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "4eb36b239f24e01378637d8e238ef341", "name": "World Malaria Day", "description": "World Malaria Day is annually observed on April 25 to promote efforts that provide effective control of malaria worldwide.", "country": "us", "date": 20400425, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "4c1fbb17ca69d5398ea6a5e2ee3bd0f3", "name": "Administrative Professionals Day", "description": "Administrative Professionals Day® is on the Wednesday of the last full week of April. It remembers the important role of administrative professionals.", "country": "us", "date": 20400425, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "e59a8c8aa7905cd07b1601dd0fde2777", "name": "International Girls in ICT Day", "description": "International Girls in ICT Day is a United Nations observance in the USA", "country": "us", "date": 20400426, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "6be493e00134962cab4110313c96ae6c", "name": "World Intellectual Property Day", "description": "World Intellectual Property Day is annually held on April 26 to increase awareness and understanding of intellectual property worldwide.", "country": "us", "date": 20400426, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "c0f71e5ffa909b0cb88813aedee97661", "name": "International Chernobyl Disaster Remembrance Day", "description": "International Chernobyl Disaster Remembrance Day is a UN holiday designed to raise awareness of the consequences of the 1986 nuclear accident.", "country": "us", "date": 20400426, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "51b63887bae0c56a37fe351c71ca13f2", "name": "Confederate Memorial Day", "description": "On Confederate Memorial Day remembers the soldiers who died fighting for the Confederate States of America during the American Civil War (1861-1865). It is a state holiday in some parts of the United States.", "country": "us", "date": 20400426, "type": [ "Local observance" ], "primary_type": "State Legal Holiday", "locations": "FL", "states": [ "us-fl" ] }, { "uuid": "927346f47cdb6ad932efd0874ff8574e", "name": "Take our Daughters and Sons to Work Day", "description": "Take our Daughters and Sons to Work Day is a observance in the USA", "country": "us", "date": 20400426, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "72289ca59d33ac366f17c9b8e460c557", "name": "Arbor Day", "description": "Arbor Day encourages people to plant and care for trees. In Nebraska, it falls on the last Friday of April.", "country": "us", "date": 20400427, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "NE", "states": [ "us-ne" ] }, { "uuid": "ddd4817543a9ce8eef4b547957ee65cd", "name": "Arbor Day", "description": "Arbor Day is a state observance in the USA", "country": "us", "date": 20400427, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "AZ", "states": [ "us-az" ] }, { "uuid": "ddd4817543a9ce8eef4b547957ee65cd", "name": "Arbor Day", "description": "Arbor Day is a state observance in the USA", "country": "us", "date": 20400427, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "DE", "states": [ "us-de" ] }, { "uuid": "6758df841ec0a94402464932280e57ad", "name": "World Day for Safety and Health at Work", "description": "The World Day for Safety and Health at Work is observed on April 28 each year.", "country": "us", "date": 20400428, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "ccb6d2d5a37a20c6bea62c143d89bec9", "name": "International Jazz Day", "description": "International Jazz Day recognizes the historical, cultural, and educational contribution of jazz.", "country": "us", "date": 20400430, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "ddd4817543a9ce8eef4b547957ee65cd", "name": "Arbor Day", "description": "Arbor Day is a state observance in the USA", "country": "us", "date": 20400430, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "WY", "states": [ "us-wy" ] }, { "uuid": "51b63887bae0c56a37fe351c71ca13f2", "name": "Confederate Memorial Day", "description": "On Confederate Memorial Day remembers the soldiers who died fighting for the Confederate States of America during the American Civil War (1861-1865). It is a state holiday in some parts of the United States.", "country": "us", "date": 20400430, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "MS", "states": [ "us-ms" ] }, { "uuid": "c8fc3fbdb1c10aac57107f745e66b54e", "name": "Lag BaOmer", "description": "Many Jewish Americans observe Lag B’Omer on the 18th day of the month of Iyar in the Jewish calendar.", "country": "us", "date": 20400501, "type": [ "Hebrew" ], "primary_type": "Jewish holiday", "locations": "All", "states": "All" }, { "uuid": "9aa13e2f577df9b6eca4f325dc0c5024", "name": "Law Day", "description": "Law Day in the United States is annually held on May 1.", "country": "us", "date": 20400501, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "549ac2ceba2814d8d6a1a9f14c1ffbe2", "name": "Loyalty Day", "description": "Loyalty Day is a special day for people to reaffirm their loyalty to the United States and to recognize the heritage of American freedom.", "country": "us", "date": 20400501, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "201c59c70deea730c37ff1bdf6a1b189", "name": "Lei Day", "description": "May Day is Lei Day in Hawai'i, celebrating Hawaiian culture or the “Aloha spirit.", "country": "us", "date": 20400501, "type": [ "Local observance" ], "primary_type": "Local observance", "locations": "HI", "states": [ "us-hi" ] }, { "uuid": "e9f300d03f294c048d22f1461c2368c6", "name": "First Day of Military Appreciation Month", "description": "First Day of Military Appreciation Month is a annual monthly observance in the USA", "country": "us", "date": 20400501, "type": [ "Observance" ], "primary_type": "Annual Monthly Observance", "locations": "All", "states": "All" }, { "uuid": "2ee08a547442f94b18db3e05e9f06cda", "name": "First Day of Asian Pacific American Heritage Month", "description": "First Day of Asian Pacific American Heritage Month is a annual monthly observance in the USA", "country": "us", "date": 20400501, "type": [ "Observance" ], "primary_type": "Annual Monthly Observance", "locations": "All", "states": "All" }, { "uuid": "faa91fe169ac7bae2e0f8f28fb1a3afe", "name": "First Day of Jewish American Heritage Month", "description": "First Day of Jewish American Heritage Month is a annual monthly observance in the USA", "country": "us", "date": 20400501, "type": [ "Observance" ], "primary_type": "Annual Monthly Observance", "locations": "All", "states": "All" }, { "uuid": "09750dcc296af90b7af66bc0caecdafa", "name": "World Tuna Day", "description": "World Tuna Day is a UN holiday designed to raise awareness of the global importance of tuna.", "country": "us", "date": 20400502, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "e5e157d5a0a08e86feab0200819d0016", "name": "World Press Freedom Day", "description": "World Press Freedom Day focuses on the importance of the freedom of the press and freedom of expression.", "country": "us", "date": 20400503, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "c01f42942905cd0b80ef0d204351c1b3", "name": "National Day of Prayer", "description": "National Day of Prayer is held on the first Thursday of May each year, inviting Americans of all faiths to pray for the country and its leaders.", "country": "us", "date": 20400503, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "0ab2320790e0c6c16e04dd937ab80d40", "name": "West Virginia Day of Prayer", "description": "West Virginia Day of Prayer is a state observance in the USA", "country": "us", "date": 20400503, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "WV", "states": [ "us-wv" ] }, { "uuid": "1b07d4cb3a8c57a8323160349bc242d9", "name": "Orthodox Good Friday", "description": "Many Orthodox Christians in the United States remember the events leading up to Jesus Christ's crucifixion on Great Friday.", "country": "us", "date": 20400504, "type": [ "Orthodox" ], "primary_type": "Orthodox", "locations": "All", "states": "All" }, { "uuid": "dec1a8c160411dd28f2579a50d2bf8c1", "name": "Kent State Shootings Remembrance", "description": "Kent State Shootings Remembrance Day is a local observance in Kent, Ohio.", "country": "us", "date": 20400504, "type": [ "Local observance" ], "primary_type": "Local observance", "locations": "OH", "states": [ "us-oh" ] }, { "uuid": "307f1d915ad867e9f32d05abe5ddbae3", "name": "Kentucky Oaks", "description": "The Kentucky Oaks is a rade 1 Stakes horse race held annually on the Friday before the Kentucky Derby in May.", "country": "us", "date": 20400504, "type": [ "Sporting event" ], "primary_type": "Sporting event", "locations": "All", "states": "All" }, { "uuid": "1154a6c700fd76be65035f63ef639695", "name": "Rhode Island Independence Day", "description": "Rhode Island Independence Day is a day to celebrate the state's declaration of independence from Great Britain in 1776.", "country": "us", "date": 20400504, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "RI", "states": [ "us-ri" ] }, { "uuid": "4c2e87f6a814bdab6286b8a64a5138b8", "name": "Orthodox Holy Saturday", "description": "Many Orthodox Christians in the United States remember Jesus Christ’s burial and his descent into Hades on Holy Saturday.", "country": "us", "date": 20400505, "type": [ "Orthodox" ], "primary_type": "Orthodox", "locations": "All", "states": "All" }, { "uuid": "93c4a99677f32b1fa184f5a105371980", "name": "World Portuguese Language Day", "description": "World Portuguese Language Day is a United Nations observance in the USA", "country": "us", "date": 20400505, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "0e6246531fabef30c445.1.243c0564a1", "name": "Cinco de Mayo", "description": "'Cinco de Mayo' means \"Fifth of May\" in Spanish and is a festival of Mexican pride and heritage.", "country": "us", "date": 20400505, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "802e294dd8422f42ec12997905b61b5b", "name": "Kentucky Derby", "description": "Kentucky Derby is a Grade I Stakes horse race held annually in Louisville, Kentucky in May.", "country": "us", "date": 20400505, "type": [ "Sporting event" ], "primary_type": "Sporting event", "locations": "All", "states": "All" }, { "uuid": "30d34b7317f7c0f23a37f9ea6c5f6e22", "name": "National Explosive Ordnance Disposal (EOD) Day", "description": "National Explosive Ordnance Disposal (EOD) Day is an occasion to remember those serving the profession of explosive ordnance disposal in the United States Armed Forces.", "country": "us", "date": 20400505, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "cd1ab8d8b8bef4974de484d3a19fca63", "name": "Orthodox Easter", "description": "Many Orthodox Christians in the United States mark Easter Sunday, also known as Pascha, as the day Jesus Christ was resurrected, according to the Christian bible.", "country": "us", "date": 20400506, "type": [ "Orthodox" ], "primary_type": "Orthodox", "locations": "All", "states": "All" }, { "uuid": "156463782d72b7fcea33addab5a68c95", "name": "International Family Equality Day", "description": "International Family Equality Day is a worldwide observance in the USA", "country": "us", "date": 20400506, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "c5dd792fda5ac5ad2b970f401e7655fa", "name": "National Nurses Day", "description": "National Nurses Day is an occasion to honor the work of nurses.", "country": "us", "date": 20400506, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "33881c22f264344d206e3db50c582d81", "name": "Orthodox Easter Monday", "description": "Many Orthodox churches in the United States observe Easter Monday on the day after the Orthodox Easter Sunday date.", "country": "us", "date": 20400507, "type": [ "Orthodox" ], "primary_type": "Orthodox", "locations": "All", "states": "All" }, { "uuid": "0cf6377042fc0444045763676e30c311", "name": "Time of Remembrance and Reconciliation for Those Who Lost Their Lives during the Second World War", "description": "The United Nations’ (UN) Time of Remembrance and Reconciliation for Those Who Lost Their Lives during the Second World War is annually held over two days, from May 8-9.", "country": "us", "date": 20400508, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "002dd1ff80d0afc70ab16f33ffa6e3e6", "name": "World Ovarian Cancer Day", "description": "World Ovarian Cancer Day aims to spread global awareness about ovarian cancer.", "country": "us", "date": 20400508, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "9b292b732719af7631dacbea5ed77e75", "name": "World Red Cross and Red Crescent Day", "description": "World Red Cross and Red Crescent Day is a worldwide observance in the USA", "country": "us", "date": 20400508, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "8dac16cbd9facae41d970cd3ffd77cfa", "name": "Truman Day", "description": "Truman Day is a holiday in the state of Missouri to honor Harry S Truman, the only person born in Missouri to ever become President of the United States.", "country": "us", "date": 20400508, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "MO", "states": [ "us-mo" ] }, { "uuid": "3ba79bc2b662c64ac6fcdff08a69aae1", "name": "Victory in Europe Day", "description": "Victory in Europe Day is a observance in the USA", "country": "us", "date": 20400508, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "2874d5dcad7694336b02230676a81235", "name": "Primary Election Day", "description": "Many residents in West Virginia vote during the state’s primary election day.", "country": "us", "date": 20400508, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "WV", "states": [ "us-wv" ] }, { "uuid": "f36ec3704041053ad21a86c12ca41d9c", "name": "National Teacher Appreciation Day", "description": "National Teacher Appreciation Day is a observance in the USA", "country": "us", "date": 20400508, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "67f2cdbb32176506f65fbe592023a68d", "name": "Ascension Day", "description": "Ascension Day is the 40th day of Easter and commemorates the ascension of Jesus Christ into heaven.", "country": "us", "date": 20400510, "type": [ "Christian" ], "primary_type": "Christian", "locations": "All", "states": "All" }, { "uuid": "40442de54ef6fb5921bc79be18e2dba7", "name": "International Day of Argania", "description": "International Day of Argania is a United Nations observance in the USA", "country": "us", "date": 20400510, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "51b63887bae0c56a37fe351c71ca13f2", "name": "Confederate Memorial Day", "description": "On Confederate Memorial Day remembers the soldiers who died fighting for the Confederate States of America during the American Civil War (1861-1865). It is a state holiday in some parts of the United States.", "country": "us", "date": 20400510, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "SC", "states": [ "us-sc" ] }, { "uuid": "51b63887bae0c56a37fe351c71ca13f2", "name": "Confederate Memorial Day", "description": "On Confederate Memorial Day remembers the soldiers who died fighting for the Confederate States of America during the American Civil War (1861-1865). It is a state holiday in some parts of the United States.", "country": "us", "date": 20400510, "type": [ "Local observance" ], "primary_type": "Local observance", "locations": "NC", "states": [ "us-nc" ] }, { "uuid": "8b5e1a7b3432455de7e50d6085c0ed3a", "name": "Native American Day", "description": "Native Americans' Day, on the second Monday of October, is celebrated some parts of the United States in lieu of Columbus Day.", "country": "us", "date": 20400511, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "WY", "states": [ "us-wy" ] }, { "uuid": "3f462dbca97a7df808906301272374f7", "name": "Military Spouse Appreciation Day", "description": "Appreciate and thank all the military spouses and partners you know on Military Spouse Appreciation Day.", "country": "us", "date": 20400511, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "3f462dbca97a7df808906301272374f7", "name": "Military Spouse Appreciation Day", "description": "Appreciate and thank all the military spouses and partners you know on Military Spouse Appreciation Day.", "country": "us", "date": 20400511, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "DE", "states": [ "us-de" ] }, { "uuid": "d8cca1c3d9b6f06cae01cc4eb7528fca", "name": "World Migratory Bird Day", "description": "World Migratory Bird Day is observed the second weekend of May every year.", "country": "us", "date": 20400512, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "a37827e1da94047b423a451eff56afab", "name": "International Nurses Day", "description": "International Nurses Day focuses on the critical contribution of nurses around the world in maintaining public health.", "country": "us", "date": 20400512, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "6711ff8c0b1f36117bbed97b4e0581dc", "name": "Mother's Day", "description": "Mother's Day celebrates the role of mothers and mother figures.", "country": "us", "date": 20400513, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "6711ff8c0b1f36117bbed97b4e0581dc", "name": "Mother's Day", "description": "Mother's Day celebrates the role of mothers and mother figures.", "country": "us", "date": 20400513, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "AZ", "states": [ "us-az" ] }, { "uuid": "54bbf732c517309a7acb7c09a39bca28", "name": "International Day of Families", "description": "The International Day of Families is an occasion to celebrate the importance of families to people, societies and cultures around the world.", "country": "us", "date": 20400515, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "d1de4d4d3b69a5c9e40f815aac460905", "name": "Peace Officers Memorial Day", "description": "Peace Officers Memorial Day is held annually in the United States on May 15 in honor of federal, state and local officers killed or disabled in the line of duty.", "country": "us", "date": 20400515, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "906bc86ec1c96be2531c06315f187f15", "name": "International Day of Living Together in Peace", "description": "International Day of Living Together in Peace is a United Nations observance in the USA", "country": "us", "date": 20400516, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "dae783076b77ee6151c6db1d291eb097", "name": "International Day of Light", "description": "International Day of Light is a United Nations observance in the USA", "country": "us", "date": 20400516, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "29f99be134e73592488099d20f3c95dd", "name": "World Telecommunication and Information Society Day", "description": "World Information Society Day is celebrated each year to raise awareness of how information and communication can be beneficial for societies and economies.", "country": "us", "date": 20400517, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "23eea40a10536a4cfd80cc0263ca6efa", "name": "Shavuot", "description": "Shavuot, also known as the Festival of Weeks, is one of three major Jewish festivals.", "country": "us", "date": 20400518, "type": [ "Hebrew" ], "primary_type": "Jewish holiday", "locations": "All", "states": "All" }, { "uuid": "2460ee5d2cda13dfcae0f500f1e1ccfd", "name": "National Defense Transportation Day", "description": "National Defense Transportation Day occurs annually in the United States on the third Friday of May.", "country": "us", "date": 20400518, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "bb37d8dcc96153cc6f739d30f75a5680", "name": "Public Lands Day", "description": "Public Lands Day is a state observance in the USA", "country": "us", "date": 20400519, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "CO", "states": [ "us-co" ] }, { "uuid": "9a018b7fe8e6fd9e53177aaa06c0c658", "name": "Armed Forces Day", "description": "Armed Forces Day is a national observance in the United States on the third Saturday of May each year.", "country": "us", "date": 20400519, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "5ecb0cdffb9308eb9eb4edcda3ae08f9", "name": "Preakness Stakes", "description": "The Preakness Stakes is the second event in the Triple Crown and is annually held two weeks after the Kentucky Derby.", "country": "us", "date": 20400519, "type": [ "Sporting event" ], "primary_type": "Sporting event", "locations": "All", "states": "All" }, { "uuid": "1961c2e339da2e282b4ea152fc625d9f", "name": "Pentecost", "description": "Many Christians in the United States observe Pentecost, also known as Whitsunday or Whit Sunday.", "country": "us", "date": 20400520, "type": [ "Christian" ], "primary_type": "Christian", "locations": "All", "states": "All" }, { "uuid": "9da34f27ca654aa23f95350a3ca23c38", "name": "World Bee Day", "description": "World Bee Day is a United Nations observance in the USA", "country": "us", "date": 20400520, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "d9766beb15d1d39e3a6d3c4dc0f462ee", "name": "World Autoimmune / Autoinflammatory Arthritis Day", "description": "World Autoimmune / Autoinflammatory Arthritis Day is a worldwide observance in the USA", "country": "us", "date": 20400520, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "186073ed079ac09d4529e7264fcbbdf4", "name": "Whit Monday", "description": "Many Christians in the United States will observe Whit Monday, or Pentecost Monday. It is the day after Pentecost, which is also known as Whit Sunday or Whitsunday.", "country": "us", "date": 20400521, "type": [ "Christian" ], "primary_type": "Christian", "locations": "All", "states": "All" }, { "uuid": "f11ea73194ea1dde69888e8c55cb373b", "name": "World Day for Cultural Diversity for Dialogue and Development", "description": "The World Day for Cultural Diversity for Dialogue and Development, held on May 21, is an occasion for people to deepen their understanding of cultural diversity.", "country": "us", "date": 20400521, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "efb93af7437f6fe6313a1f0372b854c2", "name": "International Tea Day", "description": "International Tea Day is a United Nations observance in the USA", "country": "us", "date": 20400521, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "f8881db9dafb50555b73d1270e8133a8", "name": "International Day for Biological Diversity", "description": "The International Day for Biological Diversity is an occasion to increase the global understanding and awareness of issues and challenges around biodiversity.", "country": "us", "date": 20400522, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "780d7285d60f92e6e47aa03cd98e0c2b", "name": "National Maritime Day", "description": "National Maritime Day is annually observed in the United States on May 22. It is a time to observe its maritime heritage, to honor those who served as merchant mariners, and to recognize the benefits of the maritime industry.", "country": "us", "date": 20400522, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "057d572e685e5552392cc6c5a3017982", "name": "Harvey Milk Day", "description": "Harvey Milk Day is an observance that is recognized in public schools in California, United States, on May 22 each year.", "country": "us", "date": 20400522, "type": [ "Local observance" ], "primary_type": "Local observance", "locations": "CA", "states": [ "us-ca" ] }, { "uuid": "4521d54b69c11668c9186273301d1ff5", "name": "International Day to End Obstetric Fistula", "description": "The International Day to End Obstetric Fistula raises awareness of fistula and calls for support to tackle the problem.", "country": "us", "date": 20400523, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "86edb7901268f6d3ce0cf9487d9a871a", "name": "Emergency Medical Services for Children Day", "description": "Emergency Medical Services for Children (EMSC) Day is observed on the Wednesday of Emergency Medical Services (EMS) Week, May 19–25, in the United States.", "country": "us", "date": 20400523, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "f77e883f97fc9a47e1944c68575c6be3", "name": "African Liberation Day", "description": "African Liberation Day celebrates African nations' hard-fought freedom from European colonial powers.", "country": "us", "date": 20400525, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "ff7857ae3ec5dc33c324b581b828b880", "name": "National Missing Children's Day", "description": "National Missing Children's Day is an observation dedicated to addressing the problem of child abduction.", "country": "us", "date": 20400525, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "dc051218d6edc1051ec58c46174ef5a1", "name": "Trinity Sunday", "description": "Trinity Sunday is the first Sunday after Pentecost and is celebrated by many Christians in the United States.", "country": "us", "date": 20400527, "type": [ "Christian" ], "primary_type": "Christian", "locations": "All", "states": "All" }, { "uuid": "4079c533dd8c497b6e5d359d6a6b7dbd", "name": "Memorial Day", "description": "Memorial Day commemorates all Americans who have died in military service for the United States.", "country": "us", "date": 20400528, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "AK, AL, AR, AZ, CA", "states": [ "us-ak", "us-al", "us-ar", "us-az", "us-ca" ] }, { "uuid": "4079c533dd8c497b6e5d359d6a6b7dbd", "name": "Memorial Day", "description": "Memorial Day commemorates all Americans who have died in military service for the United States.", "country": "us", "date": 20400528, "type": [ "National holiday" ], "primary_type": "Federal Holiday", "locations": "All", "states": "All" }, { "uuid": "98374fee3c354e554eceadb052620fd5", "name": "Jefferson Davis' Birthday", "description": "Jefferson Davis' Birthday, also known as Jefferson Davis Day, is a state holiday in Alabama in the United States.", "country": "us", "date": 20400528, "type": [ "Local observance" ], "primary_type": "Local observance", "locations": "MS", "states": [ "us-ms" ] }, { "uuid": "639c700d7b458ab139a8b6a7131d09cc", "name": "International Day of United Nations Peacekeepers", "description": "The International Day of United Nations Peacekeepers is an occasion to pay tribute to people who served in United Nations (UN) peacekeeping operations.", "country": "us", "date": 20400529, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "326da262903d08e390703520d0efcc1b", "name": "Corpus Christi", "description": "Corpus Christi is observed in honor of the Holy Eucharist.", "country": "us", "date": 20400531, "type": [ "Christian" ], "primary_type": "Christian", "locations": "All", "states": "All" }, { "uuid": "2d572c6640fad1a7082369d7af555afa", "name": "World No Tobacco Day", "description": "World No Tobacco Day draws attention to the health problems caused by tobacco use.", "country": "us", "date": 20400531, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "9f50f9cc8df47c6359c133b2f8441c37", "name": "Global Day of Parents", "description": "Global Day of Parents appreciates the role of a parent in nurturing and fostering growth for their children.", "country": "us", "date": 20400601, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "5c63e8be50a64ba650c3d6f63ea0af6a", "name": "First Day of Pride Month", "description": "First Day of Pride Month is a annual monthly observance in the USA", "country": "us", "date": 20400601, "type": [ "Observance" ], "primary_type": "Annual Monthly Observance", "locations": "All", "states": "All" }, { "uuid": "540739ed7807d780460537561c60f660", "name": "First Day of Caribbean-American Heritage Month", "description": "First Day of Caribbean-American Heritage Month is a annual monthly observance in the USA", "country": "us", "date": 20400601, "type": [ "Observance" ], "primary_type": "Annual Monthly Observance", "locations": "All", "states": "All" }, { "uuid": "f753ba9616b7c919305650a2bade2a2d", "name": "Statehood Day", "description": "Statehood Day marks the anniversary of the dates that Kentucky became the 15th state and Tennessee became the 16th state of the United States.", "country": "us", "date": 20400601, "type": [ "Local observance" ], "primary_type": "Local observance", "locations": "KY, TN", "states": [ "us-ky", "us-tn" ] }, { "uuid": "c795c4ec28cc5b781a3eca2dfb22fdc4", "name": "World Bicycle Day", "description": "World Bicycle Day is a United Nations observance in the USA", "country": "us", "date": 20400603, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "98374fee3c354e554eceadb052620fd5", "name": "Jefferson Davis' Birthday", "description": "Jefferson Davis' Birthday, also known as Jefferson Davis Day, is a state holiday in Alabama in the United States.", "country": "us", "date": 20400603, "type": [ "Local observance" ], "primary_type": "Local observance", "locations": "FL", "states": [ "us-fl" ] }, { "uuid": "8b5e1a7b3432455de7e50d6085c0ed3a", "name": "Native American Day", "description": "Native Americans' Day, on the second Monday of October, is celebrated some parts of the United States in lieu of Columbus Day.", "country": "us", "date": 20400603, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "AZ", "states": [ "us-az" ] }, { "uuid": "f024724c4f40bd2cd36ff5b8f7301aaa", "name": "International Day of Innocent Children Victims of Aggression", "description": "The United Nations' (UN) International Day of Innocent Children Victims of Aggression is observed on June 4 each year.", "country": "us", "date": 20400604, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "98374fee3c354e554eceadb052620fd5", "name": "Jefferson Davis' Birthday", "description": "Jefferson Davis' Birthday, also known as Jefferson Davis Day, is a state holiday in Alabama in the United States.", "country": "us", "date": 20400604, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "AL", "states": [ "us-al" ] }, { "uuid": "28311b841e39855565f918c653b1bdf6", "name": "World Environment Day", "description": "World Environment Day is held each year on June 5. It is one of the principal vehicles through which the United Nations (UN) stimulates worldwide awareness of the environment and enhances political attention and action.", "country": "us", "date": 20400605, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "f8683d9b51923ea5ad585afca64b6b94", "name": "International Day for the Fight against Illegal, Unreported and Unregulated Fishing", "description": "International Day for the Fight against Illegal, Unreported and Unregulated Fishing is a United Nations observance in the USA", "country": "us", "date": 20400605, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "d8310551b5fc68878da039725ba62901", "name": "Day of the Russian Language", "description": "Day of the Russian Language is a United Nations observance in the USA", "country": "us", "date": 20400606, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "ce657ffff5857cfd32947a3ec37af76f", "name": "D-Day", "description": "D-Day is a special anniversary in some countries, including the United States (U.S.), to remember Allied forces’ invasion of Normandy, France, in the Second World War.", "country": "us", "date": 20400606, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "336499c4679e6c2d09c16077dca81ad5", "name": "World Food Safety Day", "description": "World Food Safety Day is a United Nations observance in the USA", "country": "us", "date": 20400607, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "cf6fa70811544eb40df4eb83fc5961bd", "name": "World Oceans Day", "description": "World Oceans Day is annually observed on June 8 to raise awareness of the challenges humanity faces to protect the world's oceans.", "country": "us", "date": 20400608, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "ecf9888fd0b06f417a217b1118fc2788", "name": "Belmont Stakes", "description": "The Belmont Stakes is the third and final horse race of the Triple Crown. It is run annually five weeks after the Kentucky Derby.", "country": "us", "date": 20400609, "type": [ "Sporting event" ], "primary_type": "Sporting event", "locations": "All", "states": "All" }, { "uuid": "234be0f84c07e22a07110d9f35c4cc3a", "name": "Kamehameha Day", "description": "Kamehameha Day, held annually on June 11, honors Kamehameha the Great (Kamehameha I), the monarch who united and established the Kingdom of Hawaii.", "country": "us", "date": 20400611, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "HI", "states": [ "us-hi" ] }, { "uuid": "4ef0fae67c46f8d8930bbd1fb29512fb", "name": "World Day Against Child Labour", "description": "Poverty and injustice against widows is a world-wide problem addressed by International Widows' Day.", "country": "us", "date": 20400612, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "eb0f243bd5d25fbefa08968f18fbd318", "name": "Loving Day", "description": "Loving Day is a observance in the USA", "country": "us", "date": 20400612, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "c363a26ece950f05ef88d5b87aec8be6", "name": "International Albinism Awareness Day", "description": "International Albinism Awareness Day aims to stop the persecution and murders of people with albinism.", "country": "us", "date": 20400613, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "3ab7fedb82af1f9587759131316c3da2", "name": "World Blood Donor Day", "description": "On World Blood Donor Day numerous events are held worldwide to raise awareness about the importance of safe blood supplies.", "country": "us", "date": 20400614, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "95f1056240cd4c867c7a9bd94b33c188", "name": "Army Birthday", "description": "Army Birthday is a observance in the USA", "country": "us", "date": 20400614, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "6e1f13b8cc04fb5bf10f8dd5b2883a22", "name": "Flag Day", "description": "Flag Day is annually held on June 14 to honor the United States flag.", "country": "us", "date": 20400614, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "97f8bdaf2b06c86e54d34e774b574e00", "name": "World Elder Abuse Awareness Day", "description": "World Elder Abuse Awareness Day attempts to shine a light on the problem of physical, emotional, and financial abuse of elders.", "country": "us", "date": 20400615, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "29b9bafe411d56f5a13ade277f43ce41", "name": "Juneteenth Day", "description": "Juneteenth Day is a state holiday in the USA", "country": "us", "date": 20400615, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "NJ", "states": [ "us-nj" ] }, { "uuid": "d6855372a58703eaaab959ef28ef50fb", "name": "International Day of Family Remittances", "description": "The UN estimates that family remittances worth over 500 billion US$ are transferred worldwide every year.", "country": "us", "date": 20400616, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "29b9bafe411d56f5a13ade277f43ce41", "name": "Juneteenth National Freedom Day", "description": "Juneteenth National Freedom Day is a state observance in the USA", "country": "us", "date": 20400616, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "IA", "states": [ "us-ia" ] }, { "uuid": "29b9bafe411d56f5a13ade277f43ce41", "name": "Juneteenth", "description": "Juneteenth is a state observance in the USA", "country": "us", "date": 20400616, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "WY", "states": [ "us-wy" ] }, { "uuid": "29b9bafe411d56f5a13ade277f43ce41", "name": "Juneteenth Day", "description": "Juneteenth Day is a state observance in the USA", "country": "us", "date": 20400616, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "AK, AR", "states": [ "us-ak", "us-ar" ] }, { "uuid": "29b9bafe411d56f5a13ade277f43ce41", "name": "Juneteenth National Freedom Day", "description": "Juneteenth National Freedom Day is a state observance in the USA", "country": "us", "date": 20400616, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "CA", "states": [ "us-ca" ] }, { "uuid": "29b9bafe411d56f5a13ade277f43ce41", "name": "Juneteenth", "description": "Juneteenth is a state observance in the USA", "country": "us", "date": 20400616, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "LA", "states": [ "us-la" ] }, { "uuid": "29b9bafe411d56f5a13ade277f43ce41", "name": "Juneteenth National Freedom Day", "description": "Juneteenth National Freedom Day is a state observance in the USA", "country": "us", "date": 20400616, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "MI", "states": [ "us-mi" ] }, { "uuid": "29b9bafe411d56f5a13ade277f43ce41", "name": "Juneteenth National Freedom Day", "description": "Juneteenth National Freedom Day is a state observance in the USA", "country": "us", "date": 20400616, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "MT, OK", "states": [ "us-mt", "us-ok" ] }, { "uuid": "29b9bafe411d56f5a13ade277f43ce41", "name": "Juneteenth National Freedom Day", "description": "Juneteenth National Freedom Day is a state observance in the USA", "country": "us", "date": 20400616, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "VT", "states": [ "us-vt" ] }, { "uuid": "677275273c4024260d0ece5ebeac9dc3", "name": "World Day to Combat Desertification and Drought", "description": "The United Nations' World Day to Combat Desertification and Drought is observed worldwide on June 17 each year.", "country": "us", "date": 20400617, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "6a4b48eb4aea02f2e53ee3386c3914a8", "name": "Father's Day", "description": "Father's Day celebrates the contribution that fathers and father figures make to the lives of their children.", "country": "us", "date": 20400617, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "6a4b48eb4aea02f2e53ee3386c3914a8", "name": "Father's Day", "description": "Father's Day celebrates the contribution that fathers and father figures make to the lives of their children.", "country": "us", "date": 20400617, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "AZ", "states": [ "us-az" ] }, { "uuid": "64093d4614b8ab611200ed07a7d987d4", "name": "Bunker Hill Day", "description": "Bunker Hill Day commemorates the Battle of Bunker Hill, which took place on June 17, 1775 on the Charlestown Peninsula, Boston Harbor, in Massachusetts.", "country": "us", "date": 20400617, "type": [ "Local holiday" ], "primary_type": "Local holiday", "locations": "MA (partly)", "states": [ "us-ma" ] }, { "uuid": "ac8b4c9c07c2831d5a687f03323a439a", "name": "Sustainable Gastronomy Day", "description": "Sustainable Gastronomy Day is a United Nations observance in the USA", "country": "us", "date": 20400618, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "595a78303b1cc90afefacefaf6995bf1", "name": "International Day for the Elimination of Sexual Violence in Conflict", "description": "International Day for the Elimination of Sexual Violence in Conflict is a UN day aiming to rid the world of conflict-related sexual violence.", "country": "us", "date": 20400619, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "29b9bafe411d56f5a13ade277f43ce41", "name": "Juneteenth", "description": "Juneteenth, also known as Freedom Day and Emancipation Day, is a holiday or observance in many US states to celebrate the anniversary of the abolition of slavery in Texas on June 19, 1865.", "country": "us", "date": 20400619, "type": [ "National holiday" ], "primary_type": "Federal Holiday", "locations": "All", "states": "All" }, { "uuid": "29b9bafe411d56f5a13ade277f43ce41", "name": "Juneteenth Day", "description": "Juneteenth Day is a state holiday in the USA", "country": "us", "date": 20400619, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "KS", "states": [ "us-ks" ] }, { "uuid": "29b9bafe411d56f5a13ade277f43ce41", "name": "Juneteenth", "description": "Juneteenth is a state observance in the USA", "country": "us", "date": 20400619, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "AL", "states": [ "us-al" ] }, { "uuid": "29b9bafe411d56f5a13ade277f43ce41", "name": "Juneteenth Day", "description": "Juneteenth Day is a state observance in the USA", "country": "us", "date": 20400619, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "AZ, FL, HI, WI", "states": [ "us-az", "us-fl", "us-hi", "us-wi" ] }, { "uuid": "29b9bafe411d56f5a13ade277f43ce41", "name": "Juneteenth Day", "description": "Juneteenth Day is a state observance in the USA", "country": "us", "date": 20400619, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "GA", "states": [ "us-ga" ] }, { "uuid": "29b9bafe411d56f5a13ade277f43ce41", "name": "Juneteenth National Freedom Day", "description": "Juneteenth National Freedom Day is a state holiday in the USA", "country": "us", "date": 20400619, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "ID", "states": [ "us-id" ] }, { "uuid": "29b9bafe411d56f5a13ade277f43ce41", "name": "Juneteenth", "description": "Juneteenth is a state holiday in the USA", "country": "us", "date": 20400619, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "CO", "states": [ "us-co" ] }, { "uuid": "29b9bafe411d56f5a13ade277f43ce41", "name": "Juneteenth Independence Day", "description": "Juneteenth Independence Day is a state holiday in the USA", "country": "us", "date": 20400619, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "CT", "states": [ "us-ct" ] }, { "uuid": "29b9bafe411d56f5a13ade277f43ce41", "name": "Juneteenth National Freedom Day", "description": "Juneteenth National Freedom Day is a state holiday in the USA", "country": "us", "date": 20400619, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "DE", "states": [ "us-de" ] }, { "uuid": "29b9bafe411d56f5a13ade277f43ce41", "name": "Juneteenth National Freedom Day", "description": "Juneteenth National Freedom Day is a state holiday in the USA", "country": "us", "date": 20400619, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "IL", "states": [ "us-il" ] }, { "uuid": "29b9bafe411d56f5a13ade277f43ce41", "name": "Juneteenth", "description": "Juneteenth is a state holiday in the USA", "country": "us", "date": 20400619, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "SD", "states": [ "us-sd" ] }, { "uuid": "29b9bafe411d56f5a13ade277f43ce41", "name": "National Juneteenth Freedom Day", "description": "National Juneteenth Freedom Day is a state observance in the USA", "country": "us", "date": 20400619, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "KY", "states": [ "us-ky" ] }, { "uuid": "29b9bafe411d56f5a13ade277f43ce41", "name": "Juneteenth", "description": "Juneteenth is a state holiday in the USA", "country": "us", "date": 20400619, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "ME", "states": [ "us-me" ] }, { "uuid": "29b9bafe411d56f5a13ade277f43ce41", "name": "Juneteenth National Independence Day", "description": "Juneteenth National Independence Day is a state observance in the USA", "country": "us", "date": 20400619, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "DC, MD", "states": [ "us-dc", "us-md" ] }, { "uuid": "29b9bafe411d56f5a13ade277f43ce41", "name": "Juneteenth Independence Day", "description": "Juneteenth Independence Day is a state holiday in the USA", "country": "us", "date": 20400619, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "MA", "states": [ "us-ma" ] }, { "uuid": "29b9bafe411d56f5a13ade277f43ce41", "name": "Juneteenth", "description": "Juneteenth is a state holiday in the USA", "country": "us", "date": 20400619, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "MN", "states": [ "us-mn" ] }, { "uuid": "29b9bafe411d56f5a13ade277f43ce41", "name": "Juneteenth Freedom Day", "description": "Juneteenth Freedom Day is a state observance in the USA", "country": "us", "date": 20400619, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "MS", "states": [ "us-ms" ] }, { "uuid": "29b9bafe411d56f5a13ade277f43ce41", "name": "Juneteenth", "description": "Juneteenth is a state holiday in the USA", "country": "us", "date": 20400619, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "MO", "states": [ "us-mo" ] }, { "uuid": "29b9bafe411d56f5a13ade277f43ce41", "name": "Juneteenth", "description": "Juneteenth is a state observance in the USA", "country": "us", "date": 20400619, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "NE", "states": [ "us-ne" ] }, { "uuid": "29b9bafe411d56f5a13ade277f43ce41", "name": "Juneteenth Day", "description": "Juneteenth Day is a state holiday in the USA", "country": "us", "date": 20400619, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "NV", "states": [ "us-nv" ] }, { "uuid": "29b9bafe411d56f5a13ade277f43ce41", "name": "Juneteenth", "description": "Juneteenth is a state observance in the USA", "country": "us", "date": 20400619, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "NH", "states": [ "us-nh" ] }, { "uuid": "29b9bafe411d56f5a13ade277f43ce41", "name": "Juneteenth", "description": "Juneteenth is a state holiday in the USA", "country": "us", "date": 20400619, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "NY, VA, WA", "states": [ "us-ny", "us-va", "us-wa" ] }, { "uuid": "29b9bafe411d56f5a13ade277f43ce41", "name": "Juneteenth Freedom Day", "description": "Juneteenth Freedom Day is a state holiday in the USA", "country": "us", "date": 20400619, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "NM", "states": [ "us-nm" ] }, { "uuid": "29b9bafe411d56f5a13ade277f43ce41", "name": "Juneteenth", "description": "Juneteenth is a state observance in the USA", "country": "us", "date": 20400619, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "NC", "states": [ "us-nc" ] }, { "uuid": "29b9bafe411d56f5a13ade277f43ce41", "name": "Juneteenth", "description": "Juneteenth is a state observance in the USA", "country": "us", "date": 20400619, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "ND", "states": [ "us-nd" ] }, { "uuid": "29b9bafe411d56f5a13ade277f43ce41", "name": "Juneteenth", "description": "Juneteenth is a state observance in the USA", "country": "us", "date": 20400619, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "OH", "states": [ "us-oh" ] }, { "uuid": "29b9bafe411d56f5a13ade277f43ce41", "name": "Juneteenth", "description": "Juneteenth is a state holiday in the USA", "country": "us", "date": 20400619, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "OR", "states": [ "us-or" ] }, { "uuid": "29b9bafe411d56f5a13ade277f43ce41", "name": "Juneteenth National Freedom Day", "description": "Juneteenth National Freedom Day is a state holiday in the USA", "country": "us", "date": 20400619, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "PA (partly)", "states": [ "us-pa" ] }, { "uuid": "29b9bafe411d56f5a13ade277f43ce41", "name": "Juneteenth National Freedom Day", "description": "Juneteenth National Freedom Day is a state holiday in the USA", "country": "us", "date": 20400619, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "RI", "states": [ "us-ri" ] }, { "uuid": "29b9bafe411d56f5a13ade277f43ce41", "name": "Juneteenth Celebration of Freedom Day", "description": "Juneteenth Celebration of Freedom Day is a state observance in the USA", "country": "us", "date": 20400619, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "SC", "states": [ "us-sc" ] }, { "uuid": "29b9bafe411d56f5a13ade277f43ce41", "name": "Juneteenth", "description": "Juneteenth is a state holiday in the USA", "country": "us", "date": 20400619, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "TN", "states": [ "us-tn" ] }, { "uuid": "29b9bafe411d56f5a13ade277f43ce41", "name": "Juneteenth", "description": "Juneteenth is a state observance in the USA", "country": "us", "date": 20400619, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "WV", "states": [ "us-wv" ] }, { "uuid": "7984a234ce644e6d094a3185e0d5b37c", "name": "Emancipation Day", "description": "Emancipation Day is a state holiday in the USA", "country": "us", "date": 20400619, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "TX", "states": [ "us-tx" ] }, { "uuid": "ab1fe5eff0e97db29bd6233bbe4b4268", "name": "World Refugee Day", "description": "The United Nations' World Refugee Day honors refugees' courage, strength and determination.", "country": "us", "date": 20400620, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "93eb3343adf1eb3ee5de490549027fd5", "name": "West Virginia Day", "description": "West Virginia Day, or WV Day, celebrates the anniversary of the creation of the state of West Virginia on June 20, 1863.", "country": "us", "date": 20400620, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "WV", "states": [ "us-wv" ] }, { "uuid": "69d420833f907c42293c434d9c151e7a", "name": "American Eagle Day", "description": "Observed annually on June 20 in 47 American states, American Eagle Day is an unofficial holiday that celebrates the removal of the American Bald Eagle from a list of \"endangered species\".", "country": "us", "date": 20400620, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "235b1350a5a7cafa47569b8c7ec2aeee", "name": "June Solstice", "description": "June Solstice in the USA (New York)", "country": "us", "date": "20400620T13:46:2204:00", "type": [ "Season" ], "primary_type": "Season", "locations": "All", "states": "All" }, { "uuid": "65d5465b4fbef69ad9fa17984ded48fa", "name": "International Day of Yoga", "description": "The International Day of Yoga is a UN-day that aims to raise awareness worldwide of the many benefits of practicing yoga.", "country": "us", "date": 20400621, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "6401cd3527834d70c61486dab02ba134", "name": "International Day of the Celebration of the Solstice", "description": "International Day of the Celebration of the Solstice is a United Nations observance in the USA", "country": "us", "date": 20400621, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "d08d3304df76599a01932893395e5d43", "name": "Public Service Day", "description": "The United Nations’ Public Service Day celebrates the idea that democracy and successful governance depend on a competent civil service.", "country": "us", "date": 20400623, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "f73afa8e4ebe4405df3ef37a5ca8004f", "name": "International Widows' Day", "description": "Poverty and injustice against widows is a world-wide problem addressed by International Widows' Day.", "country": "us", "date": 20400623, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "a0b52f3ca1a13ec5f1d1f88171a0554f", "name": "Day of the Seafarer", "description": "The Day of the Seafarer aims to acknowledge the social, and economic contribution of the millions of seafarers around the world.", "country": "us", "date": 20400625, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "3a0db53b17de60a3bc81731b4e36f672", "name": "International Day Against Drug Abuse and Illicit Trafficking", "description": "The United Nations’ (UN) International Day Against Drug Abuse and Illicit Trafficking raise awareness about the dangers of illicit drugs.", "country": "us", "date": 20400626, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "07731ea7beb0fc103b39dc05168b8c36", "name": "International Day in Support of Victims of Torture", "description": "The United Nations’ (UN) International Day in Support of Victims of Torture is annually observed on June 26 to remind people that human torture is not only unacceptable – it is also a crime.", "country": "us", "date": 20400626, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "2299cba09bde50305e98f0e55d60cc88", "name": "Micro-, Small and Medium-sized Enterprises Day", "description": "Micro-, Small and Medium-sized Enterprises Day is a United Nations observance in the USA", "country": "us", "date": 20400627, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "e5b17d988ee9b4b4beeafe9340ff0d63", "name": "Carolina Day", "description": "Carolina Day is a state observance in the USA", "country": "us", "date": 20400628, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "SC", "states": [ "us-sc" ] }, { "uuid": "2432f0d274ea2b032998491fb8ef0ed7", "name": "International Day of the Tropics", "description": "International Day of the Tropics is a United Nations observance in the USA", "country": "us", "date": 20400629, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "139cc87fa2c8786fd30e8f58eee41938", "name": "International Asteroid Day", "description": "The United Nations established International Asteroid Day to raise public awareness of the asteroid impact hazard.", "country": "us", "date": 20400630, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "0c92b70ddcbe60f17950f2c07c271d74", "name": "International Day of Parliamentarism", "description": "International Day of Parliamentarism is a United Nations observance in the USA", "country": "us", "date": 20400630, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "f20b4cd1d083053b5f5d2f222232731f", "name": "Independence Day", "description": "On Independence Day, Americans celebrate the anniversary of publication of the Declaration of Independence from Great Britain in 1776.", "country": "us", "date": 20400704, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "CA", "states": [ "us-ca" ] }, { "uuid": "f20b4cd1d083053b5f5d2f222232731f", "name": "Independence Day", "description": "On Independence Day, Americans celebrate the anniversary of publication of the Declaration of Independence from Great Britain in 1776.", "country": "us", "date": 20400704, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "AK, AL, AR, AZ, OK", "states": [ "us-ak", "us-al", "us-ar", "us-az", "us-ok" ] }, { "uuid": "f20b4cd1d083053b5f5d2f222232731f", "name": "Independence Day", "description": "On Independence Day, Americans celebrate the anniversary of publication of the Declaration of Independence from Great Britain in 1776.", "country": "us", "date": 20400704, "type": [ "National holiday" ], "primary_type": "Federal Holiday", "locations": "All", "states": "All" }, { "uuid": "692f0c378f0a3b8c03c293e0b6b247cd", "name": "International Day of Cooperatives", "description": "The United Nations' (UN) International Day of Cooperatives recognizes and reaffirms the role of cooperatives in economic, social and cultural development and in the achievement of social policy objectives.", "country": "us", "date": 20400707, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "6d2c2de631862f8dbb18682068b4b8ca", "name": "World Population Day", "description": "The United Nations' (UN) World Population Day reaffirms the human right to plan for a family.", "country": "us", "date": 20400711, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "665c152272d175232dd08ef4c1fb32f8", "name": "Friday the 13th", "description": "Friday the 13th is a day full of superstitious beliefs in communities worldwide.", "country": "us", "date": 20400713, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "3d9fb19a3f98f6041804d781d49437da", "name": "Nathan Bedford Forrest Day", "description": "Nathan Bedford Forrest Day is a local observance in the USA", "country": "us", "date": 20400713, "type": [ "Local observance" ], "primary_type": "Local observance", "locations": "TN", "states": [ "us-tn" ] }, { "uuid": "2a5ee6fc2c2a7c930c2abe62b21bbb29", "name": "Bastille Day", "description": "Bastille Day is a observance in the USA", "country": "us", "date": 20400714, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "7d5d4ac7dbd776d6ee9aab8d5303e9d6", "name": "World Youth Skills Day", "description": "Acquiring skills enhances youths' ability to make informed choices and empowers them to gain access to changing labor markets.", "country": "us", "date": 20400715, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "c875226c15c9a27e5eff71dae5f7d31c", "name": "Rural Transit Day", "description": "Rural Transit Day is a observance in the USA", "country": "us", "date": 20400716, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "4379181ea3800fc590151dbbc2501c7c", "name": "Nelson Mandela Day", "description": "Nelson Mandela International Day is annually observed on July 18 to recognize the former South African president’s contribution to peace and freedom.", "country": "us", "date": 20400718, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "cbd5a671f21fe9ac4b9ea860304a2ac7", "name": "Tisha B'Av", "description": "Tisha B’Av is on the ninth day of the month of Av in the Jewish calendar.", "country": "us", "date": 20400719, "type": [ "Hebrew" ], "primary_type": "Jewish holiday", "locations": "All", "states": "All" }, { "uuid": "94530c44bc27e6ff9fdf3d5f23e5d4ec", "name": "World Chess Day", "description": "World Chess Day is a United Nations observance in the USA", "country": "us", "date": 20400720, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "3946af877332eb63566fd590f3d2bbc5", "name": "Parents' Day", "description": "Parents’ Day is celebrated in the United States on the fourth Sunday of July each year to recognize and promote parenting as a crucial part of families and the wider community.", "country": "us", "date": 20400722, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "f1d94345fd33e4aebd1183bdf610bf73", "name": "Pioneer Day", "description": "Pioneer Day is an annual state holiday in Utah in the United States. It is celebrated to honor the pioneers who demonstrated industry and bravery when they ventured to settle in a place that is now Salt Lake City.", "country": "us", "date": 20400724, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "UT", "states": [ "us-ut" ] }, { "uuid": "8b65464105f938f4f0924bb830f4f5b3", "name": "World Drowning Prevention Day", "description": "World Drowning Prevention Day is a United Nations observance in the USA", "country": "us", "date": 20400725, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "94ae6d5ee4eb8c9292d67fc26e1c7c01", "name": "Korean War Veteran Recognition Day", "description": "Korean War Veteran Recognition Day is a state observance in the USA", "country": "us", "date": 20400727, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "WV", "states": [ "us-wv" ] }, { "uuid": "3fa30eb9b2ed317b48b81408da2c10b2", "name": "National Korean War Veterans Armistice Day", "description": "National Korean War Veterans Armistice Day is a observance in the USA", "country": "us", "date": 20400727, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "64d91cbc6b9c7c40cb74c09fe3f93deb", "name": "World Hepatitis Day", "description": "World Hepatitis Day is observed on July 28 every year to raise awareness of hepatitis and encourage prevention and treatment.", "country": "us", "date": 20400728, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "1e30066becce722c37194e5de584956b", "name": "International Day of Friendship", "description": "The International Day of Friendship is annually held on July 30 to celebrate friendships worldwide.", "country": "us", "date": 20400730, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "7e501a34bdaba379b784854c1eb63e63", "name": "World Day Against Trafficking in Persons", "description": "July 30 is the UN World Day Against Trafficking in Persons", "country": "us", "date": 20400730, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "c38d608e4dc9d70968a3e0fe24fb1cc2", "name": "Colorado Day", "description": "Colorado Day is an annual observance that commemorates the state’s birthday on August 1, 1876, and its history.", "country": "us", "date": 20400801, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "CO", "states": [ "us-co" ] }, { "uuid": "7aff979cee1e68944682c6bff58b7568", "name": "Coast Guard Birthday", "description": "Coast Guard Birthday is a observance in the USA", "country": "us", "date": 20400804, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "99a49941f8dbbaac713afd88152e0e3d", "name": "Barack Obama Day", "description": "Barack Obama Day is a observance in the USA", "country": "us", "date": 20400804, "type": [ "Observance" ], "primary_type": "Observance", "locations": "IL", "states": [ "us-il" ] }, { "uuid": "16e1b09408f221b84acd5e63e265b751", "name": "American Family Day", "description": "American Family Day is a state holiday in the USA", "country": "us", "date": 20400805, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "AZ", "states": [ "us-az" ] }, { "uuid": "66da5c85ebd32fb5830d977ad958d207", "name": "Isra and Mi'raj", "description": "Isra and Mi'raj (Isra Me'raj, Israa and Mi'raaj, Laylat Al-Isra wa Al-Miraj, Lailat al Miraj, Night Journey and Ascension to Heaven) marks the night when the Prophet Mohammad traveled from Mecca to Jerusalem, ascended to heaven and returned.", "country": "us", "date": 20400806, "type": [ "Muslim" ], "primary_type": "Muslim", "locations": "All", "states": "All" }, { "uuid": "9c10a2aa263fb7768d436da4b888c095", "name": "Purple Heart Day", "description": "Purple Heart Day on August 7 commemorates the day in 1782 when General George Washington created the Purple Heart Medal – a military decoration that is awarded to those wounded or killed while serving in the United States Armed Forces.", "country": "us", "date": 20400807, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "WY", "states": [ "us-wy" ] }, { "uuid": "9c10a2aa263fb7768d436da4b888c095", "name": "Purple Heart Day", "description": "Purple Heart Day on August 7 commemorates the day in 1782 when General George Washington created the Purple Heart Medal – a military decoration that is awarded to those wounded or killed while serving in the United States Armed Forces.", "country": "us", "date": 20400807, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "9c10a2aa263fb7768d436da4b888c095", "name": "Purple Heart Day", "description": "Purple Heart Day on August 7 commemorates the day in 1782 when General George Washington created the Purple Heart Medal – a military decoration that is awarded to those wounded or killed while serving in the United States Armed Forces.", "country": "us", "date": 20400807, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "WV", "states": [ "us-wv" ] }, { "uuid": "4edd91a9989ebcb33d35100ea61fd5b2", "name": "International Day of the World's Indigenous People", "description": "The United Nations’ (UN) International Day of the World's Indigenous People is observed on August 9 each year to promote and protect the rights of the world’s indigenous peoples.", "country": "us", "date": 20400809, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "ec874a007524d0c177a0dedb3fce437c", "name": "International Youth Day", "description": "The United Nations’ (UN) International Youth Day is annually held on August 12 to celebrate the achievements of the world’s youth and to encourage their participation in enhancing society.", "country": "us", "date": 20400812, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "0589ec7010470585ef2b6ee4fdbd7b66", "name": "Victory Day", "description": "Victory Day, also known as VJ Day, is an annual state holiday celebrated on the second Monday in August in Rhode Island in the United States. It marks the anniversary of the Allies’ victory over Japan during World War II.", "country": "us", "date": 20400813, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "RI", "states": [ "us-ri" ] }, { "uuid": "1a9dbb110511d435e5ea125cd9ac053e", "name": "Assumption of Mary", "description": "Assumption Day is a Christian observance in the United States that is held annually on August 15. Catholics observe the Dormition (falling asleep) or the day that the Blessed Virgin Mary was received into heaven.", "country": "us", "date": 20400815, "type": [ "Christian" ], "primary_type": "Christian", "locations": "All", "states": "All" }, { "uuid": "85b431363e4944bc6a896d4fdc336153", "name": "Bennington Battle Day", "description": "Bennington Battle Day is a state holiday in Vermont. It commemorates the American victory at the Battle of Bennington during the Revolutionary War in north America in 1777.", "country": "us", "date": 20400816, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "VT", "states": [ "us-vt" ] }, { "uuid": "baaf8d0a2b8e80f7fdfa4047803bbf1c", "name": "Hawaii Statehood Day", "description": "Hawaii’s Statehood Day is celebrated on the third Friday of August to commemorate the anniversary of Hawaii’s statehood.", "country": "us", "date": 20400817, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "HI", "states": [ "us-hi" ] }, { "uuid": "ecfe67ffc900fb83b0c69ee2d98143b9", "name": "World Humanitarian Day", "description": "The United Nations’(UN) World Humanitarian Day focuses on increasing public awareness about humanitarian service worldwide and is annually observed on August 19.", "country": "us", "date": 20400819, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "2542a84670f5485d462a8eb54d1b0fd0", "name": "National Navajo Code Talkers Day", "description": "National Navajo Code Talkers Day is a state holiday in the USA", "country": "us", "date": 20400819, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "AZ", "states": [ "us-az" ] }, { "uuid": "0fb4fec92eb0693cbf7146f93ac9bd58", "name": "National Aviation Day", "description": "National Aviation Day is observed in the United States on August 19 each year to celebrate the history and development of the aviation.", "country": "us", "date": 20400819, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "7c75f8e2700899c14b43ec6730bb8cd9", "name": "National Senior Citizens Day", "description": "National Senior Citizens Day is an observance on the third Sunday of August to honor the contributions of senior citizens in the United States.", "country": "us", "date": 20400819, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "e6ee62719aac976e6e2137b8132397be", "name": "International Day of Remembrance of and Tribute to the Victims of Terrorism", "description": "International Day of Remembrance of and Tribute to the Victims of Terrorism is a United Nations observance in the USA", "country": "us", "date": 20400821, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "45429d36ccda1668b97be7a5c7a030e4", "name": "International Day Commemorating the Victims of Acts of Violence Based on Religion or Belief", "description": "International Day Commemorating the Victims of Acts of Violence Based on Religion or Belief is a United Nations observance in the USA", "country": "us", "date": 20400822, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "c9e7e166f8ae31e0146b8c4c896bff0b", "name": "International Day for the Remembrance of the Slave Trade and its Abolition", "description": "The United Nations’ (UN) International Day for the Remembrance of the Slave Trade and its Abolition is held on August 23 each year to remind people of the tragedy of the transatlantic slave trade.", "country": "us", "date": 20400823, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "ee34a81ba837643803ed54f74154e632", "name": "Susan B. Anthony Day", "description": "Susan B Anthony Day is an national American observance that is legally recognized in some states.", "country": "us", "date": 20400826, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "MA", "states": [ "us-ma" ] }, { "uuid": "3bad34628ed53075b543dbae96498c3d", "name": "Women's Equality Day", "description": "Women's Equality Day on August 26 is an annual observance that commemorates the anniversary of the first time voting rights were extended to women in the United States.", "country": "us", "date": 20400826, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "cbb788ac177e6fdf487651f54e36df28", "name": "Lyndon Baines Johnson Day", "description": "Lyndon Baines Johnson Day is a state holiday in Texas in the United States on August 27 each year. It commemorates the birthday of Lyndon Baines Johnson, who was the 36th president of the USA.", "country": "us", "date": 20400827, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "TX", "states": [ "us-tx" ] }, { "uuid": "d578ca62d9a2ee9ecdeed3ef10700076", "name": "International Day against Nuclear Tests", "description": "The United Nations’ (UN) International Day against Nuclear Tests is annually observed on August 29. The day raises awareness of the dangers of nuclear weapons and a closer approach to eliminating the use of those weapons.", "country": "us", "date": 20400829, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "cbff229c415b56d69f2e6ca65de05d54", "name": "International Day of the Victims of Enforced Disappearances", "description": "The International Day of the Victims of Enforced Disappearances is annually observed on August 30.", "country": "us", "date": 20400830, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "358abdb456e5548413fe10e91509b4b5", "name": "International Day for People of African Descent", "description": "International Day for People of African Descent is a United Nations observance in the USA", "country": "us", "date": 20400831, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "4e50bdcf35674f99451aac9e81e5c715", "name": "International Overdose Awareness Day", "description": " International Overdose Awareness Day is an annual observation which aims to raise global awareness of about the impact of drug overdose on families and communities. The campaign also attempts to remove the stigma associated with overdose.", "country": "us", "date": 20400831, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "c8e9fb43e9d67d45f95560338085ff31", "name": "Labor Day", "description": "Labor Day is a federal holiday in the United States. It gives workers a day of rest and it celebrates their contribution to the American economy.", "country": "us", "date": 20400903, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "All", "states": [ "us-al", "us-ak", "us-az", "us-ar", "us-ca", "us-co", "us-ct", "us-fl", "us-de", "us-dc", "us-ga", "us-hi", "us-id", "us-il", "us-in", "us-ia", "us-ks", "us-ky", "us-la", "us-ma", "us-me", "us-md", "us-mi", "us-mn", "us-mo", "us-ms", "us-mt", "us-ne", "us-nh", "us-nv", "us-nj", "us-nm", "us-nc", "us-ny", "us-nd", "us-oh", "us-ok", "us-or", "us-pa", "us-ri", "us-sc", "us-sd", "us-tn", "us-tx", "us-ut", "us-vt", "us-va", "us-wa", "us-wv", "us-wy", "us-wi" ] }, { "uuid": "c8e9fb43e9d67d45f95560338085ff31", "name": "Labor Day", "description": "Labor Day is a federal holiday in the United States. It gives workers a day of rest and it celebrates their contribution to the American economy.", "country": "us", "date": 20400903, "type": [ "National holiday" ], "primary_type": "Federal Holiday", "locations": "All", "states": "All" }, { "uuid": "f715cc6c4ab2b5939e39dbeaab7607fc", "name": "World Sexual Health Day", "description": " World Sexual Health Day is an annual awareness day that attempts to break down social and cultural taboos associated with sexuality and to promote sexual health around the world.", "country": "us", "date": 20400904, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "92e53bb746559996330ebb1bb9020334", "name": "International Day of Charity", "description": "The International Day of Charity raises public awareness of what charities do to help minimize poverty.", "country": "us", "date": 20400905, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "0ee29b156f5e5e05523f638ed660d66a", "name": "International Day of Clean Air for Blue Skies", "description": "International Day of Clean Air for Blue Skies is a United Nations observance in the USA", "country": "us", "date": 20400907, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "7fa0f21ee0660a2b271fb84b20da5dcb", "name": "Still's Disease Awareness Day", "description": "Still's Disease Awareness Day is a worldwide observance in the USA", "country": "us", "date": 20400907, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "b0103540a2ec18f35005522c77710ed9", "name": "Rosh Hashana", "description": "Rosh Hashanah is the Jewish New Year. Many Jewish-run organizations in the US are closed during the two-day celebration.", "country": "us", "date": 20400908, "type": [ "Hebrew" ], "primary_type": "Jewish holiday", "locations": "All", "states": "All" }, { "uuid": "a66045836b8c81dfdab6058e3ded0f1c", "name": "Ramadan Starts", "description": "Many Muslims in the United States fast in the hours of daylight during Ramadan, the ninth month in the Islamic calendar.", "country": "us", "date": 20400908, "type": [ "Muslim" ], "primary_type": "Muslim", "locations": "All", "states": "All" }, { "uuid": "548e9ace9cb0c190b5b5b23abe7f81a5", "name": "International Literacy Day", "description": "The United Nations' (UN) International Literacy Day is held on September 8 each year.", "country": "us", "date": 20400908, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "a17c119aa9c8c3a6e6a3c32be8d520a7", "name": "Carl Garner Federal Lands Cleanup Day", "description": "Carl Garner Federal Lands Cleanup Day encourages people in the United States to participate in cleaning up the federal lands. It is observed on the first Saturday after Labor Day.", "country": "us", "date": 20400908, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "8b5e1a7b3432455de7e50d6085c0ed3a", "name": "Native American Day", "description": "Native Americans' Day, on the second Monday of October, is celebrated some parts of the United States in lieu of Columbus Day.", "country": "us", "date": 20400908, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "DE", "states": [ "us-de" ] }, { "uuid": "f8738e72cfcdf516e082e14291403c68", "name": "Rosh Hashana", "description": "Rosh Hashanah is the Jewish New Year. Many Jewish-run organizations in the US are closed during the two-day celebration.", "country": "us", "date": 20400908, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "TX (optional)", "states": [ "us-tx" ] }, { "uuid": "ccad8089e5274bf76863275a23795694", "name": "International Day to Protect Education from Attack", "description": "International Day to Protect Education from Attack is a United Nations observance in the USA", "country": "us", "date": 20400909, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "6a145d4b8557066ee30374392bfc7eef", "name": "National Grandparents Day", "description": "National Grandparents Day is celebrated on the first Sunday of September after Labor Day in the United States.", "country": "us", "date": 20400909, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "cfaf44dd9c0060ec7a1141369a4182a4", "name": "California Admission Day", "description": "California Admission Day is an annual legal observance in California, in the United States.", "country": "us", "date": 20400909, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "CA (partly)", "states": [ "us-ca" ] }, { "uuid": "23a9785a3ba25070e48687c3f98edd77", "name": "World Suicide Prevention Day", "description": "World Suicide Prevention Day promotes worldwide action to prevent suicides on September 10 each year.", "country": "us", "date": 20400910, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "982868b4880c06544c5842e38938f36c", "name": "First Responders Day", "description": "First Responders Day is a state observance in the USA", "country": "us", "date": 20400911, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "NC", "states": [ "us-nc" ] }, { "uuid": "e5e8113f951674aaaec62ce9fba48582", "name": "Patriot Day", "description": "Patriot Day is held in memory of nearly 3000 people who died during terrorist attacks in New York, Washington DC and Shanksville, Pennsylvania, in the United States.", "country": "us", "date": 20400911, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "e5e8113f951674aaaec62ce9fba48582", "name": "Patriot Day", "description": "Patriot Day is held in memory of nearly 3000 people who died during terrorist attacks in New York, Washington DC and Shanksville, Pennsylvania, in the United States.", "country": "us", "date": 20400911, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "AK", "states": [ "us-ak" ] }, { "uuid": "fb216d95beea22061fd539e2aa2c2e9b", "name": "International Day for South-South Cooperation", "description": "The United Nations Day for South-South Cooperation is observed on September 12 each year.", "country": "us", "date": 20400912, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "fb03de8e2d2ad6a948f0e9b9cae9c955", "name": "International Programmers' Day", "description": "Many people celebrate International Programmers’ Day on January 7, while others observe this event on the 256th day of the year, usually on September 13 or on September 12 in leap years.", "country": "us", "date": 20400912, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "613f559facaded2f86add3fe317fdefb", "name": "International Day of Democracy", "description": "The United Nations’ (UN) International Day of Democracy is observed on September 15 each year.", "country": "us", "date": 20400915, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "f3a73d569fd9d3c4d41c4c1a26f6cb66", "name": "First Day of National Hispanic Heritage Month", "description": "First Day of National Hispanic Heritage Month is a annual monthly observance in the USA", "country": "us", "date": 20400915, "type": [ "Observance" ], "primary_type": "Annual Monthly Observance", "locations": "All", "states": "All" }, { "uuid": "e033dac42c15fb2c030e01968e3d6b95", "name": "International Day for the Preservation of the Ozone Layer", "description": "The United Nations' (UN) International Day for the Preservation of the Ozone Layer focuses on the importance of protecting human health and the environment.", "country": "us", "date": 20400916, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "d0ab54c3b29e32745979b404f8806bed", "name": "Constitution Commemoration Day", "description": "Constitution Day and Citizenship Day is a combined event that occurs in the United States on September 17 each year.", "country": "us", "date": 20400916, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "AZ", "states": [ "us-az" ] }, { "uuid": "4f0955fc2c27796aed832765ad36ca85", "name": "Yom Kippur", "description": "Yom Kippur is an important Jewish holiday that falls on the 10th day of the month of Tishrei in the Jewish calendar.", "country": "us", "date": 20400917, "type": [ "Hebrew" ], "primary_type": "Jewish holiday", "locations": "All", "states": "All" }, { "uuid": "534ca12818a4afc3f10ec34213f90a9f", "name": "World Patient Safety Day", "description": "World Patient Safety Day is a United Nations observance in the USA", "country": "us", "date": 20400917, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "d0ab54c3b29e32745979b404f8806bed", "name": "Constitution Day and Citizenship Day", "description": "Constitution Day and Citizenship Day is a combined event that occurs in the United States on September 17 each year.", "country": "us", "date": 20400917, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "55c63617c283d68bac884f45982e72c5", "name": "Yom Kippur", "description": "Yom Kippur is an important Jewish holiday that falls on the 10th day of the month of Tishrei in the Jewish calendar.", "country": "us", "date": 20400917, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "TX (optional)", "states": [ "us-tx" ] }, { "uuid": "51d81bb693f6f903d84f171b3162ce8a", "name": "International Equal Pay Day", "description": "International Equal Pay Day is a United Nations observance in the USA", "country": "us", "date": 20400918, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "8054a6cc8cf93bd9817e966451e53ba5", "name": "Air Force Birthday", "description": "Air Force Birthday is a observance in the USA", "country": "us", "date": 20400918, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "e93436942d24350d58f7b7bb1ebb1c28", "name": "International Day of Peace", "description": "The United Nations' (UN) International Day of Peace is annually held on September 21 to recognize the efforts of individuals, organizations and governments to end conflict and promote peace.", "country": "us", "date": 20400921, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "0181d470abd9d3a2049c88e8ade7af82", "name": "National POW/MIA Recognition Day", "description": "National POW/MIA Recognition Day is annually observed in the United States on the third Friday of September.", "country": "us", "date": 20400921, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "b5eb2d6ce9d7614bd6463f9b74c00b43", "name": "First Day of Sukkot", "description": "The first day of Sukkot marks the start of the Sukkot festival for Jewish communities in many countries, including the United States.", "country": "us", "date": 20400922, "type": [ "Hebrew" ], "primary_type": "Jewish holiday", "locations": "All", "states": "All" }, { "uuid": "bb37d8dcc96153cc6f739d30f75a5680", "name": "Public Lands Day", "description": "Public Lands Day is a state observance in the USA", "country": "us", "date": 20400922, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "WY", "states": [ "us-wy" ] }, { "uuid": "9e97be526087cf1a9ec9fd9113032726", "name": "Emancipation Day", "description": "Emancipation Day is a state-wide observation in Ohio on September 22.", "country": "us", "date": 20400922, "type": [ "Local observance" ], "primary_type": "Local observance", "locations": "OH", "states": [ "us-oh" ] }, { "uuid": "7c877ecb4a1a10f39181a0d3f4db914d", "name": "National Public Lands Day", "description": "National Public Lands Day is a observance in the USA", "country": "us", "date": 20400922, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "a5886522893924928a703a68d0d9a35e", "name": "September Equinox", "description": "September Equinox in the USA (New York)", "country": "us", "date": "20400922T05:44:5404:00", "type": [ "Season" ], "primary_type": "Season", "locations": "All", "states": "All" }, { "uuid": "6280da167e9e102cc915b7c66fb32e2e", "name": "International Day of Sign Languages", "description": "International Day of Sign Languages is a United Nations observance in the USA", "country": "us", "date": 20400923, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "22420ea8518f75ff6c9b903e5a59f936", "name": "International Celebrate Bisexuality Day", "description": "International Celebrate Bisexuality Day, also known as Bi Visibility Day, promotes the rights of bisexual people around the world.", "country": "us", "date": 20400923, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "25e7166a3ec7c1b6396e3223077ace2b", "name": "American Indian Day", "description": "American Indian Day is a state observance in the USA", "country": "us", "date": 20400924, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "TN", "states": [ "us-tn" ] }, { "uuid": "302e8db884cdea1d702e76ce5e29e103", "name": "International Day for the Total Elimination of Nuclear Weapons", "description": "The International Day for the Total Elimination of Nuclear Weapons raises awareness about the dangers of nuclear weapons.", "country": "us", "date": 20400926, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "d580281438be4930865112bcd2e168e0", "name": "World Maritime Day", "description": "World Maritime Day is held on the last week of September each year, although the exact date is up to individual governments around the world.", "country": "us", "date": 20400927, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "dbffa8af5893569c1af2ff795b322f5e", "name": "World Tourism Day", "description": "The United Nations’ (UN) World Tourism Day is annually held on September 27 to raise awareness on the benefits of tourism.", "country": "us", "date": 20400927, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "a0f8e75b1e323a5ca29774479d8cca1d", "name": "Last Day of Sukkot", "description": "Many Jewish communities in countries such as the United States observe the last day of Sukkot, which marks the end of the Sukkot festival.", "country": "us", "date": 20400928, "type": [ "Hebrew" ], "primary_type": "Jewish holiday", "locations": "All", "states": "All" }, { "uuid": "a856c74976e5481403a44b1e873cc050", "name": "International Day for Universal Access to Information", "description": "International Day for Universal Access to Information is a United Nations observance in the USA", "country": "us", "date": 20400928, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "f7effc05d6811fbd8a3247a89f0d13ea", "name": "World Rabies Day", "description": "World Rabies Day is annually observed on September 28 to raise awareness about rabies and how it can be prevented.", "country": "us", "date": 20400928, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "8b5e1a7b3432455de7e50d6085c0ed3a", "name": "Native American Day", "description": "Native Americans' Day, on the second Monday of October, is celebrated some parts of the United States in lieu of Columbus Day.", "country": "us", "date": 20400928, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "NV", "states": [ "us-nv" ] }, { "uuid": "8b5e1a7b3432455de7e50d6085c0ed3a", "name": "Native American Day", "description": "Native Americans' Day, on the second Monday of October, is celebrated some parts of the United States in lieu of Columbus Day.", "country": "us", "date": 20400928, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "CA", "states": [ "us-ca" ] }, { "uuid": "509b6628e226628c5e152c082fdd4fd1", "name": "American Indian Heritage Day", "description": "American Indian Heritage Day is often observed on the Friday after Thanksgiving Day in the United States.", "country": "us", "date": 20400928, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "TX", "states": [ "us-tx" ] }, { "uuid": "509b6628e226628c5e152c082fdd4fd1", "name": "American Indian Heritage Day", "description": "American Indian Heritage Day is often observed on the Friday after Thanksgiving Day in the United States.", "country": "us", "date": 20400928, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "MT", "states": [ "us-mt" ] }, { "uuid": "c994b0086668d5f6d4ba552cfaff1d6f", "name": "Michigan Indian Day", "description": "Michigan Indian Day is a state observance in the USA", "country": "us", "date": 20400928, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "MI", "states": [ "us-mi" ] }, { "uuid": "d0424383d327e020d81b8d78264511c0", "name": "Shmini Atzeret", "description": "Shemini Atzeret (or Shmini Atzeret) is a Jewish holiday dedicated to the love of God, while Simchat Torah (Simchas Torah or Simhat Torah) marks the end of Sukkot and celebrates the completion of the annual reading of the Torah.", "country": "us", "date": 20400929, "type": [ "Hebrew" ], "primary_type": "Jewish holiday", "locations": "All", "states": "All" }, { "uuid": "f3470ece45e71a97caa7458c4842cc50", "name": "International Day of Awareness of Food Loss and Waste", "description": "International Day of Awareness of Food Loss and Waste is a United Nations observance in the USA", "country": "us", "date": 20400929, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "3a9094cd1482cf2ebee9c6db577a71ae", "name": "World Heart Day", "description": "World Heart Day raises awareness of cardiovascular diseases and ways to reduce their risk.", "country": "us", "date": 20400929, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "fadad20ae4a01f52ee779ce9734b6577", "name": "Simchat Torah", "description": "Simchat Torah (Simchas Torah or Simhat Torah) is a Jewish holiday that marks the end of Sukkot and celebrates the completion of the annual reading of the Torah.", "country": "us", "date": 20400930, "type": [ "Hebrew" ], "primary_type": "Jewish holiday", "locations": "All", "states": "All" }, { "uuid": "d6f264b0fee5e4c2b7faf4554bef9411", "name": "International Translation Day", "description": "International Translation Day is a United Nations observance in the USA", "country": "us", "date": 20400930, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "3b328f35a3db9ff84cc843e940dc7da2", "name": "Gold Star Mother's Day", "description": "Gold Star Mother’s Day is annually observed in the United States on the last Sunday of September.", "country": "us", "date": 20400930, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "1b2fe0f2fbd40695b87c561e7b1928b5", "name": "International Day of Older Persons", "description": "The United Nations' (UN) International Day of Older Persons is celebrated on October 1 each year as a special day for older persons worldwide.", "country": "us", "date": 20401001, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "bcdcd72a3b2095d9a6463bf79d907907", "name": "World Habitat Day", "description": "The United Nations’ (UN) World Habitat Day reflects on the state of human settlements and people’s right to sufficient shelter.", "country": "us", "date": 20401001, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "b493e10af61583fbda3048c674376e3a", "name": "World Vegetarian Day", "description": "World Vegetarian Day is an annual observation that spreads awareness about the health, environmental, and ethical benefits of following a vegetarian lifestyle. The unofficial holiday encourages people to avoid eating foods that include animal products and to adopt a plant-based diet.", "country": "us", "date": 20401001, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "4070cfe087fae15205a36f65574c9a82", "name": "Frances Xavier Cabrini Day", "description": "Frances Xavier Cabrini Day is a state holiday in the USA", "country": "us", "date": 20401001, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "CO", "states": [ "us-co" ] }, { "uuid": "55f1679202849707ce60cb3eb38bc81d", "name": "Child Health Day", "description": "Child Health Day is annually celebrated in the United States on the first Monday of October.", "country": "us", "date": 20401001, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "33829ed2c5407a7a689e78b61a262f9d", "name": "International Day of Non-Violence", "description": "The United Nations’ (UN) International Day of Non-Violence is a globally observed on October 2 each year to promote non-violence.", "country": "us", "date": 20401002, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "f4ba4a2fdea81a5f605617650fe468c1", "name": "Lailat al-Qadr", "description": "Laylat al Qadr is most likely to be held on one of the last 10 days of month of Ramadan in the Islamic calendar.", "country": "us", "date": 20401003, "type": [ "Muslim" ], "primary_type": "Muslim", "locations": "All", "states": "All" }, { "uuid": "5e871615ced0cd8cf9b1250ca156f801", "name": "Feast of St Francis of Assisi", "description": "Many Catholics in the United States, particularly those with pets, celebrate the Feast of St Francis of Assisi, the patron saint of animals and the environment, on October 4 each year.", "country": "us", "date": 20401004, "type": [ "Christian" ], "primary_type": "Christian", "locations": "All", "states": "All" }, { "uuid": "eacab490d2658decfce2c07c3d29213f", "name": "World Teachers' Day", "description": "The United Nations' (UN) World Teachers' Day commemorates the work of teachers and their contributions to society. It is observed on October 5 each year.", "country": "us", "date": 20401005, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "f0a9d485197bd77327bbdf5dda04aa80", "name": "World Cerebral Palsy Day", "description": "World Cerebral Palsy Day is an annual awareness observation that brings together people with cerebral palsy, their families and loved ones, and organizations working to ensure equal rights for them.", "country": "us", "date": 20401006, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "8855b8afa02587551cc2dcaa10ed4ac8", "name": "German American Day", "description": "German American Day is a observance in the USA", "country": "us", "date": 20401006, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "90d8106fd5deefcc7d88c0ff5d5ac512", "name": "Eid al-Fitr", "description": "Eid al-Fitr is a holiday to mark the end of the Islamic month of Ramadan, during which Muslims fast during the hours of daylight.", "country": "us", "date": 20401008, "type": [ "Muslim" ], "primary_type": "Muslim", "locations": "All", "states": "All" }, { "uuid": "cfdd6a849c545010ac2600a0dbefd59b", "name": "Columbus Day", "description": "Columbus Day celebrates 15th century explorer Christopher Columbus's arrival in America in 1492.", "country": "us", "date": 20401008, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "22 states", "states": [ "us-al", "us-az", "us-ct", "us-ga", "us-id", "us-il", "us-in", "us-ks", "us-ma", "us-md", "us-mn", "us-mo", "us-mt", "us-ne", "us-nj", "us-ny", "us-oh", "us-pa", "us-ri", "us-ut", "us-va", "us-wv" ] }, { "uuid": "cfdd6a849c545010ac2600a0dbefd59b", "name": "Columbus Day", "description": "Columbus Day celebrates 15th century explorer Christopher Columbus's arrival in America in 1492.", "country": "us", "date": 20401008, "type": [ "Local holiday" ], "primary_type": "State Legal Holiday", "locations": "TN", "states": [ "us-tn" ] }, { "uuid": "cfdd6a849c545010ac2600a0dbefd59b", "name": "Columbus Day", "description": "Columbus Day celebrates 15th century explorer Christopher Columbus's arrival in America in 1492.", "country": "us", "date": 20401008, "type": [ "National holiday" ], "primary_type": "Federal Holiday", "locations": "All", "states": "All" }, { "uuid": "cb35026b4d8f1e3e55d95e724a83a4f6", "name": "Fraternal Day", "description": "Fraternal Day is a state holiday in the USA", "country": "us", "date": 20401008, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "AL", "states": [ "us-al" ] }, { "uuid": "54ea29ded6821273a00dac2496acc28b", "name": "Yorktown Victory Day", "description": "Yorktown Victory Day is a state holiday in the USA", "country": "us", "date": 20401008, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "VA", "states": [ "us-va" ] }, { "uuid": "4e755e9627d626bd901e07f1c1f0a481", "name": "Discoverers’ Day", "description": "Discoverers’ Day is a state observance in the USA", "country": "us", "date": 20401008, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "HI", "states": [ "us-hi" ] }, { "uuid": "8b5e1a7b3432455de7e50d6085c0ed3a", "name": "Native American Day", "description": "Native Americans' Day, on the second Monday of October, is celebrated some parts of the United States in lieu of Columbus Day.", "country": "us", "date": 20401008, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "OK", "states": [ "us-ok" ] }, { "uuid": "8b5e1a7b3432455de7e50d6085c0ed3a", "name": "Native American Day", "description": "Native Americans' Day, on the second Monday of October, is celebrated some parts of the United States in lieu of Columbus Day.", "country": "us", "date": 20401008, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "SD", "states": [ "us-sd" ] }, { "uuid": "9ff6a0334d6c8d38193c33300aa2f616", "name": "Indigenous People's Day", "description": "Indigenous People's Day is a state observance in the USA", "country": "us", "date": 20401008, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "28 states", "states": [ "us-ak", "us-az", "us-co", "us-ia", "us-in", "us-ks", "us-ky", "us-ma", "us-md", "us-mt", "us-nv", "us-nh", "us-nj", "us-ny", "us-nc", "us-nd", "us-oh", "us-ok", "us-or", "us-pa", "us-tn", "us-tx", "us-ut", "us-vt", "us-va", "us-wa", "us-wv", "us-wi" ] }, { "uuid": "9ff6a0334d6c8d38193c33300aa2f616", "name": "Indigenous People's Day", "description": "Indigenous People's Day is a state observance in the USA", "country": "us", "date": 20401008, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "MI, MN", "states": [ "us-mi", "us-mn" ] }, { "uuid": "9ff6a0334d6c8d38193c33300aa2f616", "name": "Indigenous People's Day", "description": "Indigenous People's Day is a state holiday in the USA", "country": "us", "date": 20401008, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "DC, ME, NE, NM", "states": [ "us-dc", "us-me", "us-ne", "us-nm" ] }, { "uuid": "509b6628e226628c5e152c082fdd4fd1", "name": "American Indian Heritage Day", "description": "American Indian Heritage Day is often observed on the Friday after Thanksgiving Day in the United States.", "country": "us", "date": 20401008, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "AL", "states": [ "us-al" ] }, { "uuid": "df3a19d9d2ab2a315769febf33c8df32", "name": "World Post Day", "description": "World Post Day marks the anniversary of the Universal Postal Union's establishment in 1874. It is held on October 9 each year.", "country": "us", "date": 20401009, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "b04e9216e9f0d7ef3822b04e9c665552", "name": "Leif Erikson Day", "description": "Leif Erikson Day honors the first Scandinavian known to have set foot on American soil and the contribution of the Nordic peoples to the United States.", "country": "us", "date": 20401009, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "b04e9216e9f0d7ef3822b04e9c665552", "name": "Leif Erikson Day", "description": "Leif Erikson Day honors the first Scandinavian known to have set foot on American soil and the contribution of the Nordic peoples to the United States.", "country": "us", "date": 20401009, "type": [ "Local observance" ], "primary_type": "Local observance", "locations": "CO", "states": [ "us-co" ] }, { "uuid": "9e0086db4a1ead6b358a2f669fe2bf58", "name": "International Day for Natural Disaster Reduction", "description": "The United Nations’ (UN) International Day for Natural Disaster Reduction is annually observed on the second Wednesday of October to promote a global culture of natural disaster risk reduction.", "country": "us", "date": 20401010, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "3f4378c73925c91115a4f18f46fdf773", "name": "World Mental Health Day", "description": "World Mental Health Day, which is supported by the United Nations (UN), is annually held on October 10 to raise public awareness about mental health issues worldwide.", "country": "us", "date": 20401010, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "f2a06ad8a8f2ab2b6901cf92a3c2a410", "name": "International Day of the Girl Child", "description": "The International Day of the Girl Child is a United Nations (UN) observance on October 11 each year.", "country": "us", "date": 20401011, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "9a6a447f57037b22a947f7ea3e3c09ff", "name": "World Sight Day", "description": "World Sight Day is annually held on the second Thursday of October to raise awareness about blindness and vision impairment.", "country": "us", "date": 20401011, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "d6c017aa5e052d8f217d6138207c5e09", "name": "Casimir Pulaski Day", "description": "Casimir Pulaski Day is a day off for some schools and offices in Illinois, USA, on the first Monday of March each year.", "country": "us", "date": 20401011, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "MI", "states": [ "us-mi" ] }, { "uuid": "d6c017aa5e052d8f217d6138207c5e09", "name": "Casimir Pulaski Day", "description": "Casimir Pulaski Day is a day off for some schools and offices in Illinois, USA, on the first Monday of March each year.", "country": "us", "date": 20401011, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "MI", "states": [ "us-mi" ] }, { "uuid": "d6c017aa5e052d8f217d6138207c5e09", "name": "Casimir Pulaski Day", "description": "Casimir Pulaski Day is a day off for some schools and offices in Illinois, USA, on the first Monday of March each year.", "country": "us", "date": 20401011, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "RI", "states": [ "us-ri" ] }, { "uuid": "d6c017aa5e052d8f217d6138207c5e09", "name": "Anniversary of Death of General Pulaski", "description": "Casimir Pulaski Day is a day off for some schools and offices in Illinois, USA, on the first Monday of March each year.", "country": "us", "date": 20401011, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "MA", "states": [ "us-ma" ] }, { "uuid": "d8cca1c3d9b6f06cae01cc4eb7528fca", "name": "World Migratory Bird Day", "description": "World Migratory Bird Day is observed the second weekend of May every year.", "country": "us", "date": 20401013, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "ca60dd3b1d6651c12602d37892ed1d90", "name": "Navy Birthday", "description": "Navy Birthday celebrates the establishment of the United States Navy on October 13, 1775.", "country": "us", "date": 20401013, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "7056b3c7e3395d198fb31dc0bdb73004", "name": "Robert E. Lee's Birthday", "description": "Robert E. Lee’s birthday is an annual official state holiday that is shared with Martin Luther King’s birthday in some parts of the US.", "country": "us", "date": 20401013, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "AR", "states": [ "us-ar" ] }, { "uuid": "009fdf9227b5e15f069a8589e48f5125", "name": "International Day of Rural Women", "description": "The United Nations’ (UN) International Day of Rural Women is annually celebrated on October 15 to recognize rural women’s role in supporting their communities.", "country": "us", "date": 20401015, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "86b44c4b65f4aa42ff2d973196463a93", "name": "White Cane Safety Day", "description": "White Cane Safety Day is a United States observance annually held on October 15 to celebrate blind and visually impaired people's achievements and the importance of the white cane.", "country": "us", "date": 20401015, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "d5c423129eeda9be21619d83c0da409d", "name": "World Food Day", "description": "World Food Day is celebrated on October 16 each year.", "country": "us", "date": 20401016, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "5abc537885c38df1fdb08107194d1aca", "name": "Boss's Day", "description": "Boss’s Day is observed in many workplaces in the United States on October 16, or the nearest working day, each year.", "country": "us", "date": 20401016, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "8574ef3bd839199470f11faf1d886fcf", "name": "International Day for the Eradication of Poverty", "description": "The United Nations’ (UN) International Day for the Eradication of Poverty is annually observed on October 17 to promote awareness of the need to eradicate poverty worldwide.", "country": "us", "date": 20401017, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "02a38f9bfad272cf4f830f02c912f702", "name": "Alaska Day", "description": "Alaska Day is an official holiday in Alaska, the United States, on October 18 each year. It commemorates the formal transfer of Alaska from Russia to the United States on October 18, 1867.", "country": "us", "date": 20401018, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "AK", "states": [ "us-ak" ] }, { "uuid": "e42b5dcdb2051aaf475b06e1aa1adf50", "name": "Sweetest Day", "description": "Sweetest Day is a observance in the USA", "country": "us", "date": 20401020, "type": [ "Observance" ], "primary_type": "Observance", "locations": "13 states", "states": [ "us-il", "us-in", "us-ky", "us-mi", "us-mo", "us-nd", "us-oh", "us-sd", "us-wi", "us-wv", "us-wa", "us-ny", "us-pa" ] }, { "uuid": "395b659ab722f9be2f4d5cf654285bc3", "name": "United Nations Day", "description": "United Nations Day marks the anniversary of the United Nations Charter coming into force in 1945 and celebrates the work of this organization. United Nations Day annually falls on October 24.", "country": "us", "date": 20401024, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "10c7c1c7eebaac3c68e13c17c34ca518", "name": "World Development Information Day", "description": "The United Nations' (UN) World Development Information Day falls on October 24 each year.", "country": "us", "date": 20401024, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "19b74a8612b959b83d1f4ff39262615c", "name": "Nevada Day", "description": "Nevada Day is an annual state holiday celebrated in Nevada, the United States, on the last Friday of October. It commemorates the statehood of Nevada, which took place on October 31, 1864.", "country": "us", "date": 20401026, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "NV", "states": [ "us-nv" ] }, { "uuid": "3cc864b2a06c1b55b1ab03ea131950f5", "name": "World Day for Audiovisual Heritage", "description": "The World Day for Audiovisual Heritage is observed on October 27 every year.", "country": "us", "date": 20401027, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "abb58980bf9eb0046870269035fc93b3", "name": "World Stroke Day", "description": "World Stroke Day is annually held on October 29 to raise awareness about stroke and ways to combat it.", "country": "us", "date": 20401029, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "ee51bba46e66f8ee9ef07d2e9486cc0b", "name": "World Cities Day", "description": "World Cities Day is a UN observance that aims to recognize the role of cities as a foundation for social and economic development.", "country": "us", "date": 20401031, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "537802593ce2aa858ab05b5561ddd930", "name": "Halloween", "description": "Halloween is celebrated by hosting costume parties, playing 'trick-or-treat', watching horror films, visiting haunted houses or carving lanterns out of pumpkins.", "country": "us", "date": 20401031, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "2479154727a9af2e2ee42f2358493755", "name": "All Saints' Day", "description": "Many Catholics honor all the saints on All Saints' Day, also known as All Hallows' Day, in the United States.", "country": "us", "date": 20401101, "type": [ "Christian" ], "primary_type": "Christian", "locations": "All", "states": "All" }, { "uuid": "0226e4ddbe4b88e910f6788e24ce3686", "name": "World Vegan Day", "description": "World Vegan Day is an annual observation that brings together vegans around the world to bring attention to animal rights and to spread the word about the health advantages of following a vegan diet.", "country": "us", "date": 20401101, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "1bb9323965c7885ee4572d7217ecf9fb", "name": "First Day of Native American Heritage Month", "description": "First Day of Native American Heritage Month is a annual monthly observance in the USA", "country": "us", "date": 20401101, "type": [ "Observance" ], "primary_type": "Annual Monthly Observance", "locations": "All", "states": "All" }, { "uuid": "5d03453269740d817c4171eddaf0ee0d", "name": "All Souls' Day", "description": "Prayers for the dead are made on All Souls’ Day in the United States, which falls on November 2 each year. The Day of the Dead is also celebrated on this day.", "country": "us", "date": 20401102, "type": [ "Christian" ], "primary_type": "Christian", "locations": "All", "states": "All" }, { "uuid": "ec827057d22f7f0f59042f916f9bf91a", "name": "International Day to End Impunity for Crimes against Journalists", "description": "The International Day to End Impunity for Crimes against Journalists raises awareness about violence against journalists.", "country": "us", "date": 20401102, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "7bcbe3c82e3cdf2d37cf5f13b5f7ecbc", "name": "New York City Marathon", "description": "The New York City Marathon is one of the world's largest marathons and takes place every year in November.", "country": "us", "date": 20401104, "type": [ "Sporting event" ], "primary_type": "Sporting event", "locations": "All", "states": "All" }, { "uuid": "77b6082282be84a3101e54edb8201421", "name": "Daylight Saving Time ends", "description": "Daylight Saving Time ends in the USA", "country": "us", "date": "20401104T02:00:0004:00", "type": [ "Clock change/Daylight Saving Time" ], "primary_type": "Clock change/Daylight Saving Time", "locations": "All", "states": "All" }, { "uuid": "fdbdd856c1a8acfe6607810ca9723cae", "name": "World Tsunami Awareness Day", "description": "World Tsunami Awareness Day is a United Nations observance in the USA", "country": "us", "date": 20401105, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "501fdd4c288d1668d26d41663894b4d2", "name": "International Day for Preventing the Exploitation of the Environment in War and Armed Conflict", "description": "The United Nations’ (UN) International Day for Preventing the Exploitation of the Environment in War and Armed Conflict is held on November 6 each year.", "country": "us", "date": 20401106, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "dd264f59e889813d2a4fe375a38b17df", "name": "Election Day (General Election)", "description": "Election Day in the United States of America is the day on which popular ballots are held to select public officials.", "country": "us", "date": 20401106, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "dd264f59e889813d2a4fe375a38b17df", "name": "Election Day", "description": "Election Day in the United States of America is the day on which popular ballots are held to select public officials.", "country": "us", "date": 20401106, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "HI, DE, IL, IN, MI, MT, WV, MD, NJ, NY, RI", "states": [ "us-hi", "us-de", "us-il", "us-in", "us-mi", "us-mt", "us-wv", "us-md", "us-nj", "us-ny", "us-ri" ] }, { "uuid": "dd264f59e889813d2a4fe375a38b17df", "name": "Election Day", "description": "Election Day in the United States of America is the day on which popular ballots are held to select public officials.", "country": "us", "date": 20401106, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "NJ", "states": [ "us-nj" ] }, { "uuid": "dd264f59e889813d2a4fe375a38b17df", "name": "Election Day", "description": "Election Day in the United States of America is the day on which popular ballots are held to select public officials.", "country": "us", "date": 20401106, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "VA", "states": [ "us-va" ] }, { "uuid": "ee34a81ba837643803ed54f74154e632", "name": "Susan B. Anthony Day", "description": "Susan B Anthony Day is an national American observance that is legally recognized in some states.", "country": "us", "date": 20401106, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "WV", "states": [ "us-wv" ] }, { "uuid": "f84dba04c2c3fc3308af5d41ea2f34e2", "name": "Return Day", "description": "Return Day is held on the Thursday after Election Day in Georgetown, Delaware. It is a post-election tradition that celebrates the announcement of the election results with a unique festival and ceremony.", "country": "us", "date": 20401108, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "DE (partly)", "states": [ "us-de" ] }, { "uuid": "7d6b786303f55bb1d12e24fb8aa1a9df", "name": "World Science Day for Peace and Development", "description": "The World Science Day for Peace and Development (WSDPD) is celebrated on November 10 each year.", "country": "us", "date": 20401110, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "c9725c7e73b94564d6d90c83ff185391", "name": "Marine Corps Birthday", "description": "Marine Corps Birthday celebrates the establishment of the United States Marine Corps on November 10, 1775.", "country": "us", "date": 20401110, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "74f1d4f7c4bcb32f28c8f38c97e3dd20", "name": "Singles’ Day", "description": "", "country": "us", "date": 20401111, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "6ad4d26a4fd2c4c4f4e19666c0371ed6", "name": "Veterans Day", "description": "Veterans Day in the USA is a holiday to honor all who have served in the United States Military Services.", "country": "us", "date": 20401111, "type": [ "National holiday" ], "primary_type": "Federal Holiday", "locations": "All", "states": "All" }, { "uuid": "6ad4d26a4fd2c4c4f4e19666c0371ed6", "name": "Veterans Day", "description": "Veterans Day in the USA is a holiday to honor all who have served in the United States Military Services.", "country": "us", "date": 20401111, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "All except MA, MS, NY, RI, TX, WI, WY", "states": [ "us-al", "us-ak", "us-az", "us-ar", "us-ca", "us-co", "us-ct", "us-fl", "us-de", "us-dc", "us-ga", "us-hi", "us-id", "us-il", "us-in", "us-ia", "us-ks", "us-ky", "us-la", "us-md", "us-me", "us-mi", "us-mn", "us-mo", "us-mt", "us-ne", "us-nv", "us-nj", "us-nh", "us-nm", "us-nc", "us-nd", "us-oh", "us-ok", "us-or", "us-pa", "us-sc", "us-sd", "us-tn", "us-ut", "us-vt", "us-va", "us-wa", "us-wv" ] }, { "uuid": "6ad4d26a4fd2c4c4f4e19666c0371ed6", "name": "Veterans Day", "description": "Veterans Day in the USA is a holiday to honor all who have served in the United States Military Services.", "country": "us", "date": 20401111, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "MS, NY, WI", "states": [ "us-ms", "us-ny", "us-wi" ] }, { "uuid": "6ad4d26a4fd2c4c4f4e19666c0371ed6", "name": "Veterans' Day/Armistice Day", "description": "Veterans Day in the USA is a holiday to honor all who have served in the United States Military Services.", "country": "us", "date": 20401111, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "MS", "states": [ "us-ms" ] }, { "uuid": "6ad4d26a4fd2c4c4f4e19666c0371ed6", "name": "Veterans' Day/Armistice Day", "description": "Veterans Day in the USA is a holiday to honor all who have served in the United States Military Services.", "country": "us", "date": 20401111, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "TX", "states": [ "us-tx" ] }, { "uuid": "6ad4d26a4fd2c4c4f4e19666c0371ed6", "name": "Veterans' Day/Armistice Day", "description": "Veterans Day in the USA is a holiday to honor all who have served in the United States Military Services.", "country": "us", "date": 20401111, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "RI", "states": [ "us-ri" ] }, { "uuid": "cbe6d4aa50b712b6c594d7dcf73df363", "name": "World Pneumonia Day", "description": "World Pneumonia Day supports all efforts made to protect and treat people against pneumonia, the single largest cause of child deaths worldwide.", "country": "us", "date": 20401112, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "99a49941f8dbbaac713afd88152e0e3d", "name": "Barack Obama Day", "description": "Barack Obama Day is a local observance in the USA", "country": "us", "date": 20401112, "type": [ "Local observance" ], "primary_type": "Local observance", "locations": "AL (community)", "states": [ "us-al" ] }, { "uuid": "6ad4d26a4fd2c4c4f4e19666c0371ed6", "name": "Veterans Day (substitute)", "description": "Veterans Day in the USA is a holiday to honor all who have served in the United States Military Services.", "country": "us", "date": 20401112, "type": [ "National holiday" ], "primary_type": "Federal Holiday", "locations": "All", "states": "All" }, { "uuid": "6ad4d26a4fd2c4c4f4e19666c0371ed6", "name": "Veterans Day (substitute)", "description": "Veterans Day in the USA is a holiday to honor all who have served in the United States Military Services.", "country": "us", "date": 20401112, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "MS, NY, WI", "states": [ "us-ms", "us-ny", "us-wi" ] }, { "uuid": "6ad4d26a4fd2c4c4f4e19666c0371ed6", "name": "Veterans Day (substitute)", "description": "Veterans Day in the USA is a holiday to honor all who have served in the United States Military Services.", "country": "us", "date": 20401112, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "All except MA, MS, NY, RI, TX, WI, WY", "states": [ "us-al", "us-ak", "us-az", "us-ar", "us-ca", "us-co", "us-ct", "us-fl", "us-de", "us-dc", "us-ga", "us-hi", "us-id", "us-il", "us-in", "us-ia", "us-ks", "us-ky", "us-la", "us-md", "us-me", "us-mi", "us-mn", "us-mo", "us-mt", "us-ne", "us-nv", "us-nj", "us-nh", "us-nm", "us-nc", "us-nd", "us-oh", "us-ok", "us-or", "us-pa", "us-sc", "us-sd", "us-tn", "us-ut", "us-vt", "us-va", "us-wa", "us-wv" ] }, { "uuid": "6ad4d26a4fd2c4c4f4e19666c0371ed6", "name": "Veterans' Day/Armistice Day (substitute)", "description": "Veterans Day in the USA is a holiday to honor all who have served in the United States Military Services.", "country": "us", "date": 20401112, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "MS", "states": [ "us-ms" ] }, { "uuid": "6ad4d26a4fd2c4c4f4e19666c0371ed6", "name": "Veterans' Day/Armistice Day (substitute)", "description": "Veterans Day in the USA is a holiday to honor all who have served in the United States Military Services.", "country": "us", "date": 20401112, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "RI", "states": [ "us-ri" ] }, { "uuid": "7d6f3fe17242689d074911064942c521", "name": "World Diabetes Day", "description": "World Diabetes Day is held annually to raise awareness of diabetes and its complications and the care that people with this condition need. It is observed on November 14 each year.", "country": "us", "date": 20401114, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "b828b893cd8552034c9ce413a59b5d57", "name": "World Philosophy Day", "description": "World Philosophy Day is celebrated on the third Thursday of November each year.", "country": "us", "date": 20401115, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "f6866b8a62c29386ab89ea57ac52653a", "name": "International Day for Tolerance", "description": "The United Nations’ (UN) International Day for Tolerance is observed on November 16 each year to help people understand the importance of tolerance worldwide.", "country": "us", "date": 20401116, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "45cf0afcadaad26ddd7f59660c39e3a1", "name": "Fake Friday", "description": "Many early-bird shoppers look for bargains on Fake Friday to get ahead of the crowds in stores on Black Friday, observed a week later.", "country": "us", "date": 20401116, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "0bcb9a0b44cbadefb13ea37257893b2b", "name": "World Prematurity Day", "description": " World Prematurity Day is an annual observance that is dedicated to raising awareness about the health and emotional issues surrounding preterm birth.", "country": "us", "date": 20401117, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "fd94246ff406a42fa104c51cca0c450c", "name": "World Day of Remembrance for Road Traffic Victims", "description": "The World Day of Remembrance for Road Traffic Victims serves as a major advocacy day for road traffic injury prevention.", "country": "us", "date": 20401118, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "a519c07009b381005b8f748a0c787f20", "name": "World Toilet Day", "description": "World Toilet Day aims to promote public awareness of the need for adequate toilets to improve people’s health and save lives.", "country": "us", "date": 20401119, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "82b35785dd93cda6423ef7710e7436f8", "name": "International Men's Day", "description": "International Men’s Day celebrates men's achievements worldwide and throughout history.", "country": "us", "date": 20401119, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "fc713c8ec34b6b45fe89dc4e88afd287", "name": "George Rogers Clark Day", "description": "George Rogers Clark Day is a state observance in the USA", "country": "us", "date": 20401119, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "OH", "states": [ "us-oh" ] }, { "uuid": "6ed440a863f2955967525e152dbb36d0", "name": "Universal Children's Day", "description": "The United Nations' (UN) Universal Children's Day is an occasion to promote the welfare of children and an understanding between children all over the world. It is held on November 20 each year", "country": "us", "date": 20401120, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "3612cafd7848319ee6a3ac62ed0e74ee", "name": "Africa Industrialization Day", "description": "Africa Industrialization Day aims to stimulate the international community's commitment to the industrialization of Africa.", "country": "us", "date": 20401120, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "f4c84f5123b029aeead546c38641b8a1", "name": "Transgender Day of Remembrance", "description": "Transgender Day of Remembrance is a worldwide observance in the USA", "country": "us", "date": 20401120, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "5c5a5784cf9f6e4f7a93bbf1c45ef882", "name": "World Television Day", "description": "The United Nations’ (UN) World Television Day is globally celebrated on November 21 each year.", "country": "us", "date": 20401121, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "f8c85f44d3d5629d9197d68bf1c1589e", "name": "Thanksgiving Day", "description": "Thanksgiving Day in the United States is traditionally a holiday to give thanks for the food collected at the end of the harvest season.", "country": "us", "date": 20401122, "type": [ "National holiday" ], "primary_type": "Federal Holiday", "locations": "All", "states": "All" }, { "uuid": "f8c85f44d3d5629d9197d68bf1c1589e", "name": "Thanksgiving Day", "description": "Thanksgiving Day in the United States is traditionally a holiday to give thanks for the food collected at the end of the harvest season.", "country": "us", "date": 20401122, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "All", "states": [ "us-al", "us-ak", "us-az", "us-ar", "us-ca", "us-co", "us-ct", "us-fl", "us-de", "us-dc", "us-ga", "us-hi", "us-id", "us-il", "us-in", "us-ia", "us-ks", "us-ky", "us-la", "us-ma", "us-me", "us-md", "us-mi", "us-mn", "us-mo", "us-ms", "us-mt", "us-ne", "us-nh", "us-nv", "us-nj", "us-nm", "us-nc", "us-ny", "us-nd", "us-oh", "us-ok", "us-or", "us-pa", "us-ri", "us-sc", "us-sd", "us-tn", "us-tx", "us-ut", "us-vt", "us-va", "us-wa", "us-wv", "us-wy", "us-wi" ] }, { "uuid": "7ee2eb4d9f821c6ccd4087d14e53bafd", "name": "State Holiday", "description": "State Holiday is a state holiday in the USA", "country": "us", "date": 20401123, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "GA", "states": [ "us-ga" ] }, { "uuid": "a6701e379600f1cab280dd473ce59126", "name": "Presidents' Day (Observed)", "description": "Presidents' Day (Observed) is a state holiday in the USA", "country": "us", "date": 20401123, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "NM", "states": [ "us-nm" ] }, { "uuid": "49e5468df04dbe5abe08cf4c949d3462", "name": "Lincoln's Birthday/Lincoln's Day", "description": "Lincoln’s Birthday is observed in the United States in honor of Abraham Lincoln, who was the nation’s 16th president and was known as the Great Emancipator.", "country": "us", "date": 20401123, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "IN", "states": [ "us-in" ] }, { "uuid": "74fc5c4bfbb719433505e971b5aafde5", "name": "Day After Thanksgiving", "description": "The Day After Thanksgiving, also known as Black Friday, is a state holiday more than 20 states.", "country": "us", "date": 20401123, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "WV", "states": [ "us-wv" ] }, { "uuid": "74fc5c4bfbb719433505e971b5aafde5", "name": "Day After Thanksgiving", "description": "The Day After Thanksgiving, also known as Black Friday, is a state holiday more than 20 states.", "country": "us", "date": 20401123, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "19 states", "states": [ "us-ca", "us-de", "us-fl", "us-il", "us-ia", "us-ks", "us-ky", "us-me", "us-mi", "us-mn", "us-nc", "us-ne", "us-nh", "us-ok", "us-pa", "us-sc", "us-tn", "us-tx", "us-va" ] }, { "uuid": "74fc5c4bfbb719433505e971b5aafde5", "name": "Family Day", "description": "The Day After Thanksgiving, also known as Black Friday, is a state holiday more than 20 states.", "country": "us", "date": 20401123, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "NV", "states": [ "us-nv" ] }, { "uuid": "74fc5c4bfbb719433505e971b5aafde5", "name": "Acadian Day", "description": "The Day After Thanksgiving, also known as Black Friday, is a state holiday more than 20 states.", "country": "us", "date": 20401123, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "LA", "states": [ "us-la" ] }, { "uuid": "4cd4f747bc86d708db2ff0ef94c4ef81", "name": "Black Friday", "description": "Black Friday is the day after Thanksgiving Day in the USA. It is a busy shopping day and is a holiday in some states.", "country": "us", "date": 20401123, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "509b6628e226628c5e152c082fdd4fd1", "name": "American Indian Heritage Day", "description": "American Indian Heritage Day is often observed on the Friday after Thanksgiving Day in the United States.", "country": "us", "date": 20401123, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "MD", "states": [ "us-md" ] }, { "uuid": "7ec561a23fc6fcface0e32a06557b540", "name": "Native American Heritage Day", "description": "Native American Heritage Day is a observance in the USA", "country": "us", "date": 20401123, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "7ec561a23fc6fcface0e32a06557b540", "name": "Native American Heritage Day", "description": "Native American Heritage Day is a state holiday in the USA", "country": "us", "date": 20401123, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "WA", "states": [ "us-wa" ] }, { "uuid": "309cd492182ea4a46a09d0ddbe089c0b", "name": "International Day for the Elimination of Violence against Women", "description": "The United Nations' (UN) International Day for the Elimination of Violence against Women raises public awareness of violence against women in all countries around the world and at all levels of society. It is observed each year on November 25.", "country": "us", "date": 20401125, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "880e7535b63ac2a5da52ac95a3ebd6df", "name": "Cyber Monday", "description": "Most online retailers in the US offer discounted prices on their products and services on Cyber Monday.", "country": "us", "date": 20401126, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "1c8a369ca2bf32a129e6a231a3674a35", "name": "Giving Tuesday", "description": "", "country": "us", "date": 20401127, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "b1813e6361112e797605455c840bef4e", "name": "Giving Tuesday", "description": "The first Tuesday after Thanksgiving has been dubbed “Giving Tuesday” by charities.", "country": "us", "date": 20401127, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "a3fc6c9ae85a92e3f16e4d97b0edae1d", "name": "International Day of Solidarity with the Palestinian People", "description": "The United Nations’ (UN) International Day of Solidarity with the Palestinian People is annually observed on November 29.", "country": "us", "date": 20401129, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "a1213b614fb52b401cfa1726b0bcc8c2", "name": "Nellie Tayloe Ross's Birthday", "description": "Nellie Tayloe Ross's Birthday is a state observance in the USA", "country": "us", "date": 20401129, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "WY", "states": [ "us-wy" ] }, { "uuid": "be75a4711c1acd0b8dea915acb37715d", "name": "Chanukah/Hanukkah (first day)", "description": "The first day of Hanukkah is the start of the Hanukkah period, which lasts for eight days, from the 25th day of the month of Kislev to the second day of Tevet in the Hebrew calendar.", "country": "us", "date": 20401130, "type": [ "Hebrew" ], "primary_type": "Jewish holiday", "locations": "All", "states": "All" }, { "uuid": "83f04aaedfd7c2a739f7474c5a653acb", "name": "Day of Remembrance for all Victims of Chemical Warfare", "description": "The UN’s Day of Remembrance for all Victims of Chemical Warfare is annually observed on April 29.", "country": "us", "date": 20401130, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "ded8126853354d07ff24c498b1546902", "name": "World AIDS Day", "description": "The United Nations' (UN) World AIDS Day is annually observed on December 1.", "country": "us", "date": 20401201, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "e398c79dbb022098a3cf13d43d8faa5a", "name": "Rosa Parks Day", "description": "The life of American civil rights leader Rosa Parks is celebrated in the United States on either February 4 or December 1.", "country": "us", "date": 20401201, "type": [ "Local observance" ], "primary_type": "Local observance", "locations": "OH", "states": [ "us-oh" ] }, { "uuid": "e398c79dbb022098a3cf13d43d8faa5a", "name": "Rosa Parks Day", "description": "The life of American civil rights leader Rosa Parks is celebrated in the United States on either February 4 or December 1.", "country": "us", "date": 20401201, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "AL", "states": [ "us-al" ] }, { "uuid": "f31382681cbccfce1431d26d772fba0a", "name": "First Sunday of Advent", "description": "Many Christians in the United States observe the first Sunday of Advent, which marks the start of the Christian year.", "country": "us", "date": 20401202, "type": [ "Christian" ], "primary_type": "Christian", "locations": "All", "states": "All" }, { "uuid": "69f9183c9105c303630ac5a6312cdbc0", "name": "International Day for the Abolition of Slavery", "description": "The United Nations’ (UN) International Day for the Abolition of Slavery is annually observed on December 2.", "country": "us", "date": 20401202, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "0c947ead181beab0819e69c5a75fc34f", "name": "International Day of Persons with Disabilities", "description": "The United Nations' (UN) International Day of Persons with Disabilities is annually observed on December 3 to re-affirm and draw attention to the rights of people who live with disabilities.", "country": "us", "date": 20401203, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "f7d2f2220c16c8b16b5464121801bce8", "name": "International Day of Banks", "description": "International Day of Banks is a United Nations observance in the USA", "country": "us", "date": 20401204, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "43371d465d09b16fcb5d6f05afaa3388", "name": "International Volunteer Day for Economic and Social Development", "description": "The United Nations’ (UN) International Volunteer Day for Economic and Social Development, also known as International Volunteer Day (IVD), is observed on December 5 each year.", "country": "us", "date": 20401205, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "8ab599de4f390d545ab96ff78bf29d2d", "name": "World Soil Day", "description": "World Soil Day raises awareness of why soil is needed for sustainable living.", "country": "us", "date": 20401205, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "99ecf2be3592cff74d5427392b243192", "name": "St Nicholas Day", "description": "Some churches in the United States recognize St Nicholas' Day as a feast day.", "country": "us", "date": 20401206, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "2c8bba22a1d3d7fc716564ee25ea9db6", "name": "Last Day of Chanukah", "description": "The last day of Hanukkah marks the end of a festive Jewish occasion, known as Hanukkah or Chanukah.", "country": "us", "date": 20401207, "type": [ "Hebrew" ], "primary_type": "Jewish holiday", "locations": "All", "states": "All" }, { "uuid": "ea5443a44c2dbe59fa3d5cfbc5be7ddc", "name": "International Civil Aviation Day", "description": "International Civil Aviation Day is observed globally on December 7 each year. It is observed by organizations such as the International Civil Aviation Organization (ICAO).", "country": "us", "date": 20401207, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "b6e99df2aa90f32c71a994ab37818163", "name": "Pearl Harbor Remembrance Day", "description": "National Pearl Harbor Remembrance Day remembers those who died or were injured when Pearl Harbor, in Hawaii, was attacked in 1941.", "country": "us", "date": 20401207, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "AK", "states": [ "us-ak" ] }, { "uuid": "b6e99df2aa90f32c71a994ab37818163", "name": "Pearl Harbor Remembrance Day", "description": "National Pearl Harbor Remembrance Day remembers those who died or were injured when Pearl Harbor, in Hawaii, was attacked in 1941.", "country": "us", "date": 20401207, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "b6e99df2aa90f32c71a994ab37818163", "name": "Pearl Harbor Remembrance Day", "description": "National Pearl Harbor Remembrance Day remembers those who died or were injured when Pearl Harbor, in Hawaii, was attacked in 1941.", "country": "us", "date": 20401207, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "WY", "states": [ "us-wy" ] }, { "uuid": "6f6363951114f510fc3e5774b2d84de7", "name": "Delaware Day", "description": "Delaware Day is a state observance in the USA", "country": "us", "date": 20401207, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "DE", "states": [ "us-de" ] }, { "uuid": "0cbef3591f9ba87addd8d4fb341befb3", "name": "Feast of the Immaculate Conception", "description": "The Feast of the Immaculate Conception is a Christian observance on December 8 each year.", "country": "us", "date": 20401208, "type": [ "Christian" ], "primary_type": "Christian", "locations": "All", "states": "All" }, { "uuid": "919aac8b3cbff7e902f4160675e0a5cb", "name": "International Anti-Corruption Day", "description": "The United Nations’ (UN) International Anti-Corruption Day is annually observed on December 9 to raise public awareness of corruption and ways to fight it.", "country": "us", "date": 20401209, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "553b16e2d444cc0f5949fa915953414a", "name": "World Genocide Commemoration Day", "description": "World Genocide Commemoration Day is a UN holiday dedicated to the victims of genocide.", "country": "us", "date": 20401209, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "53ef487d638d1c32b831c698881c2bdb", "name": "Human Rights Day", "description": "Human Rights Day marks the anniversary of when the Universal Declaration of Human Rights was proclaimed.", "country": "us", "date": 20401210, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "8662741ee194c2c1473e613f2496dc8d", "name": "Green Monday", "description": "The last Monday at least ten days before Christmas has been dubbed “Green Monday” by online marketers.", "country": "us", "date": 20401210, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "3705e97549424c387eddf252fb9f32e5", "name": "Wyoming Day", "description": "Wyoming Day is a state observance in the USA", "country": "us", "date": 20401210, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "WY", "states": [ "us-wy" ] }, { "uuid": "115cc8938be52f318334d6d174ef4415", "name": "International Mountain Day", "description": "The United Nations' (UN) International Mountain Day is an occasion to help raise awareness of the people who live in mountainous regions and the role that these regions play in providing food, water, and recreation. It is observed on December 11 each year.", "country": "us", "date": 20401211, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "f0cd3c4042200ddf5e1479a78be9ebfb", "name": "International Day of Neutrality", "description": "International Day of Neutrality is a United Nations observance in the USA", "country": "us", "date": 20401212, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "6c7fa05ce770ba0d8a21bde490eeb3be", "name": "International Universal Health Coverage Day", "description": "International Universal Health Coverage Day is a United Nations observance in the USA", "country": "us", "date": 20401212, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "6050b621fae729c957c4322f5d443cc8", "name": "Feast of Our Lady of Guadalupe", "description": "The Feast of Our Lady Guadalupe, in honor of Jesus’ mother Mary, is a Catholic observance in the United States.", "country": "us", "date": 20401212, "type": [ "Christian" ], "primary_type": "Christian", "locations": "All", "states": "All" }, { "uuid": "25cc5b4424bb1a7a047836fa6b2fbb43", "name": "National Guard Birthday", "description": "National Guard Birthday is a observance in the USA", "country": "us", "date": 20401213, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "ebb9de419bec63f0a1fa56be502a286a", "name": "Asarah B'Tevet", "description": "Asarah B'Tevet is a Jewish holiday in the USA", "country": "us", "date": 20401214, "type": [ "Hebrew" ], "primary_type": "Jewish holiday", "locations": "All", "states": "All" }, { "uuid": "7dad0a4ad5c8a7188e3e3027047d6ed0", "name": "Eid al-Adha", "description": "For more than 3 millions Muslims in the US, Eid al-Adha, the Festival of Sacrifice, is one of the most important dates in the calendar.", "country": "us", "date": 20401215, "type": [ "Muslim" ], "primary_type": "Muslim", "locations": "All", "states": "All" }, { "uuid": "00fdb08660ed6ee6d676a37386173d19", "name": "Bill of Rights Day", "description": "Bill of Rights Day is a observance in the USA", "country": "us", "date": 20401215, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "e88bd15cefb1583c692c504929b02f5b", "name": "Pan American Aviation Day", "description": "December 17 marks Pan American Aviation Day, which is annually observed in the United States.", "country": "us", "date": 20401217, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "58e5f3cf3e13bbefeb77f3760a6fd5fc", "name": "Wright Brothers Day", "description": "The Wright Brothers Day is annually celebrated in the United States on December 17 to commemorate the historic flight made by Orville and Wilbur Wright on that date in 1903.", "country": "us", "date": 20401217, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "2620eebe13b17df765579b9478ecb8fb", "name": "International Migrants Day", "description": "The United Nations (UN) International Migrants Day is celebrated on December 18 each year.", "country": "us", "date": 20401218, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "1412d40e6baa7587588b598cccdfed1d", "name": "Arabic Language Day", "description": "World Arabic Language Day is a United Nations (UN) observance that celebrates one of the organization’s 6 official languages – Arabic.", "country": "us", "date": 20401218, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "522db973500e0554bf741e922283b72c", "name": "International Human Solidarity Day", "description": "The United Nations' (UN) International Human Solidarity Day is celebrated on December 20 each year to raise public awareness on the importance of solidarity in fighting poverty.", "country": "us", "date": 20401220, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "182f9d9462ef40cca60e6528e842a5c0", "name": "December Solstice", "description": "December Solstice in the USA (New York)", "country": "us", "date": "20401221T01:32:5005:00", "type": [ "Season" ], "primary_type": "Season", "locations": "All", "states": "All" }, { "uuid": "ab864e7cb9324cc3e926e14129ac5196", "name": "Super Saturday", "description": "The final Saturday before Christmas has become a very popular shopping day in the US, earning the nickname Super Saturday.", "country": "us", "date": 20401222, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "cf499c9e16bdf03af9a73331dc71c0eb", "name": "Christmas Eve", "description": "Christmas Eve in the United States is on December 24 each year.", "country": "us", "date": 20401224, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "MI, KS (partly), NC, ND, OK, SC, TX, WI, VA (partly), KY", "states": [ "us-mi", "us-ks", "us-nc", "us-nd", "us-ok", "us-sc", "us-tx", "us-wi", "us-va", "us-ky" ] }, { "uuid": "cf499c9e16bdf03af9a73331dc71c0eb", "name": "Christmas Eve", "description": "Christmas Eve in the United States is on December 24 each year.", "country": "us", "date": 20401224, "type": [ "Observance", "Christian" ], "primary_type": "Christian", "locations": "All", "states": "All" }, { "uuid": "cf499c9e16bdf03af9a73331dc71c0eb", "name": "Christmas Eve", "description": "Christmas Eve in the United States is on December 24 each year.", "country": "us", "date": 20401224, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "AR", "states": [ "us-ar" ] }, { "uuid": "c413809cf79552589e1effd626d56d48", "name": "Christmas Day", "description": "Christmas Day celebrates Jesus Christ's birth.", "country": "us", "date": 20401225, "type": [ "National holiday", "Christian" ], "primary_type": "Federal Holiday", "locations": "All", "states": "All" }, { "uuid": "c413809cf79552589e1effd626d56d48", "name": "Christmas Day", "description": "Christmas Day celebrates Jesus Christ's birth.", "country": "us", "date": 20401225, "type": [ "Local holiday", "Christian" ], "primary_type": "State Holiday", "locations": "RI", "states": [ "us-ri" ] }, { "uuid": "c413809cf79552589e1effd626d56d48", "name": "Christmas Day", "description": "Christmas Day celebrates Jesus Christ's birth.", "country": "us", "date": 20401225, "type": [ "Local holiday", "Christian" ], "primary_type": "State Holiday", "locations": "CA, MA, MS, NY", "states": [ "us-ca", "us-ma", "us-ms", "us-ny" ] }, { "uuid": "c413809cf79552589e1effd626d56d48", "name": "Christmas Day", "description": "Christmas Day celebrates Jesus Christ's birth.", "country": "us", "date": 20401225, "type": [ "Local holiday", "Christian" ], "primary_type": "State Holiday", "locations": "All except CA, MA, MS, NY, RI, TX", "states": [ "us-ak", "us-al", "us-ar", "us-az", "us-co", "us-ct", "us-de", "us-dc", "us-fl", "us-hi", "us-id", "us-il", "us-ga", "us-in", "us-ia", "us-ks", "us-ky", "us-la", "us-me", "us-md", "us-mi", "us-mn", "us-mo", "us-mt", "us-nv", "us-ne", "us-nh", "us-nj", "us-nm", "us-nd", "us-oh", "us-or", "us-pa", "us-sc", "us-sd", "us-tn", "us-ut", "us-va", "us-vt", "us-wa", "us-wv", "us-wi", "us-wy", "us-nc", "us-ok" ] }, { "uuid": "c413809cf79552589e1effd626d56d48", "name": "Christmas Day", "description": "Christmas Day celebrates Jesus Christ's birth.", "country": "us", "date": 20401225, "type": [ "Local holiday", "Christian" ], "primary_type": "State Holiday", "locations": "TX", "states": [ "us-tx" ] }, { "uuid": "8909138876b1b82fe6c9af348801221a", "name": "Kwanzaa (first day)", "description": "Kwanzaa is a week-long holiday honoring the culture and traditions of African people and their descendants worldwide, especially in the United States.", "country": "us", "date": 20401226, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "41fea5a935bba3cca450122939f6b2f0", "name": "Day After Christmas Day", "description": "Some states in the United States observe the Day after Christmas Day as a public holiday.", "country": "us", "date": 20401226, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "NC, SC", "states": [ "us-nc", "us-sc" ] }, { "uuid": "41fea5a935bba3cca450122939f6b2f0", "name": "Day After Christmas Day", "description": "Some states in the United States observe the Day after Christmas Day as a public holiday.", "country": "us", "date": 20401226, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "TX", "states": [ "us-tx" ] }, { "uuid": "d353ed3dc148af1d39acae04981a1d7f", "name": "International Day of Epidemic Preparedness", "description": "International Day of Epidemic Preparedness is a United Nations observance in the USA", "country": "us", "date": 20401227, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "087034cd9651bb7e5d432b33812bea58", "name": "New Year's Eve", "description": "New Year's Eve is the last day of the year in the Gregorian calendar. Many parties to welcome the New Year are held in in the United States on New Year's Eve.", "country": "us", "date": 20401231, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "087034cd9651bb7e5d432b33812bea58", "name": "New Year's Eve", "description": "New Year's Eve is the last day of the year in the Gregorian calendar. Many parties to welcome the New Year are held in in the United States on New Year's Eve.", "country": "us", "date": 20401231, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "WI, MI", "states": [ "us-wi", "us-mi" ] } ] } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/holidays/{country}/{region}/{year}": { "get": { "summary": "Read Holiday Information by Country and Region", "deprecated": false, "description": "", "tags": [ "Timeframes/Holiday Information" ], "parameters": [ { "name": "country", "in": "path", "description": "The country from which to read holidays - format: ISO-3166 A-2 e.g.: US, MX", "required": true, "schema": { "type": "string" } }, { "name": "region", "in": "path", "description": "The region within the ```country``` from which to read holidays - format: ISO 3166-2 e.g.: US-NY, MX-ZAC", "required": true, "schema": { "type": "string" } }, { "name": "year", "in": "path", "description": "The year in which to read holidays", "required": true, "schema": { "type": "string" } }, { "name": "language", "in": "query", "description": "Language formatted according to ISO 639-1", "required": false, "example": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "country": { "type": "string" }, "date": { "type": [ "integer", "string" ] }, "type": { "type": "array", "items": { "type": "string" } }, "primary_type": { "type": "string" }, "locations": { "type": "string" }, "states": { "type": [ "array", "string" ], "items": { "type": "string" } } }, "required": [ "uuid", "name", "description", "country", "date", "type", "primary_type", "locations", "states" ] } }, "example": [ { "uuid": "c7ceeccbead419df7dbd82f7f213162d", "name": "New Year's Day", "description": "New Year's Day is the first day of the Gregorian calendar, which is widely used in many countries such as the USA.", "country": "us", "date": 20400101, "type": [ "National holiday" ], "primary_type": "Federal Holiday", "locations": "All", "states": "All" }, { "uuid": "c7ceeccbead419df7dbd82f7f213162d", "name": "New Year's Day", "description": "New Year's Day is the first day of the Gregorian calendar, which is widely used in many countries such as the USA.", "country": "us", "date": 20400101, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "All except MA, MS, NY, RI, TX, WI", "states": [ "us-al", "us-ak", "us-az", "us-ar", "us-ca", "us-co", "us-ct", "us-fl", "us-de", "us-dc", "us-ga", "us-hi", "us-id", "us-il", "us-in", "us-ia", "us-ks", "us-ky", "us-la", "us-md", "us-me", "us-mi", "us-mn", "us-mo", "us-mt", "us-ne", "us-nv", "us-nj", "us-nh", "us-nm", "us-nc", "us-nd", "us-oh", "us-ok", "us-or", "us-pa", "us-sc", "us-sd", "us-tn", "us-ut", "us-vt", "us-va", "us-wa", "us-wv", "us-wy" ] }, { "uuid": "c7ceeccbead419df7dbd82f7f213162d", "name": "New Year's Day (substitute)", "description": "New Year's Day is the first day of the Gregorian calendar, which is widely used in many countries such as the USA.", "country": "us", "date": 20400102, "type": [ "National holiday" ], "primary_type": "Federal Holiday", "locations": "All", "states": "All" }, { "uuid": "c7ceeccbead419df7dbd82f7f213162d", "name": "New Year's Day (substitute)", "description": "New Year's Day is the first day of the Gregorian calendar, which is widely used in many countries such as the USA.", "country": "us", "date": 20400102, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "All except MA, MS, NY, RI, TX, WI", "states": [ "us-al", "us-ak", "us-az", "us-ar", "us-ca", "us-co", "us-ct", "us-fl", "us-de", "us-dc", "us-ga", "us-hi", "us-id", "us-il", "us-in", "us-ia", "us-ks", "us-ky", "us-la", "us-md", "us-me", "us-mi", "us-mn", "us-mo", "us-mt", "us-ne", "us-nv", "us-nj", "us-nh", "us-nm", "us-nc", "us-nd", "us-oh", "us-ok", "us-or", "us-pa", "us-sc", "us-sd", "us-tn", "us-ut", "us-vt", "us-va", "us-wa", "us-wv", "us-wy" ] }, { "uuid": "0f1c517efbd1f00188cbc735494fe054", "name": "World Braille Day", "description": "World Braille Day celebrates the life and achievements of Louis Braille, who invented the braille code for the visually impaired.", "country": "us", "date": 20400104, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "8ef4c82bb8f36c34598c7f84d7c3de63", "name": "Epiphany", "description": "Many people in the United States annually observe Epiphany, or Three Kings’ Day, on January 6. It is a Christian observance and a public holiday in the US Virgin Islands.", "country": "us", "date": 20400106, "type": [ "Christian" ], "primary_type": "Christian", "locations": "All", "states": "All" }, { "uuid": "87b398137d56f27708c2a1889bf00542", "name": "Orthodox Christmas Day", "description": "Many Orthodox Christian churches in countries such as the United States observe Christmas Day on or near January 7 in the Gregorian calendar.", "country": "us", "date": 20400107, "type": [ "Orthodox" ], "primary_type": "Orthodox", "locations": "All", "states": "All" }, { "uuid": "fb03de8e2d2ad6a948f0e9b9cae9c955", "name": "International Programmers' Day", "description": "Many people celebrate International Programmers’ Day on January 7, while others observe this event on the 256th day of the year, usually on September 13 or on September 12 in leap years.", "country": "us", "date": 20400107, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "665c152272d175232dd08ef4c1fb32f8", "name": "Friday the 13th", "description": "Friday the 13th is a day full of superstitious beliefs in communities worldwide.", "country": "us", "date": 20400113, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "46ff4a6a6d3fb649bc0ed01a08951795", "name": "Stephen Foster Memorial Day", "description": "Stephen Foster Memorial Day is annually observed in the United States on January 13. The day remembers the achievements of Stephen Foster, who is known as the “father of American music”.", "country": "us", "date": 20400113, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "0d8a4641ee056e9daf3c2e0dfc4e4aef", "name": "Orthodox New Year", "description": "Many Orthodox Christian churches in countries such as the United States celebrate New Year’s Day on January 14 in the Gregorian calendar.", "country": "us", "date": 20400114, "type": [ "Orthodox" ], "primary_type": "Orthodox", "locations": "All", "states": "All" }, { "uuid": "27b0805621a4b2526e412fb13518e74f", "name": "World Religion Day", "description": "World Religion Day fosters interfaith dialogue and understanding of all religions.", "country": "us", "date": 20400115, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "43c8758a146176457ac68e28dd54f246", "name": "Muharram", "description": "The first day of Muharram, which is the first month in the Islamic calendar, marks the start of the Islamic New Year.", "country": "us", "date": 20400116, "type": [ "Muslim" ], "primary_type": "Muslim", "locations": "All", "states": "All" }, { "uuid": "1e7dabcd1fd349828dc111290e99225d", "name": "Martin Luther King Jr. Day", "description": "Martin Luther King Day marks the anniversary of the date of birth of the influential American civil right leader of the same name.", "country": "us", "date": 20400116, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "All", "states": [ "us-al", "us-ak", "us-az", "us-ar", "us-ca", "us-co", "us-ct", "us-fl", "us-de", "us-dc", "us-ga", "us-hi", "us-id", "us-il", "us-in", "us-ia", "us-ks", "us-ky", "us-la", "us-ma", "us-me", "us-md", "us-mi", "us-mn", "us-mo", "us-ms", "us-mt", "us-ne", "us-nh", "us-nv", "us-nj", "us-nm", "us-nc", "us-ny", "us-nd", "us-oh", "us-ok", "us-or", "us-pa", "us-ri", "us-sc", "us-sd", "us-tn", "us-tx", "us-ut", "us-vt", "us-va", "us-wa", "us-wv", "us-wy", "us-wi" ] }, { "uuid": "1e7dabcd1fd349828dc111290e99225d", "name": "Martin Luther King Jr. Day", "description": "Martin Luther King Day marks the anniversary of the date of birth of the influential American civil right leader of the same name.", "country": "us", "date": 20400116, "type": [ "National holiday" ], "primary_type": "Federal Holiday", "locations": "All", "states": "All" }, { "uuid": "2d7ba967dfe02bf3fd05e7ad7f6eaac8", "name": "International Day of Education", "description": "International Day of Education is a United Nations observance in the USA", "country": "us", "date": 20400124, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "64ec6edf1edf9e29e5c9ff8113991e0c", "name": "Ashura", "description": "Ashura is a Muslim in the USA", "country": "us", "date": 20400125, "type": [ "Muslim" ], "primary_type": "Muslim", "locations": "All", "states": "All" }, { "uuid": "15d3e7ef3b87bc969888a19a64a8e4f4", "name": "International Customs Day", "description": "International Customs Day celebrates custom personnel and agencies worldwide.", "country": "us", "date": 20400126, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "6b443d4b2ed9e79174b494fd608f62b9", "name": "International Day of Commemoration in Memory of the Victims of the Holocaust", "description": "The United Nations' (UN) International Day of Commemoration in Memory of the Victims of the Holocaust remembers those who died and suffered during the Holocaust before and during World War II. It is on January 27 each year.", "country": "us", "date": 20400127, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "bf0133ef3050230e9d27721ac1fae0c4", "name": "World Leprosy Day", "description": "World Leprosy Day brings awareness of leprosy, also known as Hansen's disease, and ways to prevent the disease.", "country": "us", "date": 20400129, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "23a6b27a4c41f4f62ed640db4d04d53b", "name": "Tu Bishvat/Tu B'Shevat", "description": "Tu B’Shevat, known as the “New Year for Trees”, is a Jewish festival similar to Arbor Day.", "country": "us", "date": 20400130, "type": [ "Hebrew" ], "primary_type": "Jewish holiday", "locations": "All", "states": "All" }, { "uuid": "e9e5c6a8d2cd5529c1014887bd6c2836", "name": "National Freedom Day", "description": "National Freedom Day in the United States is observed on February 1 each year.", "country": "us", "date": 20400201, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "3a4a5f3d76e8cf61bb5b954ab254e584", "name": "National Girls and Women in Sports Day", "description": "National Girls and Women in Sports Day is a observance in the USA", "country": "us", "date": 20400201, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "8d5f9a7ebe4775a286da701b6b82cbd2", "name": "First Day of Black History Month", "description": "First Day of Black History Month is a annual monthly observance in the USA", "country": "us", "date": 20400201, "type": [ "Observance" ], "primary_type": "Annual Monthly Observance", "locations": "All", "states": "All" }, { "uuid": "cb10d6664b97807899caddda8be90c8c", "name": "World Wetlands Day", "description": "World Wetlands Day raises awareness about the important role that the wetlands play in the environment and in our lives.", "country": "us", "date": 20400202, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "32d256bf335f157f224055f404c1274c", "name": "Groundhog Day", "description": "Many people in the United States observe Groundhog Day on February 2.", "country": "us", "date": 20400202, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "c67421b4b4147727b3e4edeea9b4d779", "name": "National Wear Red Day", "description": "National Wear Red Day® raises public awareness of heart disease in women and ways to avoid and combat this problem.", "country": "us", "date": 20400203, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "699e6b9f877ba7c628aad8146877d1ea", "name": "International Day of Human Fraternity", "description": "International Day of Human Fraternity is a United Nations observance in the USA", "country": "us", "date": 20400204, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "a2613fab2d1800d30eb6a62e083c9ea5", "name": "World Cancer Day", "description": "World Cancer Day is an annual global event on February 4 to raise people’s awareness of cancer.", "country": "us", "date": 20400204, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "e398c79dbb022098a3cf13d43d8faa5a", "name": "Rosa Parks Day", "description": "The life of American civil rights leader Rosa Parks is celebrated in the United States on either February 4 or December 1.", "country": "us", "date": 20400204, "type": [ "Local observance" ], "primary_type": "Local observance", "locations": "CA", "states": [ "us-ca" ] }, { "uuid": "dc71f474fd6c74a9d7a9dfedd8310e10", "name": "International Day of Zero Tolerance for Female Genital Mutilation", "description": "The International Day of Zero Tolerance for Female Genital Mutilation is an awareness campaign to end a harmful practice that violates girls’ and women’s rights.", "country": "us", "date": 20400206, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "23e356faabe19cd285ed45f48c3a99be", "name": "Ronald Reagan Day", "description": "Ronald Reagan Day is a state observance in the USA", "country": "us", "date": 20400206, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "CA", "states": [ "us-ca" ] }, { "uuid": "958a38db1a5638269429acac65499b0a", "name": "World Pulses Day", "description": "World Pulses Day is a United Nations observance in the USA", "country": "us", "date": 20400210, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "97f62a16075dd4d3514620c9c979ccfe", "name": "International Day of Women and Girls in Science", "description": "The International Day of Women and Girls in Science is a UN holiday to recognize the critical role women and girls play in science and technology communities.", "country": "us", "date": 20400211, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "9029ee00d6bc7f0c142196ba30bf2531", "name": "World Day of the Sick", "description": "World Day of the Sick is a global event when people remember or pray for the sick.", "country": "us", "date": 20400211, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "b60d2343a93474640b18524a86162390", "name": "Lunar New Year", "description": "Lunar New Year marks the first day of the New Year in the Chinese calendar.", "country": "us", "date": 20400212, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "CA", "states": [ "us-ca" ] }, { "uuid": "b60d2343a93474640b18524a86162390", "name": "Lunar New Year", "description": "Lunar New Year marks the first day of the New Year in the Chinese calendar.", "country": "us", "date": 20400212, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "d5cbb7ac3bbcc38a6b0303094720a3b1", "name": "Super Bowl", "description": "The Super Bowl is the championship game of the National Football League (NFL) in the United States. It is played every year in February.", "country": "us", "date": 20400212, "type": [ "Sporting event" ], "primary_type": "Sporting event", "locations": "All", "states": "All" }, { "uuid": "c49ffadc49c895f785de5b8acd68ab38", "name": "World Radio Day", "description": "World Radio Day is an annual United Nations (UN) event that promotes the importance of the radio in communicating information worldwide.", "country": "us", "date": 20400213, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "7bf73c3771fd6395022e50eb52df622e", "name": "Valentine's Day", "description": "Valentine's Day is an occasion to celebrate romantic love.", "country": "us", "date": 20400214, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "122ba1693e23c5fdaff67257fb84d250", "name": "Shrove Tuesday/Mardi Gras", "description": "Shrove Tuesday is traditionally known as the day prior to Lent but it also serves as a day of celebration, known as Mardi Gras.", "country": "us", "date": 20400214, "type": [ "Observance", "Christian" ], "primary_type": "Christian", "locations": "All", "states": "All" }, { "uuid": "f1472fd95e2c34ed3b9a07c0f97205ad", "name": "Ash Wednesday", "description": "Ash Wednesday is a Christian observance that marks the first day of Lent, which is prior to Easter.", "country": "us", "date": 20400215, "type": [ "Christian" ], "primary_type": "Christian", "locations": "All", "states": "All" }, { "uuid": "a0b184b30fc948dbd2a2dfa1f257b1ec", "name": "World Day of Social Justice", "description": "The United Nations' (UN) World Day of Social Justice promotes poverty eradication, full employment and social integration. It is on February 20 each year.", "country": "us", "date": 20400220, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "a6701e379600f1cab280dd473ce59126", "name": "Presidents' Day", "description": "Washington's Birthday, or Presidents' Day, honors the life and work of the first president of the United States, George Washington.", "country": "us", "date": 20400220, "type": [ "National holiday" ], "primary_type": "Federal Holiday", "locations": "All", "states": "All" }, { "uuid": "a6701e379600f1cab280dd473ce59126", "name": "Presidents' Day", "description": "Presidents' Day is a state holiday in the USA", "country": "us", "date": 20400220, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "All except DE, FL, GA, IA, KS, KY, LA, NC, RI, WI", "states": [ "us-al", "us-ak", "us-az", "us-ar", "us-ca", "us-co", "us-ct", "us-hi", "us-id", "us-il", "us-in", "us-me", "us-md", "us-ma", "us-mi", "us-mn", "us-ms", "us-mo", "us-mt", "us-ne", "us-nv", "us-nh", "us-nj", "us-nm", "us-ny", "us-nd", "us-oh", "us-ok", "us-or", "us-pa", "us-sc", "us-sd", "us-tn", "us-tx", "us-ut", "us-vt", "us-va", "us-wa", "us-wv", "us-wy", "us-dc" ] }, { "uuid": "b1706bb7f06f07ffac562a2e25b1d3a5", "name": "International Mother Language Day", "description": "The United Nations' (UN) International Mother Language Day is annually held on February 21 to celebrate languages spoken worldwide. It also observes the human right to use these languages.", "country": "us", "date": 20400221, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "a1c690d1e8bac5f73914587d56e381d7", "name": "Purim", "description": "Purim commemorates a time when Jewish people were saved from death around the fourth century BCE, according to the Book of Esther.", "country": "us", "date": 20400228, "type": [ "Hebrew" ], "primary_type": "Jewish holiday", "locations": "All", "states": "All" }, { "uuid": "64b7ec7f168c794d6a3fc6e4af7359fc", "name": "Zero Discrimination Day", "description": "Discrimination Day highlights the negative impacts of discrimination and promotes tolerance, compassion and peace.", "country": "us", "date": 20400301, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "e9bdd4e02c7fd652ebbde4067ceaf5e2", "name": "Self-Injury Awareness Day", "description": "", "country": "us", "date": 20400301, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "d713518ffa46c770d90fc0f2ce4775e1", "name": "St. David's Day", "description": "Many Welsh communities in the United States celebrate the life of their patron saint, St David, and their links with Wales on St David’s Day.", "country": "us", "date": 20400301, "type": [ "Observance", "Christian" ], "primary_type": "Christian", "locations": "All", "states": "All" }, { "uuid": "16edecb679e47deaec9f03996f1b71d4", "name": "First Day of Women's History Month", "description": "First Day of Women's History Month is a annual monthly observance in the USA", "country": "us", "date": 20400301, "type": [ "Observance" ], "primary_type": "Annual Monthly Observance", "locations": "All", "states": "All" }, { "uuid": "2fc1141034520ca47d7c92b3537d7797", "name": "First Day of Irish American Heritage Month", "description": "First Day of Irish American Heritage Month is a annual monthly observance in the USA", "country": "us", "date": 20400301, "type": [ "Observance" ], "primary_type": "Annual Monthly Observance", "locations": "All", "states": "All" }, { "uuid": "ce4959604d67ab1ed97a093a0d837d10", "name": "Read Across America Day", "description": "Read Across America Day is observed in the United States on March 2 each year.", "country": "us", "date": 20400302, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "5fdcb659f0a730261efe4583a4002f9c", "name": "Employee Appreciation Day", "description": "Employee Appreciation Day is a US unofficial observance that recognizes and appreciates employees in all industries, aimed at helping employers keep their staff.", "country": "us", "date": 20400302, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "3ca800641768dd4cbb5411b720a0c6db", "name": "World Wildlife Day", "description": "World Wildlife Day celebrates all flora and fauna, including animals, on Earth.", "country": "us", "date": 20400303, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "485e6b5351d1cce550f1ab1ae0d93c46", "name": "International Women's Day", "description": "International Women’s Day celebrates women’s achievements worldwide and throughout history.", "country": "us", "date": 20400308, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "ca663ac6fd25f47ba4119835935baa82", "name": "World Kidney Day", "description": "World Kidney Day is an annual observation that attempts to raise global awareness about the importance of kidney health and tries to bring attention to the unique challenges faced by those who suffer from Chronic Kidney Disease.", "country": "us", "date": 20400308, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "cfc59f372ec73c13d117402b0df28231", "name": "International Day of Women Judges", "description": "International Day of Women Judges is a United Nations observance in the USA", "country": "us", "date": 20400310, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "37ec9c7d8016af391a0e381a2aa3b716", "name": "Daylight Saving Time starts", "description": "Daylight Saving Time starts in the USA", "country": "us", "date": "20400311T02:00:0005:00", "type": [ "Clock change/Daylight Saving Time" ], "primary_type": "Clock change/Daylight Saving Time", "locations": "All", "states": "All" }, { "uuid": "dd21b27f202dbafcd0772c0724dcb96f", "name": "Long Covid Awareness Day", "description": "Long Covid Awareness Day is a worldwide observance in the USA", "country": "us", "date": 20400315, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "1005bae3e160fa1cb37138c2222ededf", "name": "St. Patrick's Day", "description": "St Patrick's Day marks the life and deeds of St Patrick, one of Ireland's patron saints. It is an Irish-American celebration in the USA.", "country": "us", "date": 20400317, "type": [ "Observance", "Christian" ], "primary_type": "Christian", "locations": "All", "states": "All" }, { "uuid": "8fbcb23131eef7d227b98a8c9b8f309b", "name": "French Language Day", "description": "French Language Day is a United Nations observance in the USA", "country": "us", "date": 20400320, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "955bc5735feb7bb97db9e8360be20d85", "name": "International Day of Happiness", "description": "International Day of Happiness aims to promote the idea that the pursuit of happiness is universal.", "country": "us", "date": 20400320, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "8510987907f8aa352d8180560c85d9f9", "name": "March Equinox", "description": "March Equinox in the USA (New York)", "country": "us", "date": "20400319T20:11:3804:00", "type": [ "Season" ], "primary_type": "Season", "locations": "All", "states": "All" }, { "uuid": "eaaafed6408b8193282174179250fba7", "name": "International Day for the Elimination of Racial Discrimination", "description": "The United Nations’ (UN) International Day for the Elimination of Racial Discrimination is annually observed on March 21.", "country": "us", "date": 20400321, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "bb91e6fa1ff5e0f5b1f55f41c1050a14", "name": "World Poetry Day", "description": "World Poetry Day celebrates poetry around the world on March 21 each year.", "country": "us", "date": 20400321, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "abbffc95387a24defc2e20e294a5a142", "name": "International Day of Nowruz", "description": "The UN’s International Day of Nowruz, also known as Nowruz, No-Ruz, No-Rooz or No Ruz, is observed on March 21 each year.", "country": "us", "date": 20400321, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "780685462642bf87da859089a0ac96f4", "name": "World Down Syndrome Day", "description": "World Down Syndrome Day is held on March 21 every year.", "country": "us", "date": 20400321, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "876b314204c02de43705533b258f642a", "name": "International Day of Forests", "description": "International Day of Forests raises awareness on forests and trees, including their role in climate change.", "country": "us", "date": 20400321, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "fb974895a73882064c531ca7b54874c7", "name": "World Water Day", "description": "World Water Day aims to increase people's awareness of the water's importance in all aspects of life.", "country": "us", "date": 20400322, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "bf82e5cc52a9690b9b8514aef979af82", "name": "World Meteorological Day", "description": "World Meteorological Day marks the anniversary of the World Meteorological Organization's establishment on March 23, 1950.", "country": "us", "date": 20400323, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "5a05df4c34ec8840c27cd0662577e880", "name": "World Tuberculosis Day", "description": "World Tuberculosis Day is annually held on March 24 to raise awareness of tuberculosis and ways to eradicate the disease.", "country": "us", "date": 20400324, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "8d77e7d7924bab5e2177fe046e46fe7f", "name": "International Day for the Right to the Truth concerning Gross Human Rights Violations and for the Dignity of Victims", "description": "March 24 is the UN’s International Day for the Right to the Truth concerning Gross Human Rights Violations and for the Dignity of Victims", "country": "us", "date": 20400324, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "3b770f7a07734afe90ae6473968820d5", "name": "Palm Sunday", "description": "Palm Sunday in the United States celebrates Jesus Christ’s entry into Jerusalem. It is also the Sunday before Easter Sunday.", "country": "us", "date": 20400325, "type": [ "Christian" ], "primary_type": "Christian", "locations": "All", "states": "All" }, { "uuid": "088093a1a3892379468590bdf6e03fc5", "name": "International Day of Remembrance of Slavery Victims and the Transatlantic Slave Trade", "description": "The International Day of Remembrance of the Victims of Slavery and the Transatlantic Slave Trade remembers the lives of Africans who were forced into slavery in North, Central and South America.", "country": "us", "date": 20400325, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "c6f4ffd1dfb913da3c705798da063e73", "name": "International Day of Solidarity with Detained and Missing Staff Members", "description": "The UN’s International Day of Solidarity with Detained and Missing Staff Members is annually held on March 25.", "country": "us", "date": 20400325, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "26b9b5d72f7f2e065ae0e2a5ae450d37", "name": "The Prophet's Birthday", "description": "Eid Milad ul-Nabi (Mawlid or Milad-un-Nabi) commemorates the Prophet Muhammed's birthday.", "country": "us", "date": 20400326, "type": [ "Muslim" ], "primary_type": "Muslim", "locations": "All", "states": "All" }, { "uuid": "c7c2b7d212e5ed3d4a1f6c334ca27506", "name": "Passover Eve", "description": "Passover Eve is a Jewish holiday in the USA", "country": "us", "date": 20400328, "type": [ "Hebrew" ], "primary_type": "Jewish holiday", "locations": "All", "states": "All" }, { "uuid": "2be7345.1.2e1299823d5a280a3ebec38", "name": "Maundy Thursday", "description": "Maundy Thursday, which is also known as Holy Thursday, is the day before Good Friday.", "country": "us", "date": 20400329, "type": [ "Christian" ], "primary_type": "Christian", "locations": "All", "states": "All" }, { "uuid": "6109146bf39e3e0998efbb7fb1083b3c", "name": "Passover (first day)", "description": "Passover marks the Israelites' liberation from slavery and their exodus from Egypt around 3000 years ago.", "country": "us", "date": 20400329, "type": [ "Hebrew" ], "primary_type": "Jewish holiday", "locations": "All", "states": "All" }, { "uuid": "979e13b6fb546db8a924c330e17a017f", "name": "National Vietnam War Veterans Day", "description": "National Vietnam War Veterans Day is an US observance to honor US military members who served during the Vietnam War.", "country": "us", "date": 20400329, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "6377f444e2cfe70daf01e6ec6baad62f", "name": "Doctors' Day", "description": "Doctors' Day is a observance in the USA", "country": "us", "date": 20400330, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "ed67c5df0566b88b20a5ac4e9e257235", "name": "Holy Saturday", "description": "Holy Saturday is the day before Easter Sunday in the United States.", "country": "us", "date": 20400331, "type": [ "Christian" ], "primary_type": "Christian", "locations": "All", "states": "All" }, { "uuid": "198c8f764f0994a812af88cb8424bb39", "name": "Earth Hour", "description": "Earth Hour is an annual event in which many people worldwide turn their lights off on the last Saturday in March.", "country": "us", "date": 20400331, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "9da50ce50a63bb66e5f322504c97ece9", "name": "International Transgender Day of Visibility", "description": "International Transgender Day of Visibility is a worldwide observance in the USA", "country": "us", "date": 20400331, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "250b4e9878eab087f9be991259604e04", "name": "César Chávez Day", "description": "César Chávez Day celebrates the birthday of César Estrada Chávez.", "country": "us", "date": 20400331, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "CA", "states": [ "us-ca" ] }, { "uuid": "ada227e6a64f6d8d76b0e207b890c117", "name": "April Fool's Day", "description": "April Fool's Day, on April 1, is a day to play practical jokes and tricks.", "country": "us", "date": 20400401, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "5a8d5f4c9549f5f7cf22bef09ad022a3", "name": "Easter Sunday", "description": "Easter Sunday is an important day in the Christian church calendar because it celebrates Jesus Christ's resurrection, according to Christian belief.", "country": "us", "date": 20400401, "type": [ "Observance", "Christian" ], "primary_type": "Christian", "locations": "All", "states": "All" }, { "uuid": "29bba2ac1f7a3072f89699e5ca941a0b", "name": "World Autism Awareness Day", "description": "World Autism Awareness Day raises an awareness of issues surrounding people, particularly children, with autism worldwide.", "country": "us", "date": 20400402, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "83a0b2b4a129fa3277ad9e3d4e880d7d", "name": "Easter Monday", "description": "Easter Monday is the day after Easter Sunday. It is not a federal holiday in the United States of America (USA).", "country": "us", "date": 20400402, "type": [ "Observance", "Christian" ], "primary_type": "Christian", "locations": "All", "states": "All" }, { "uuid": "4b3a2adfaf2d30ef7842315de7cf4bb3", "name": "United Nations' Mine Awareness Day", "description": "The United Nations' International Day for Mine Awareness and Assistance in Mine Action is annually observed on April 4.", "country": "us", "date": 20400404, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "b0f4f1e07426769544f863f509894f39", "name": "Last Day of Passover", "description": "The last day of Passover marks the end of the Passover period, which lasts for seven or eight days.", "country": "us", "date": 20400405, "type": [ "Hebrew" ], "primary_type": "Jewish holiday", "locations": "All", "states": "All" }, { "uuid": "fc95dea55959d986b4bc2a7061b6a7eb", "name": "International Day of Conscience", "description": "International Day of Conscience is a United Nations observance in the USA", "country": "us", "date": 20400405, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "0f4d689973f15e7d788c3259b9d999ad", "name": "International Day of Sport for Development and Peace", "description": "The International Day of Sport for Development and Peace aims to bring goodwill and positive social outcomes through sporting achievements.", "country": "us", "date": 20400406, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "8f570bcb8f1fcb5b0fd491e0e7e20f6a", "name": "National Tartan Day", "description": "National Tartan Day is annually observed on April 6 to honor the major role that Scottish Americans played in the founding of the United States of America.", "country": "us", "date": 20400406, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "68e72591a345cd35b0686b7480d19f3b", "name": "United Nations' World Health Day", "description": "The World Health Organization, the United Nations' the directing and coordinating authority for health, annually highlights one of its priorities for global health on World Health Day.", "country": "us", "date": 20400407, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "3387dd07d5cae6b01589ee0151c8d922", "name": "Day of Remembrance of the Victims of the Rwanda Genocide", "description": "The UN’s Day of Remembrance of the Victims of the Rwanda Genocide is observed on April 7 each year.", "country": "us", "date": 20400407, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "d7d793f722aa9a29554b3d3a30edf541", "name": "Yom HaShoah", "description": "Many people in the United States observe Yom Hashoah by remembering Holocaust victims who died during World War II.", "country": "us", "date": 20400410, "type": [ "Hebrew" ], "primary_type": "Jewish commemoration", "locations": "All", "states": "All" }, { "uuid": "8c3b1fc8d321766ebc631aac059df3c2", "name": "National Library Workers' Day", "description": "National Library Workers’ Day recognizes the efforts and achievements that librarians make to give Americans access to information via books, computers and other media.", "country": "us", "date": 20400410, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "a0a82308e54673f7172e6ef48a7f9ec5", "name": "International Day of Human Space Flight", "description": "The UN’s International Day of Human Space Flight is annually held on April 12.", "country": "us", "date": 20400412, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "665c152272d175232dd08ef4c1fb32f8", "name": "Friday the 13th", "description": "Friday the 13th is a day full of superstitious beliefs in communities worldwide.", "country": "us", "date": 20400413, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "e41f2f315046aa508495b76969f90cb9", "name": "Thomas Jefferson's Birthday", "description": "Americans celebrate president Thomas Jefferson's Birthday on April 13.", "country": "us", "date": 20400413, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "b0a7046c4b867ebf3ab235e5d0f53af4", "name": "World Chagas Disease Day", "description": "World Chagas Disease Day is a United Nations observance in the USA", "country": "us", "date": 20400414, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "44aa9724e42542f8281e15c5c15bbf7e", "name": "World Art Day", "description": "World Art Day is a worldwide observance in the USA", "country": "us", "date": 20400415, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "3610f392fac7f59a23355567d386f13e", "name": "Boston Marathon", "description": "Boston Marathon is one of the world's oldest yearly marathon. It is held annually on Patriot's Day in the month of April.", "country": "us", "date": 20400416, "type": [ "Sporting event" ], "primary_type": "Sporting event", "locations": "All", "states": "All" }, { "uuid": "e142b3406c124aa5f40c7977569e3c20", "name": "Tax Day", "description": "Tax Day is the deadline for United States residents to file details of their income to the Internal Revenue Service (IRS) so that their liability for income tax can be assessed.", "country": "us", "date": 20400417, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "8d5ab0afb912667a6d2777a779375d3c", "name": "Yom Ha'atzmaut", "description": "Many Jewish communities in the United States celebrate Yom Ha’Atzmaut, which is Israel’s Independence Day, on the fifth day of the month of Iyar in the Jewish calendar.", "country": "us", "date": 20400418, "type": [ "Hebrew" ], "primary_type": "Jewish holiday", "locations": "All", "states": "All" }, { "uuid": "9277053091a076328bca1f6c6896c084", "name": "International Day for Monuments and Sites", "description": "The International Day for Monuments and Sites raises awareness on preserving and conserving historical and archeological heritage sites.", "country": "us", "date": 20400418, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "9382e5a05a5b1e4cd13fe5ef269cef3b", "name": "Chinese Language Day", "description": "Chinese Language Day is a United Nations observance that celebrates one of the organization’s 6 official languages – Chinese.", "country": "us", "date": 20400420, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "cde65fb50e049d5981eef1d1612b333f", "name": "World Creativity and Innovation Day", "description": "World Creativity and Innovation Day is a United Nations observance in the USA", "country": "us", "date": 20400421, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "a8a83fdc73f86d3e8ebdb752e970bd1a", "name": "Earth Day", "description": "The United Nations' International Mother Earth Day promotes environmental awareness and calls for the protection of our planet.", "country": "us", "date": 20400422, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "026a6504f11a3de6c26866ced39047af", "name": "World Book and Copyright Day", "description": "World Book and Copyright Day is an occasion to celebrate the contribution of books and authors to our global culture and the connection between copyright and books.", "country": "us", "date": 20400423, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "df803326fc9e00877841891948fe6483", "name": "World Spanish Language Day", "description": "World Spanish Language Day is a United Nations observance in the USA", "country": "us", "date": 20400423, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "148978f16a6c4d9eab18dcfb487a8e99", "name": "English Language Day", "description": "English Language Day promotes the history, culture and accomplishments of the English language.", "country": "us", "date": 20400423, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "5c916721004f371815a027d354e19b1c", "name": "International Day of Multilateralism and Diplomacy for Peace", "description": "International Day of Multilateralism and Diplomacy for Peace is a United Nations observance in the USA", "country": "us", "date": 20400424, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "e9191d2b383381759c3d3d66a5bb0472", "name": "International Delegate's Day", "description": "International Delegate's Day is a United Nations observance in the USA", "country": "us", "date": 20400425, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "4eb36b239f24e01378637d8e238ef341", "name": "World Malaria Day", "description": "World Malaria Day is annually observed on April 25 to promote efforts that provide effective control of malaria worldwide.", "country": "us", "date": 20400425, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "4c1fbb17ca69d5398ea6a5e2ee3bd0f3", "name": "Administrative Professionals Day", "description": "Administrative Professionals Day® is on the Wednesday of the last full week of April. It remembers the important role of administrative professionals.", "country": "us", "date": 20400425, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "e59a8c8aa7905cd07b1601dd0fde2777", "name": "International Girls in ICT Day", "description": "International Girls in ICT Day is a United Nations observance in the USA", "country": "us", "date": 20400426, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "6be493e00134962cab4110313c96ae6c", "name": "World Intellectual Property Day", "description": "World Intellectual Property Day is annually held on April 26 to increase awareness and understanding of intellectual property worldwide.", "country": "us", "date": 20400426, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "c0f71e5ffa909b0cb88813aedee97661", "name": "International Chernobyl Disaster Remembrance Day", "description": "International Chernobyl Disaster Remembrance Day is a UN holiday designed to raise awareness of the consequences of the 1986 nuclear accident.", "country": "us", "date": 20400426, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "927346f47cdb6ad932efd0874ff8574e", "name": "Take our Daughters and Sons to Work Day", "description": "Take our Daughters and Sons to Work Day is a observance in the USA", "country": "us", "date": 20400426, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "6758df841ec0a94402464932280e57ad", "name": "World Day for Safety and Health at Work", "description": "The World Day for Safety and Health at Work is observed on April 28 each year.", "country": "us", "date": 20400428, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "ccb6d2d5a37a20c6bea62c143d89bec9", "name": "International Jazz Day", "description": "International Jazz Day recognizes the historical, cultural, and educational contribution of jazz.", "country": "us", "date": 20400430, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "c8fc3fbdb1c10aac57107f745e66b54e", "name": "Lag BaOmer", "description": "Many Jewish Americans observe Lag B’Omer on the 18th day of the month of Iyar in the Jewish calendar.", "country": "us", "date": 20400501, "type": [ "Hebrew" ], "primary_type": "Jewish holiday", "locations": "All", "states": "All" }, { "uuid": "9aa13e2f577df9b6eca4f325dc0c5024", "name": "Law Day", "description": "Law Day in the United States is annually held on May 1.", "country": "us", "date": 20400501, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "549ac2ceba2814d8d6a1a9f14c1ffbe2", "name": "Loyalty Day", "description": "Loyalty Day is a special day for people to reaffirm their loyalty to the United States and to recognize the heritage of American freedom.", "country": "us", "date": 20400501, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "e9f300d03f294c048d22f1461c2368c6", "name": "First Day of Military Appreciation Month", "description": "First Day of Military Appreciation Month is a annual monthly observance in the USA", "country": "us", "date": 20400501, "type": [ "Observance" ], "primary_type": "Annual Monthly Observance", "locations": "All", "states": "All" }, { "uuid": "2ee08a547442f94b18db3e05e9f06cda", "name": "First Day of Asian Pacific American Heritage Month", "description": "First Day of Asian Pacific American Heritage Month is a annual monthly observance in the USA", "country": "us", "date": 20400501, "type": [ "Observance" ], "primary_type": "Annual Monthly Observance", "locations": "All", "states": "All" }, { "uuid": "faa91fe169ac7bae2e0f8f28fb1a3afe", "name": "First Day of Jewish American Heritage Month", "description": "First Day of Jewish American Heritage Month is a annual monthly observance in the USA", "country": "us", "date": 20400501, "type": [ "Observance" ], "primary_type": "Annual Monthly Observance", "locations": "All", "states": "All" }, { "uuid": "09750dcc296af90b7af66bc0caecdafa", "name": "World Tuna Day", "description": "World Tuna Day is a UN holiday designed to raise awareness of the global importance of tuna.", "country": "us", "date": 20400502, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "e5e157d5a0a08e86feab0200819d0016", "name": "World Press Freedom Day", "description": "World Press Freedom Day focuses on the importance of the freedom of the press and freedom of expression.", "country": "us", "date": 20400503, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "c01f42942905cd0b80ef0d204351c1b3", "name": "National Day of Prayer", "description": "National Day of Prayer is held on the first Thursday of May each year, inviting Americans of all faiths to pray for the country and its leaders.", "country": "us", "date": 20400503, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "1b07d4cb3a8c57a8323160349bc242d9", "name": "Orthodox Good Friday", "description": "Many Orthodox Christians in the United States remember the events leading up to Jesus Christ's crucifixion on Great Friday.", "country": "us", "date": 20400504, "type": [ "Orthodox" ], "primary_type": "Orthodox", "locations": "All", "states": "All" }, { "uuid": "307f1d915ad867e9f32d05abe5ddbae3", "name": "Kentucky Oaks", "description": "The Kentucky Oaks is a rade 1 Stakes horse race held annually on the Friday before the Kentucky Derby in May.", "country": "us", "date": 20400504, "type": [ "Sporting event" ], "primary_type": "Sporting event", "locations": "All", "states": "All" }, { "uuid": "4c2e87f6a814bdab6286b8a64a5138b8", "name": "Orthodox Holy Saturday", "description": "Many Orthodox Christians in the United States remember Jesus Christ’s burial and his descent into Hades on Holy Saturday.", "country": "us", "date": 20400505, "type": [ "Orthodox" ], "primary_type": "Orthodox", "locations": "All", "states": "All" }, { "uuid": "93c4a99677f32b1fa184f5a105371980", "name": "World Portuguese Language Day", "description": "World Portuguese Language Day is a United Nations observance in the USA", "country": "us", "date": 20400505, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "0e6246531fabef30c445.1.243c0564a1", "name": "Cinco de Mayo", "description": "'Cinco de Mayo' means \"Fifth of May\" in Spanish and is a festival of Mexican pride and heritage.", "country": "us", "date": 20400505, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "802e294dd8422f42ec12997905b61b5b", "name": "Kentucky Derby", "description": "Kentucky Derby is a Grade I Stakes horse race held annually in Louisville, Kentucky in May.", "country": "us", "date": 20400505, "type": [ "Sporting event" ], "primary_type": "Sporting event", "locations": "All", "states": "All" }, { "uuid": "30d34b7317f7c0f23a37f9ea6c5f6e22", "name": "National Explosive Ordnance Disposal (EOD) Day", "description": "National Explosive Ordnance Disposal (EOD) Day is an occasion to remember those serving the profession of explosive ordnance disposal in the United States Armed Forces.", "country": "us", "date": 20400505, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "cd1ab8d8b8bef4974de484d3a19fca63", "name": "Orthodox Easter", "description": "Many Orthodox Christians in the United States mark Easter Sunday, also known as Pascha, as the day Jesus Christ was resurrected, according to the Christian bible.", "country": "us", "date": 20400506, "type": [ "Orthodox" ], "primary_type": "Orthodox", "locations": "All", "states": "All" }, { "uuid": "156463782d72b7fcea33addab5a68c95", "name": "International Family Equality Day", "description": "International Family Equality Day is a worldwide observance in the USA", "country": "us", "date": 20400506, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "c5dd792fda5ac5ad2b970f401e7655fa", "name": "National Nurses Day", "description": "National Nurses Day is an occasion to honor the work of nurses.", "country": "us", "date": 20400506, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "33881c22f264344d206e3db50c582d81", "name": "Orthodox Easter Monday", "description": "Many Orthodox churches in the United States observe Easter Monday on the day after the Orthodox Easter Sunday date.", "country": "us", "date": 20400507, "type": [ "Orthodox" ], "primary_type": "Orthodox", "locations": "All", "states": "All" }, { "uuid": "0cf6377042fc0444045763676e30c311", "name": "Time of Remembrance and Reconciliation for Those Who Lost Their Lives during the Second World War", "description": "The United Nations’ (UN) Time of Remembrance and Reconciliation for Those Who Lost Their Lives during the Second World War is annually held over two days, from May 8-9.", "country": "us", "date": 20400508, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "002dd1ff80d0afc70ab16f33ffa6e3e6", "name": "World Ovarian Cancer Day", "description": "World Ovarian Cancer Day aims to spread global awareness about ovarian cancer.", "country": "us", "date": 20400508, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "9b292b732719af7631dacbea5ed77e75", "name": "World Red Cross and Red Crescent Day", "description": "World Red Cross and Red Crescent Day is a worldwide observance in the USA", "country": "us", "date": 20400508, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "3ba79bc2b662c64ac6fcdff08a69aae1", "name": "Victory in Europe Day", "description": "Victory in Europe Day is a observance in the USA", "country": "us", "date": 20400508, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "f36ec3704041053ad21a86c12ca41d9c", "name": "National Teacher Appreciation Day", "description": "National Teacher Appreciation Day is a observance in the USA", "country": "us", "date": 20400508, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "67f2cdbb32176506f65fbe592023a68d", "name": "Ascension Day", "description": "Ascension Day is the 40th day of Easter and commemorates the ascension of Jesus Christ into heaven.", "country": "us", "date": 20400510, "type": [ "Christian" ], "primary_type": "Christian", "locations": "All", "states": "All" }, { "uuid": "40442de54ef6fb5921bc79be18e2dba7", "name": "International Day of Argania", "description": "International Day of Argania is a United Nations observance in the USA", "country": "us", "date": 20400510, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "3f462dbca97a7df808906301272374f7", "name": "Military Spouse Appreciation Day", "description": "Appreciate and thank all the military spouses and partners you know on Military Spouse Appreciation Day.", "country": "us", "date": 20400511, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "d8cca1c3d9b6f06cae01cc4eb7528fca", "name": "World Migratory Bird Day", "description": "World Migratory Bird Day is observed the second weekend of May every year.", "country": "us", "date": 20400512, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "a37827e1da94047b423a451eff56afab", "name": "International Nurses Day", "description": "International Nurses Day focuses on the critical contribution of nurses around the world in maintaining public health.", "country": "us", "date": 20400512, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "6711ff8c0b1f36117bbed97b4e0581dc", "name": "Mother's Day", "description": "Mother's Day celebrates the role of mothers and mother figures.", "country": "us", "date": 20400513, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "54bbf732c517309a7acb7c09a39bca28", "name": "International Day of Families", "description": "The International Day of Families is an occasion to celebrate the importance of families to people, societies and cultures around the world.", "country": "us", "date": 20400515, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "d1de4d4d3b69a5c9e40f815aac460905", "name": "Peace Officers Memorial Day", "description": "Peace Officers Memorial Day is held annually in the United States on May 15 in honor of federal, state and local officers killed or disabled in the line of duty.", "country": "us", "date": 20400515, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "906bc86ec1c96be2531c06315f187f15", "name": "International Day of Living Together in Peace", "description": "International Day of Living Together in Peace is a United Nations observance in the USA", "country": "us", "date": 20400516, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "dae783076b77ee6151c6db1d291eb097", "name": "International Day of Light", "description": "International Day of Light is a United Nations observance in the USA", "country": "us", "date": 20400516, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "29f99be134e73592488099d20f3c95dd", "name": "World Telecommunication and Information Society Day", "description": "World Information Society Day is celebrated each year to raise awareness of how information and communication can be beneficial for societies and economies.", "country": "us", "date": 20400517, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "23eea40a10536a4cfd80cc0263ca6efa", "name": "Shavuot", "description": "Shavuot, also known as the Festival of Weeks, is one of three major Jewish festivals.", "country": "us", "date": 20400518, "type": [ "Hebrew" ], "primary_type": "Jewish holiday", "locations": "All", "states": "All" }, { "uuid": "2460ee5d2cda13dfcae0f500f1e1ccfd", "name": "National Defense Transportation Day", "description": "National Defense Transportation Day occurs annually in the United States on the third Friday of May.", "country": "us", "date": 20400518, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "9a018b7fe8e6fd9e53177aaa06c0c658", "name": "Armed Forces Day", "description": "Armed Forces Day is a national observance in the United States on the third Saturday of May each year.", "country": "us", "date": 20400519, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "5ecb0cdffb9308eb9eb4edcda3ae08f9", "name": "Preakness Stakes", "description": "The Preakness Stakes is the second event in the Triple Crown and is annually held two weeks after the Kentucky Derby.", "country": "us", "date": 20400519, "type": [ "Sporting event" ], "primary_type": "Sporting event", "locations": "All", "states": "All" }, { "uuid": "1961c2e339da2e282b4ea152fc625d9f", "name": "Pentecost", "description": "Many Christians in the United States observe Pentecost, also known as Whitsunday or Whit Sunday.", "country": "us", "date": 20400520, "type": [ "Christian" ], "primary_type": "Christian", "locations": "All", "states": "All" }, { "uuid": "9da34f27ca654aa23f95350a3ca23c38", "name": "World Bee Day", "description": "World Bee Day is a United Nations observance in the USA", "country": "us", "date": 20400520, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "d9766beb15d1d39e3a6d3c4dc0f462ee", "name": "World Autoimmune / Autoinflammatory Arthritis Day", "description": "World Autoimmune / Autoinflammatory Arthritis Day is a worldwide observance in the USA", "country": "us", "date": 20400520, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "186073ed079ac09d4529e7264fcbbdf4", "name": "Whit Monday", "description": "Many Christians in the United States will observe Whit Monday, or Pentecost Monday. It is the day after Pentecost, which is also known as Whit Sunday or Whitsunday.", "country": "us", "date": 20400521, "type": [ "Christian" ], "primary_type": "Christian", "locations": "All", "states": "All" }, { "uuid": "f11ea73194ea1dde69888e8c55cb373b", "name": "World Day for Cultural Diversity for Dialogue and Development", "description": "The World Day for Cultural Diversity for Dialogue and Development, held on May 21, is an occasion for people to deepen their understanding of cultural diversity.", "country": "us", "date": 20400521, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "efb93af7437f6fe6313a1f0372b854c2", "name": "International Tea Day", "description": "International Tea Day is a United Nations observance in the USA", "country": "us", "date": 20400521, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "f8881db9dafb50555b73d1270e8133a8", "name": "International Day for Biological Diversity", "description": "The International Day for Biological Diversity is an occasion to increase the global understanding and awareness of issues and challenges around biodiversity.", "country": "us", "date": 20400522, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "780d7285d60f92e6e47aa03cd98e0c2b", "name": "National Maritime Day", "description": "National Maritime Day is annually observed in the United States on May 22. It is a time to observe its maritime heritage, to honor those who served as merchant mariners, and to recognize the benefits of the maritime industry.", "country": "us", "date": 20400522, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "057d572e685e5552392cc6c5a3017982", "name": "Harvey Milk Day", "description": "Harvey Milk Day is an observance that is recognized in public schools in California, United States, on May 22 each year.", "country": "us", "date": 20400522, "type": [ "Local observance" ], "primary_type": "Local observance", "locations": "CA", "states": [ "us-ca" ] }, { "uuid": "4521d54b69c11668c9186273301d1ff5", "name": "International Day to End Obstetric Fistula", "description": "The International Day to End Obstetric Fistula raises awareness of fistula and calls for support to tackle the problem.", "country": "us", "date": 20400523, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "86edb7901268f6d3ce0cf9487d9a871a", "name": "Emergency Medical Services for Children Day", "description": "Emergency Medical Services for Children (EMSC) Day is observed on the Wednesday of Emergency Medical Services (EMS) Week, May 19–25, in the United States.", "country": "us", "date": 20400523, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "f77e883f97fc9a47e1944c68575c6be3", "name": "African Liberation Day", "description": "African Liberation Day celebrates African nations' hard-fought freedom from European colonial powers.", "country": "us", "date": 20400525, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "ff7857ae3ec5dc33c324b581b828b880", "name": "National Missing Children's Day", "description": "National Missing Children's Day is an observation dedicated to addressing the problem of child abduction.", "country": "us", "date": 20400525, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "dc051218d6edc1051ec58c46174ef5a1", "name": "Trinity Sunday", "description": "Trinity Sunday is the first Sunday after Pentecost and is celebrated by many Christians in the United States.", "country": "us", "date": 20400527, "type": [ "Christian" ], "primary_type": "Christian", "locations": "All", "states": "All" }, { "uuid": "4079c533dd8c497b6e5d359d6a6b7dbd", "name": "Memorial Day", "description": "Memorial Day commemorates all Americans who have died in military service for the United States.", "country": "us", "date": 20400528, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "AK, AL, AR, AZ, CA", "states": [ "us-ak", "us-al", "us-ar", "us-az", "us-ca" ] }, { "uuid": "4079c533dd8c497b6e5d359d6a6b7dbd", "name": "Memorial Day", "description": "Memorial Day commemorates all Americans who have died in military service for the United States.", "country": "us", "date": 20400528, "type": [ "National holiday" ], "primary_type": "Federal Holiday", "locations": "All", "states": "All" }, { "uuid": "639c700d7b458ab139a8b6a7131d09cc", "name": "International Day of United Nations Peacekeepers", "description": "The International Day of United Nations Peacekeepers is an occasion to pay tribute to people who served in United Nations (UN) peacekeeping operations.", "country": "us", "date": 20400529, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "326da262903d08e390703520d0efcc1b", "name": "Corpus Christi", "description": "Corpus Christi is observed in honor of the Holy Eucharist.", "country": "us", "date": 20400531, "type": [ "Christian" ], "primary_type": "Christian", "locations": "All", "states": "All" }, { "uuid": "2d572c6640fad1a7082369d7af555afa", "name": "World No Tobacco Day", "description": "World No Tobacco Day draws attention to the health problems caused by tobacco use.", "country": "us", "date": 20400531, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "9f50f9cc8df47c6359c133b2f8441c37", "name": "Global Day of Parents", "description": "Global Day of Parents appreciates the role of a parent in nurturing and fostering growth for their children.", "country": "us", "date": 20400601, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "5c63e8be50a64ba650c3d6f63ea0af6a", "name": "First Day of Pride Month", "description": "First Day of Pride Month is a annual monthly observance in the USA", "country": "us", "date": 20400601, "type": [ "Observance" ], "primary_type": "Annual Monthly Observance", "locations": "All", "states": "All" }, { "uuid": "540739ed7807d780460537561c60f660", "name": "First Day of Caribbean-American Heritage Month", "description": "First Day of Caribbean-American Heritage Month is a annual monthly observance in the USA", "country": "us", "date": 20400601, "type": [ "Observance" ], "primary_type": "Annual Monthly Observance", "locations": "All", "states": "All" }, { "uuid": "c795c4ec28cc5b781a3eca2dfb22fdc4", "name": "World Bicycle Day", "description": "World Bicycle Day is a United Nations observance in the USA", "country": "us", "date": 20400603, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "f024724c4f40bd2cd36ff5b8f7301aaa", "name": "International Day of Innocent Children Victims of Aggression", "description": "The United Nations' (UN) International Day of Innocent Children Victims of Aggression is observed on June 4 each year.", "country": "us", "date": 20400604, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "28311b841e39855565f918c653b1bdf6", "name": "World Environment Day", "description": "World Environment Day is held each year on June 5. It is one of the principal vehicles through which the United Nations (UN) stimulates worldwide awareness of the environment and enhances political attention and action.", "country": "us", "date": 20400605, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "f8683d9b51923ea5ad585afca64b6b94", "name": "International Day for the Fight against Illegal, Unreported and Unregulated Fishing", "description": "International Day for the Fight against Illegal, Unreported and Unregulated Fishing is a United Nations observance in the USA", "country": "us", "date": 20400605, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "d8310551b5fc68878da039725ba62901", "name": "Day of the Russian Language", "description": "Day of the Russian Language is a United Nations observance in the USA", "country": "us", "date": 20400606, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "ce657ffff5857cfd32947a3ec37af76f", "name": "D-Day", "description": "D-Day is a special anniversary in some countries, including the United States (U.S.), to remember Allied forces’ invasion of Normandy, France, in the Second World War.", "country": "us", "date": 20400606, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "336499c4679e6c2d09c16077dca81ad5", "name": "World Food Safety Day", "description": "World Food Safety Day is a United Nations observance in the USA", "country": "us", "date": 20400607, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "cf6fa70811544eb40df4eb83fc5961bd", "name": "World Oceans Day", "description": "World Oceans Day is annually observed on June 8 to raise awareness of the challenges humanity faces to protect the world's oceans.", "country": "us", "date": 20400608, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "ecf9888fd0b06f417a217b1118fc2788", "name": "Belmont Stakes", "description": "The Belmont Stakes is the third and final horse race of the Triple Crown. It is run annually five weeks after the Kentucky Derby.", "country": "us", "date": 20400609, "type": [ "Sporting event" ], "primary_type": "Sporting event", "locations": "All", "states": "All" }, { "uuid": "4ef0fae67c46f8d8930bbd1fb29512fb", "name": "World Day Against Child Labour", "description": "Poverty and injustice against widows is a world-wide problem addressed by International Widows' Day.", "country": "us", "date": 20400612, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "eb0f243bd5d25fbefa08968f18fbd318", "name": "Loving Day", "description": "Loving Day is a observance in the USA", "country": "us", "date": 20400612, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "c363a26ece950f05ef88d5b87aec8be6", "name": "International Albinism Awareness Day", "description": "International Albinism Awareness Day aims to stop the persecution and murders of people with albinism.", "country": "us", "date": 20400613, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "3ab7fedb82af1f9587759131316c3da2", "name": "World Blood Donor Day", "description": "On World Blood Donor Day numerous events are held worldwide to raise awareness about the importance of safe blood supplies.", "country": "us", "date": 20400614, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "95f1056240cd4c867c7a9bd94b33c188", "name": "Army Birthday", "description": "Army Birthday is a observance in the USA", "country": "us", "date": 20400614, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "6e1f13b8cc04fb5bf10f8dd5b2883a22", "name": "Flag Day", "description": "Flag Day is annually held on June 14 to honor the United States flag.", "country": "us", "date": 20400614, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "97f8bdaf2b06c86e54d34e774b574e00", "name": "World Elder Abuse Awareness Day", "description": "World Elder Abuse Awareness Day attempts to shine a light on the problem of physical, emotional, and financial abuse of elders.", "country": "us", "date": 20400615, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "d6855372a58703eaaab959ef28ef50fb", "name": "International Day of Family Remittances", "description": "The UN estimates that family remittances worth over 500 billion US$ are transferred worldwide every year.", "country": "us", "date": 20400616, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "29b9bafe411d56f5a13ade277f43ce41", "name": "Juneteenth National Freedom Day", "description": "Juneteenth National Freedom Day is a state observance in the USA", "country": "us", "date": 20400616, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "CA", "states": [ "us-ca" ] }, { "uuid": "677275273c4024260d0ece5ebeac9dc3", "name": "World Day to Combat Desertification and Drought", "description": "The United Nations' World Day to Combat Desertification and Drought is observed worldwide on June 17 each year.", "country": "us", "date": 20400617, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "6a4b48eb4aea02f2e53ee3386c3914a8", "name": "Father's Day", "description": "Father's Day celebrates the contribution that fathers and father figures make to the lives of their children.", "country": "us", "date": 20400617, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "ac8b4c9c07c2831d5a687f03323a439a", "name": "Sustainable Gastronomy Day", "description": "Sustainable Gastronomy Day is a United Nations observance in the USA", "country": "us", "date": 20400618, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "595a78303b1cc90afefacefaf6995bf1", "name": "International Day for the Elimination of Sexual Violence in Conflict", "description": "International Day for the Elimination of Sexual Violence in Conflict is a UN day aiming to rid the world of conflict-related sexual violence.", "country": "us", "date": 20400619, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "29b9bafe411d56f5a13ade277f43ce41", "name": "Juneteenth", "description": "Juneteenth, also known as Freedom Day and Emancipation Day, is a holiday or observance in many US states to celebrate the anniversary of the abolition of slavery in Texas on June 19, 1865.", "country": "us", "date": 20400619, "type": [ "National holiday" ], "primary_type": "Federal Holiday", "locations": "All", "states": "All" }, { "uuid": "ab1fe5eff0e97db29bd6233bbe4b4268", "name": "World Refugee Day", "description": "The United Nations' World Refugee Day honors refugees' courage, strength and determination.", "country": "us", "date": 20400620, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "69d420833f907c42293c434d9c151e7a", "name": "American Eagle Day", "description": "Observed annually on June 20 in 47 American states, American Eagle Day is an unofficial holiday that celebrates the removal of the American Bald Eagle from a list of \"endangered species\".", "country": "us", "date": 20400620, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "235b1350a5a7cafa47569b8c7ec2aeee", "name": "June Solstice", "description": "June Solstice in the USA (New York)", "country": "us", "date": "20400620T13:46:2204:00", "type": [ "Season" ], "primary_type": "Season", "locations": "All", "states": "All" }, { "uuid": "65d5465b4fbef69ad9fa17984ded48fa", "name": "International Day of Yoga", "description": "The International Day of Yoga is a UN-day that aims to raise awareness worldwide of the many benefits of practicing yoga.", "country": "us", "date": 20400621, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "6401cd3527834d70c61486dab02ba134", "name": "International Day of the Celebration of the Solstice", "description": "International Day of the Celebration of the Solstice is a United Nations observance in the USA", "country": "us", "date": 20400621, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "d08d3304df76599a01932893395e5d43", "name": "Public Service Day", "description": "The United Nations’ Public Service Day celebrates the idea that democracy and successful governance depend on a competent civil service.", "country": "us", "date": 20400623, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "f73afa8e4ebe4405df3ef37a5ca8004f", "name": "International Widows' Day", "description": "Poverty and injustice against widows is a world-wide problem addressed by International Widows' Day.", "country": "us", "date": 20400623, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "a0b52f3ca1a13ec5f1d1f88171a0554f", "name": "Day of the Seafarer", "description": "The Day of the Seafarer aims to acknowledge the social, and economic contribution of the millions of seafarers around the world.", "country": "us", "date": 20400625, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "3a0db53b17de60a3bc81731b4e36f672", "name": "International Day Against Drug Abuse and Illicit Trafficking", "description": "The United Nations’ (UN) International Day Against Drug Abuse and Illicit Trafficking raise awareness about the dangers of illicit drugs.", "country": "us", "date": 20400626, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "07731ea7beb0fc103b39dc05168b8c36", "name": "International Day in Support of Victims of Torture", "description": "The United Nations’ (UN) International Day in Support of Victims of Torture is annually observed on June 26 to remind people that human torture is not only unacceptable – it is also a crime.", "country": "us", "date": 20400626, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "2299cba09bde50305e98f0e55d60cc88", "name": "Micro-, Small and Medium-sized Enterprises Day", "description": "Micro-, Small and Medium-sized Enterprises Day is a United Nations observance in the USA", "country": "us", "date": 20400627, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "2432f0d274ea2b032998491fb8ef0ed7", "name": "International Day of the Tropics", "description": "International Day of the Tropics is a United Nations observance in the USA", "country": "us", "date": 20400629, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "139cc87fa2c8786fd30e8f58eee41938", "name": "International Asteroid Day", "description": "The United Nations established International Asteroid Day to raise public awareness of the asteroid impact hazard.", "country": "us", "date": 20400630, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "0c92b70ddcbe60f17950f2c07c271d74", "name": "International Day of Parliamentarism", "description": "International Day of Parliamentarism is a United Nations observance in the USA", "country": "us", "date": 20400630, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "f20b4cd1d083053b5f5d2f222232731f", "name": "Independence Day", "description": "On Independence Day, Americans celebrate the anniversary of publication of the Declaration of Independence from Great Britain in 1776.", "country": "us", "date": 20400704, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "CA", "states": [ "us-ca" ] }, { "uuid": "f20b4cd1d083053b5f5d2f222232731f", "name": "Independence Day", "description": "On Independence Day, Americans celebrate the anniversary of publication of the Declaration of Independence from Great Britain in 1776.", "country": "us", "date": 20400704, "type": [ "National holiday" ], "primary_type": "Federal Holiday", "locations": "All", "states": "All" }, { "uuid": "692f0c378f0a3b8c03c293e0b6b247cd", "name": "International Day of Cooperatives", "description": "The United Nations' (UN) International Day of Cooperatives recognizes and reaffirms the role of cooperatives in economic, social and cultural development and in the achievement of social policy objectives.", "country": "us", "date": 20400707, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "6d2c2de631862f8dbb18682068b4b8ca", "name": "World Population Day", "description": "The United Nations' (UN) World Population Day reaffirms the human right to plan for a family.", "country": "us", "date": 20400711, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "665c152272d175232dd08ef4c1fb32f8", "name": "Friday the 13th", "description": "Friday the 13th is a day full of superstitious beliefs in communities worldwide.", "country": "us", "date": 20400713, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "2a5ee6fc2c2a7c930c2abe62b21bbb29", "name": "Bastille Day", "description": "Bastille Day is a observance in the USA", "country": "us", "date": 20400714, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "7d5d4ac7dbd776d6ee9aab8d5303e9d6", "name": "World Youth Skills Day", "description": "Acquiring skills enhances youths' ability to make informed choices and empowers them to gain access to changing labor markets.", "country": "us", "date": 20400715, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "c875226c15c9a27e5eff71dae5f7d31c", "name": "Rural Transit Day", "description": "Rural Transit Day is a observance in the USA", "country": "us", "date": 20400716, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "4379181ea3800fc590151dbbc2501c7c", "name": "Nelson Mandela Day", "description": "Nelson Mandela International Day is annually observed on July 18 to recognize the former South African president’s contribution to peace and freedom.", "country": "us", "date": 20400718, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "cbd5a671f21fe9ac4b9ea860304a2ac7", "name": "Tisha B'Av", "description": "Tisha B’Av is on the ninth day of the month of Av in the Jewish calendar.", "country": "us", "date": 20400719, "type": [ "Hebrew" ], "primary_type": "Jewish holiday", "locations": "All", "states": "All" }, { "uuid": "94530c44bc27e6ff9fdf3d5f23e5d4ec", "name": "World Chess Day", "description": "World Chess Day is a United Nations observance in the USA", "country": "us", "date": 20400720, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "3946af877332eb63566fd590f3d2bbc5", "name": "Parents' Day", "description": "Parents’ Day is celebrated in the United States on the fourth Sunday of July each year to recognize and promote parenting as a crucial part of families and the wider community.", "country": "us", "date": 20400722, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "8b65464105f938f4f0924bb830f4f5b3", "name": "World Drowning Prevention Day", "description": "World Drowning Prevention Day is a United Nations observance in the USA", "country": "us", "date": 20400725, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "3fa30eb9b2ed317b48b81408da2c10b2", "name": "National Korean War Veterans Armistice Day", "description": "National Korean War Veterans Armistice Day is a observance in the USA", "country": "us", "date": 20400727, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "64d91cbc6b9c7c40cb74c09fe3f93deb", "name": "World Hepatitis Day", "description": "World Hepatitis Day is observed on July 28 every year to raise awareness of hepatitis and encourage prevention and treatment.", "country": "us", "date": 20400728, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "1e30066becce722c37194e5de584956b", "name": "International Day of Friendship", "description": "The International Day of Friendship is annually held on July 30 to celebrate friendships worldwide.", "country": "us", "date": 20400730, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "7e501a34bdaba379b784854c1eb63e63", "name": "World Day Against Trafficking in Persons", "description": "July 30 is the UN World Day Against Trafficking in Persons", "country": "us", "date": 20400730, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "7aff979cee1e68944682c6bff58b7568", "name": "Coast Guard Birthday", "description": "Coast Guard Birthday is a observance in the USA", "country": "us", "date": 20400804, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "66da5c85ebd32fb5830d977ad958d207", "name": "Isra and Mi'raj", "description": "Isra and Mi'raj (Isra Me'raj, Israa and Mi'raaj, Laylat Al-Isra wa Al-Miraj, Lailat al Miraj, Night Journey and Ascension to Heaven) marks the night when the Prophet Mohammad traveled from Mecca to Jerusalem, ascended to heaven and returned.", "country": "us", "date": 20400806, "type": [ "Muslim" ], "primary_type": "Muslim", "locations": "All", "states": "All" }, { "uuid": "9c10a2aa263fb7768d436da4b888c095", "name": "Purple Heart Day", "description": "Purple Heart Day on August 7 commemorates the day in 1782 when General George Washington created the Purple Heart Medal – a military decoration that is awarded to those wounded or killed while serving in the United States Armed Forces.", "country": "us", "date": 20400807, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "4edd91a9989ebcb33d35100ea61fd5b2", "name": "International Day of the World's Indigenous People", "description": "The United Nations’ (UN) International Day of the World's Indigenous People is observed on August 9 each year to promote and protect the rights of the world’s indigenous peoples.", "country": "us", "date": 20400809, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "ec874a007524d0c177a0dedb3fce437c", "name": "International Youth Day", "description": "The United Nations’ (UN) International Youth Day is annually held on August 12 to celebrate the achievements of the world’s youth and to encourage their participation in enhancing society.", "country": "us", "date": 20400812, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "1a9dbb110511d435e5ea125cd9ac053e", "name": "Assumption of Mary", "description": "Assumption Day is a Christian observance in the United States that is held annually on August 15. Catholics observe the Dormition (falling asleep) or the day that the Blessed Virgin Mary was received into heaven.", "country": "us", "date": 20400815, "type": [ "Christian" ], "primary_type": "Christian", "locations": "All", "states": "All" }, { "uuid": "ecfe67ffc900fb83b0c69ee2d98143b9", "name": "World Humanitarian Day", "description": "The United Nations’(UN) World Humanitarian Day focuses on increasing public awareness about humanitarian service worldwide and is annually observed on August 19.", "country": "us", "date": 20400819, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "0fb4fec92eb0693cbf7146f93ac9bd58", "name": "National Aviation Day", "description": "National Aviation Day is observed in the United States on August 19 each year to celebrate the history and development of the aviation.", "country": "us", "date": 20400819, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "7c75f8e2700899c14b43ec6730bb8cd9", "name": "National Senior Citizens Day", "description": "National Senior Citizens Day is an observance on the third Sunday of August to honor the contributions of senior citizens in the United States.", "country": "us", "date": 20400819, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "e6ee62719aac976e6e2137b8132397be", "name": "International Day of Remembrance of and Tribute to the Victims of Terrorism", "description": "International Day of Remembrance of and Tribute to the Victims of Terrorism is a United Nations observance in the USA", "country": "us", "date": 20400821, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "45429d36ccda1668b97be7a5c7a030e4", "name": "International Day Commemorating the Victims of Acts of Violence Based on Religion or Belief", "description": "International Day Commemorating the Victims of Acts of Violence Based on Religion or Belief is a United Nations observance in the USA", "country": "us", "date": 20400822, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "c9e7e166f8ae31e0146b8c4c896bff0b", "name": "International Day for the Remembrance of the Slave Trade and its Abolition", "description": "The United Nations’ (UN) International Day for the Remembrance of the Slave Trade and its Abolition is held on August 23 each year to remind people of the tragedy of the transatlantic slave trade.", "country": "us", "date": 20400823, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "3bad34628ed53075b543dbae96498c3d", "name": "Women's Equality Day", "description": "Women's Equality Day on August 26 is an annual observance that commemorates the anniversary of the first time voting rights were extended to women in the United States.", "country": "us", "date": 20400826, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "d578ca62d9a2ee9ecdeed3ef10700076", "name": "International Day against Nuclear Tests", "description": "The United Nations’ (UN) International Day against Nuclear Tests is annually observed on August 29. The day raises awareness of the dangers of nuclear weapons and a closer approach to eliminating the use of those weapons.", "country": "us", "date": 20400829, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "cbff229c415b56d69f2e6ca65de05d54", "name": "International Day of the Victims of Enforced Disappearances", "description": "The International Day of the Victims of Enforced Disappearances is annually observed on August 30.", "country": "us", "date": 20400830, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "358abdb456e5548413fe10e91509b4b5", "name": "International Day for People of African Descent", "description": "International Day for People of African Descent is a United Nations observance in the USA", "country": "us", "date": 20400831, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "4e50bdcf35674f99451aac9e81e5c715", "name": "International Overdose Awareness Day", "description": " International Overdose Awareness Day is an annual observation which aims to raise global awareness of about the impact of drug overdose on families and communities. The campaign also attempts to remove the stigma associated with overdose.", "country": "us", "date": 20400831, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "c8e9fb43e9d67d45f95560338085ff31", "name": "Labor Day", "description": "Labor Day is a federal holiday in the United States. It gives workers a day of rest and it celebrates their contribution to the American economy.", "country": "us", "date": 20400903, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "All", "states": [ "us-al", "us-ak", "us-az", "us-ar", "us-ca", "us-co", "us-ct", "us-fl", "us-de", "us-dc", "us-ga", "us-hi", "us-id", "us-il", "us-in", "us-ia", "us-ks", "us-ky", "us-la", "us-ma", "us-me", "us-md", "us-mi", "us-mn", "us-mo", "us-ms", "us-mt", "us-ne", "us-nh", "us-nv", "us-nj", "us-nm", "us-nc", "us-ny", "us-nd", "us-oh", "us-ok", "us-or", "us-pa", "us-ri", "us-sc", "us-sd", "us-tn", "us-tx", "us-ut", "us-vt", "us-va", "us-wa", "us-wv", "us-wy", "us-wi" ] }, { "uuid": "c8e9fb43e9d67d45f95560338085ff31", "name": "Labor Day", "description": "Labor Day is a federal holiday in the United States. It gives workers a day of rest and it celebrates their contribution to the American economy.", "country": "us", "date": 20400903, "type": [ "National holiday" ], "primary_type": "Federal Holiday", "locations": "All", "states": "All" }, { "uuid": "f715cc6c4ab2b5939e39dbeaab7607fc", "name": "World Sexual Health Day", "description": " World Sexual Health Day is an annual awareness day that attempts to break down social and cultural taboos associated with sexuality and to promote sexual health around the world.", "country": "us", "date": 20400904, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "92e53bb746559996330ebb1bb9020334", "name": "International Day of Charity", "description": "The International Day of Charity raises public awareness of what charities do to help minimize poverty.", "country": "us", "date": 20400905, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "0ee29b156f5e5e05523f638ed660d66a", "name": "International Day of Clean Air for Blue Skies", "description": "International Day of Clean Air for Blue Skies is a United Nations observance in the USA", "country": "us", "date": 20400907, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "7fa0f21ee0660a2b271fb84b20da5dcb", "name": "Still's Disease Awareness Day", "description": "Still's Disease Awareness Day is a worldwide observance in the USA", "country": "us", "date": 20400907, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "b0103540a2ec18f35005522c77710ed9", "name": "Rosh Hashana", "description": "Rosh Hashanah is the Jewish New Year. Many Jewish-run organizations in the US are closed during the two-day celebration.", "country": "us", "date": 20400908, "type": [ "Hebrew" ], "primary_type": "Jewish holiday", "locations": "All", "states": "All" }, { "uuid": "a66045836b8c81dfdab6058e3ded0f1c", "name": "Ramadan Starts", "description": "Many Muslims in the United States fast in the hours of daylight during Ramadan, the ninth month in the Islamic calendar.", "country": "us", "date": 20400908, "type": [ "Muslim" ], "primary_type": "Muslim", "locations": "All", "states": "All" }, { "uuid": "548e9ace9cb0c190b5b5b23abe7f81a5", "name": "International Literacy Day", "description": "The United Nations' (UN) International Literacy Day is held on September 8 each year.", "country": "us", "date": 20400908, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "a17c119aa9c8c3a6e6a3c32be8d520a7", "name": "Carl Garner Federal Lands Cleanup Day", "description": "Carl Garner Federal Lands Cleanup Day encourages people in the United States to participate in cleaning up the federal lands. It is observed on the first Saturday after Labor Day.", "country": "us", "date": 20400908, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "ccad8089e5274bf76863275a23795694", "name": "International Day to Protect Education from Attack", "description": "International Day to Protect Education from Attack is a United Nations observance in the USA", "country": "us", "date": 20400909, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "6a145d4b8557066ee30374392bfc7eef", "name": "National Grandparents Day", "description": "National Grandparents Day is celebrated on the first Sunday of September after Labor Day in the United States.", "country": "us", "date": 20400909, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "cfaf44dd9c0060ec7a1141369a4182a4", "name": "California Admission Day", "description": "California Admission Day is an annual legal observance in California, in the United States.", "country": "us", "date": 20400909, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "CA (partly)", "states": [ "us-ca" ] }, { "uuid": "23a9785a3ba25070e48687c3f98edd77", "name": "World Suicide Prevention Day", "description": "World Suicide Prevention Day promotes worldwide action to prevent suicides on September 10 each year.", "country": "us", "date": 20400910, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "e5e8113f951674aaaec62ce9fba48582", "name": "Patriot Day", "description": "Patriot Day is held in memory of nearly 3000 people who died during terrorist attacks in New York, Washington DC and Shanksville, Pennsylvania, in the United States.", "country": "us", "date": 20400911, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "fb216d95beea22061fd539e2aa2c2e9b", "name": "International Day for South-South Cooperation", "description": "The United Nations Day for South-South Cooperation is observed on September 12 each year.", "country": "us", "date": 20400912, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "fb03de8e2d2ad6a948f0e9b9cae9c955", "name": "International Programmers' Day", "description": "Many people celebrate International Programmers’ Day on January 7, while others observe this event on the 256th day of the year, usually on September 13 or on September 12 in leap years.", "country": "us", "date": 20400912, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "613f559facaded2f86add3fe317fdefb", "name": "International Day of Democracy", "description": "The United Nations’ (UN) International Day of Democracy is observed on September 15 each year.", "country": "us", "date": 20400915, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "f3a73d569fd9d3c4d41c4c1a26f6cb66", "name": "First Day of National Hispanic Heritage Month", "description": "First Day of National Hispanic Heritage Month is a annual monthly observance in the USA", "country": "us", "date": 20400915, "type": [ "Observance" ], "primary_type": "Annual Monthly Observance", "locations": "All", "states": "All" }, { "uuid": "e033dac42c15fb2c030e01968e3d6b95", "name": "International Day for the Preservation of the Ozone Layer", "description": "The United Nations' (UN) International Day for the Preservation of the Ozone Layer focuses on the importance of protecting human health and the environment.", "country": "us", "date": 20400916, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "4f0955fc2c27796aed832765ad36ca85", "name": "Yom Kippur", "description": "Yom Kippur is an important Jewish holiday that falls on the 10th day of the month of Tishrei in the Jewish calendar.", "country": "us", "date": 20400917, "type": [ "Hebrew" ], "primary_type": "Jewish holiday", "locations": "All", "states": "All" }, { "uuid": "534ca12818a4afc3f10ec34213f90a9f", "name": "World Patient Safety Day", "description": "World Patient Safety Day is a United Nations observance in the USA", "country": "us", "date": 20400917, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "d0ab54c3b29e32745979b404f8806bed", "name": "Constitution Day and Citizenship Day", "description": "Constitution Day and Citizenship Day is a combined event that occurs in the United States on September 17 each year.", "country": "us", "date": 20400917, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "51d81bb693f6f903d84f171b3162ce8a", "name": "International Equal Pay Day", "description": "International Equal Pay Day is a United Nations observance in the USA", "country": "us", "date": 20400918, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "8054a6cc8cf93bd9817e966451e53ba5", "name": "Air Force Birthday", "description": "Air Force Birthday is a observance in the USA", "country": "us", "date": 20400918, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "e93436942d24350d58f7b7bb1ebb1c28", "name": "International Day of Peace", "description": "The United Nations' (UN) International Day of Peace is annually held on September 21 to recognize the efforts of individuals, organizations and governments to end conflict and promote peace.", "country": "us", "date": 20400921, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "0181d470abd9d3a2049c88e8ade7af82", "name": "National POW/MIA Recognition Day", "description": "National POW/MIA Recognition Day is annually observed in the United States on the third Friday of September.", "country": "us", "date": 20400921, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "b5eb2d6ce9d7614bd6463f9b74c00b43", "name": "First Day of Sukkot", "description": "The first day of Sukkot marks the start of the Sukkot festival for Jewish communities in many countries, including the United States.", "country": "us", "date": 20400922, "type": [ "Hebrew" ], "primary_type": "Jewish holiday", "locations": "All", "states": "All" }, { "uuid": "7c877ecb4a1a10f39181a0d3f4db914d", "name": "National Public Lands Day", "description": "National Public Lands Day is a observance in the USA", "country": "us", "date": 20400922, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "a5886522893924928a703a68d0d9a35e", "name": "September Equinox", "description": "September Equinox in the USA (New York)", "country": "us", "date": "20400922T05:44:5404:00", "type": [ "Season" ], "primary_type": "Season", "locations": "All", "states": "All" }, { "uuid": "6280da167e9e102cc915b7c66fb32e2e", "name": "International Day of Sign Languages", "description": "International Day of Sign Languages is a United Nations observance in the USA", "country": "us", "date": 20400923, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "22420ea8518f75ff6c9b903e5a59f936", "name": "International Celebrate Bisexuality Day", "description": "International Celebrate Bisexuality Day, also known as Bi Visibility Day, promotes the rights of bisexual people around the world.", "country": "us", "date": 20400923, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "302e8db884cdea1d702e76ce5e29e103", "name": "International Day for the Total Elimination of Nuclear Weapons", "description": "The International Day for the Total Elimination of Nuclear Weapons raises awareness about the dangers of nuclear weapons.", "country": "us", "date": 20400926, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "d580281438be4930865112bcd2e168e0", "name": "World Maritime Day", "description": "World Maritime Day is held on the last week of September each year, although the exact date is up to individual governments around the world.", "country": "us", "date": 20400927, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "dbffa8af5893569c1af2ff795b322f5e", "name": "World Tourism Day", "description": "The United Nations’ (UN) World Tourism Day is annually held on September 27 to raise awareness on the benefits of tourism.", "country": "us", "date": 20400927, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "a0f8e75b1e323a5ca29774479d8cca1d", "name": "Last Day of Sukkot", "description": "Many Jewish communities in countries such as the United States observe the last day of Sukkot, which marks the end of the Sukkot festival.", "country": "us", "date": 20400928, "type": [ "Hebrew" ], "primary_type": "Jewish holiday", "locations": "All", "states": "All" }, { "uuid": "a856c74976e5481403a44b1e873cc050", "name": "International Day for Universal Access to Information", "description": "International Day for Universal Access to Information is a United Nations observance in the USA", "country": "us", "date": 20400928, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "f7effc05d6811fbd8a3247a89f0d13ea", "name": "World Rabies Day", "description": "World Rabies Day is annually observed on September 28 to raise awareness about rabies and how it can be prevented.", "country": "us", "date": 20400928, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "8b5e1a7b3432455de7e50d6085c0ed3a", "name": "Native American Day", "description": "Native Americans' Day, on the second Monday of October, is celebrated some parts of the United States in lieu of Columbus Day.", "country": "us", "date": 20400928, "type": [ "Local observance" ], "primary_type": "State Observance", "locations": "CA", "states": [ "us-ca" ] }, { "uuid": "d0424383d327e020d81b8d78264511c0", "name": "Shmini Atzeret", "description": "Shemini Atzeret (or Shmini Atzeret) is a Jewish holiday dedicated to the love of God, while Simchat Torah (Simchas Torah or Simhat Torah) marks the end of Sukkot and celebrates the completion of the annual reading of the Torah.", "country": "us", "date": 20400929, "type": [ "Hebrew" ], "primary_type": "Jewish holiday", "locations": "All", "states": "All" }, { "uuid": "f3470ece45e71a97caa7458c4842cc50", "name": "International Day of Awareness of Food Loss and Waste", "description": "International Day of Awareness of Food Loss and Waste is a United Nations observance in the USA", "country": "us", "date": 20400929, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "3a9094cd1482cf2ebee9c6db577a71ae", "name": "World Heart Day", "description": "World Heart Day raises awareness of cardiovascular diseases and ways to reduce their risk.", "country": "us", "date": 20400929, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "fadad20ae4a01f52ee779ce9734b6577", "name": "Simchat Torah", "description": "Simchat Torah (Simchas Torah or Simhat Torah) is a Jewish holiday that marks the end of Sukkot and celebrates the completion of the annual reading of the Torah.", "country": "us", "date": 20400930, "type": [ "Hebrew" ], "primary_type": "Jewish holiday", "locations": "All", "states": "All" }, { "uuid": "d6f264b0fee5e4c2b7faf4554bef9411", "name": "International Translation Day", "description": "International Translation Day is a United Nations observance in the USA", "country": "us", "date": 20400930, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "3b328f35a3db9ff84cc843e940dc7da2", "name": "Gold Star Mother's Day", "description": "Gold Star Mother’s Day is annually observed in the United States on the last Sunday of September.", "country": "us", "date": 20400930, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "1b2fe0f2fbd40695b87c561e7b1928b5", "name": "International Day of Older Persons", "description": "The United Nations' (UN) International Day of Older Persons is celebrated on October 1 each year as a special day for older persons worldwide.", "country": "us", "date": 20401001, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "bcdcd72a3b2095d9a6463bf79d907907", "name": "World Habitat Day", "description": "The United Nations’ (UN) World Habitat Day reflects on the state of human settlements and people’s right to sufficient shelter.", "country": "us", "date": 20401001, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "b493e10af61583fbda3048c674376e3a", "name": "World Vegetarian Day", "description": "World Vegetarian Day is an annual observation that spreads awareness about the health, environmental, and ethical benefits of following a vegetarian lifestyle. The unofficial holiday encourages people to avoid eating foods that include animal products and to adopt a plant-based diet.", "country": "us", "date": 20401001, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "55f1679202849707ce60cb3eb38bc81d", "name": "Child Health Day", "description": "Child Health Day is annually celebrated in the United States on the first Monday of October.", "country": "us", "date": 20401001, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "33829ed2c5407a7a689e78b61a262f9d", "name": "International Day of Non-Violence", "description": "The United Nations’ (UN) International Day of Non-Violence is a globally observed on October 2 each year to promote non-violence.", "country": "us", "date": 20401002, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "f4ba4a2fdea81a5f605617650fe468c1", "name": "Lailat al-Qadr", "description": "Laylat al Qadr is most likely to be held on one of the last 10 days of month of Ramadan in the Islamic calendar.", "country": "us", "date": 20401003, "type": [ "Muslim" ], "primary_type": "Muslim", "locations": "All", "states": "All" }, { "uuid": "5e871615ced0cd8cf9b1250ca156f801", "name": "Feast of St Francis of Assisi", "description": "Many Catholics in the United States, particularly those with pets, celebrate the Feast of St Francis of Assisi, the patron saint of animals and the environment, on October 4 each year.", "country": "us", "date": 20401004, "type": [ "Christian" ], "primary_type": "Christian", "locations": "All", "states": "All" }, { "uuid": "eacab490d2658decfce2c07c3d29213f", "name": "World Teachers' Day", "description": "The United Nations' (UN) World Teachers' Day commemorates the work of teachers and their contributions to society. It is observed on October 5 each year.", "country": "us", "date": 20401005, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "f0a9d485197bd77327bbdf5dda04aa80", "name": "World Cerebral Palsy Day", "description": "World Cerebral Palsy Day is an annual awareness observation that brings together people with cerebral palsy, their families and loved ones, and organizations working to ensure equal rights for them.", "country": "us", "date": 20401006, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "8855b8afa02587551cc2dcaa10ed4ac8", "name": "German American Day", "description": "German American Day is a observance in the USA", "country": "us", "date": 20401006, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "90d8106fd5deefcc7d88c0ff5d5ac512", "name": "Eid al-Fitr", "description": "Eid al-Fitr is a holiday to mark the end of the Islamic month of Ramadan, during which Muslims fast during the hours of daylight.", "country": "us", "date": 20401008, "type": [ "Muslim" ], "primary_type": "Muslim", "locations": "All", "states": "All" }, { "uuid": "cfdd6a849c545010ac2600a0dbefd59b", "name": "Columbus Day", "description": "Columbus Day celebrates 15th century explorer Christopher Columbus's arrival in America in 1492.", "country": "us", "date": 20401008, "type": [ "National holiday" ], "primary_type": "Federal Holiday", "locations": "All", "states": "All" }, { "uuid": "df3a19d9d2ab2a315769febf33c8df32", "name": "World Post Day", "description": "World Post Day marks the anniversary of the Universal Postal Union's establishment in 1874. It is held on October 9 each year.", "country": "us", "date": 20401009, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "b04e9216e9f0d7ef3822b04e9c665552", "name": "Leif Erikson Day", "description": "Leif Erikson Day honors the first Scandinavian known to have set foot on American soil and the contribution of the Nordic peoples to the United States.", "country": "us", "date": 20401009, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "9e0086db4a1ead6b358a2f669fe2bf58", "name": "International Day for Natural Disaster Reduction", "description": "The United Nations’ (UN) International Day for Natural Disaster Reduction is annually observed on the second Wednesday of October to promote a global culture of natural disaster risk reduction.", "country": "us", "date": 20401010, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "3f4378c73925c91115a4f18f46fdf773", "name": "World Mental Health Day", "description": "World Mental Health Day, which is supported by the United Nations (UN), is annually held on October 10 to raise public awareness about mental health issues worldwide.", "country": "us", "date": 20401010, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "f2a06ad8a8f2ab2b6901cf92a3c2a410", "name": "International Day of the Girl Child", "description": "The International Day of the Girl Child is a United Nations (UN) observance on October 11 each year.", "country": "us", "date": 20401011, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "9a6a447f57037b22a947f7ea3e3c09ff", "name": "World Sight Day", "description": "World Sight Day is annually held on the second Thursday of October to raise awareness about blindness and vision impairment.", "country": "us", "date": 20401011, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "d8cca1c3d9b6f06cae01cc4eb7528fca", "name": "World Migratory Bird Day", "description": "World Migratory Bird Day is observed the second weekend of May every year.", "country": "us", "date": 20401013, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "ca60dd3b1d6651c12602d37892ed1d90", "name": "Navy Birthday", "description": "Navy Birthday celebrates the establishment of the United States Navy on October 13, 1775.", "country": "us", "date": 20401013, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "009fdf9227b5e15f069a8589e48f5125", "name": "International Day of Rural Women", "description": "The United Nations’ (UN) International Day of Rural Women is annually celebrated on October 15 to recognize rural women’s role in supporting their communities.", "country": "us", "date": 20401015, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "86b44c4b65f4aa42ff2d973196463a93", "name": "White Cane Safety Day", "description": "White Cane Safety Day is a United States observance annually held on October 15 to celebrate blind and visually impaired people's achievements and the importance of the white cane.", "country": "us", "date": 20401015, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "d5c423129eeda9be21619d83c0da409d", "name": "World Food Day", "description": "World Food Day is celebrated on October 16 each year.", "country": "us", "date": 20401016, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "5abc537885c38df1fdb08107194d1aca", "name": "Boss's Day", "description": "Boss’s Day is observed in many workplaces in the United States on October 16, or the nearest working day, each year.", "country": "us", "date": 20401016, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "8574ef3bd839199470f11faf1d886fcf", "name": "International Day for the Eradication of Poverty", "description": "The United Nations’ (UN) International Day for the Eradication of Poverty is annually observed on October 17 to promote awareness of the need to eradicate poverty worldwide.", "country": "us", "date": 20401017, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "395b659ab722f9be2f4d5cf654285bc3", "name": "United Nations Day", "description": "United Nations Day marks the anniversary of the United Nations Charter coming into force in 1945 and celebrates the work of this organization. United Nations Day annually falls on October 24.", "country": "us", "date": 20401024, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "10c7c1c7eebaac3c68e13c17c34ca518", "name": "World Development Information Day", "description": "The United Nations' (UN) World Development Information Day falls on October 24 each year.", "country": "us", "date": 20401024, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "3cc864b2a06c1b55b1ab03ea131950f5", "name": "World Day for Audiovisual Heritage", "description": "The World Day for Audiovisual Heritage is observed on October 27 every year.", "country": "us", "date": 20401027, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "abb58980bf9eb0046870269035fc93b3", "name": "World Stroke Day", "description": "World Stroke Day is annually held on October 29 to raise awareness about stroke and ways to combat it.", "country": "us", "date": 20401029, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "ee51bba46e66f8ee9ef07d2e9486cc0b", "name": "World Cities Day", "description": "World Cities Day is a UN observance that aims to recognize the role of cities as a foundation for social and economic development.", "country": "us", "date": 20401031, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "537802593ce2aa858ab05b5561ddd930", "name": "Halloween", "description": "Halloween is celebrated by hosting costume parties, playing 'trick-or-treat', watching horror films, visiting haunted houses or carving lanterns out of pumpkins.", "country": "us", "date": 20401031, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "2479154727a9af2e2ee42f2358493755", "name": "All Saints' Day", "description": "Many Catholics honor all the saints on All Saints' Day, also known as All Hallows' Day, in the United States.", "country": "us", "date": 20401101, "type": [ "Christian" ], "primary_type": "Christian", "locations": "All", "states": "All" }, { "uuid": "0226e4ddbe4b88e910f6788e24ce3686", "name": "World Vegan Day", "description": "World Vegan Day is an annual observation that brings together vegans around the world to bring attention to animal rights and to spread the word about the health advantages of following a vegan diet.", "country": "us", "date": 20401101, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "1bb9323965c7885ee4572d7217ecf9fb", "name": "First Day of Native American Heritage Month", "description": "First Day of Native American Heritage Month is a annual monthly observance in the USA", "country": "us", "date": 20401101, "type": [ "Observance" ], "primary_type": "Annual Monthly Observance", "locations": "All", "states": "All" }, { "uuid": "5d03453269740d817c4171eddaf0ee0d", "name": "All Souls' Day", "description": "Prayers for the dead are made on All Souls’ Day in the United States, which falls on November 2 each year. The Day of the Dead is also celebrated on this day.", "country": "us", "date": 20401102, "type": [ "Christian" ], "primary_type": "Christian", "locations": "All", "states": "All" }, { "uuid": "ec827057d22f7f0f59042f916f9bf91a", "name": "International Day to End Impunity for Crimes against Journalists", "description": "The International Day to End Impunity for Crimes against Journalists raises awareness about violence against journalists.", "country": "us", "date": 20401102, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "7bcbe3c82e3cdf2d37cf5f13b5f7ecbc", "name": "New York City Marathon", "description": "The New York City Marathon is one of the world's largest marathons and takes place every year in November.", "country": "us", "date": 20401104, "type": [ "Sporting event" ], "primary_type": "Sporting event", "locations": "All", "states": "All" }, { "uuid": "77b6082282be84a3101e54edb8201421", "name": "Daylight Saving Time ends", "description": "Daylight Saving Time ends in the USA", "country": "us", "date": "20401104T02:00:0004:00", "type": [ "Clock change/Daylight Saving Time" ], "primary_type": "Clock change/Daylight Saving Time", "locations": "All", "states": "All" }, { "uuid": "fdbdd856c1a8acfe6607810ca9723cae", "name": "World Tsunami Awareness Day", "description": "World Tsunami Awareness Day is a United Nations observance in the USA", "country": "us", "date": 20401105, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "501fdd4c288d1668d26d41663894b4d2", "name": "International Day for Preventing the Exploitation of the Environment in War and Armed Conflict", "description": "The United Nations’ (UN) International Day for Preventing the Exploitation of the Environment in War and Armed Conflict is held on November 6 each year.", "country": "us", "date": 20401106, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "dd264f59e889813d2a4fe375a38b17df", "name": "Election Day (General Election)", "description": "Election Day in the United States of America is the day on which popular ballots are held to select public officials.", "country": "us", "date": 20401106, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "7d6b786303f55bb1d12e24fb8aa1a9df", "name": "World Science Day for Peace and Development", "description": "The World Science Day for Peace and Development (WSDPD) is celebrated on November 10 each year.", "country": "us", "date": 20401110, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "c9725c7e73b94564d6d90c83ff185391", "name": "Marine Corps Birthday", "description": "Marine Corps Birthday celebrates the establishment of the United States Marine Corps on November 10, 1775.", "country": "us", "date": 20401110, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "74f1d4f7c4bcb32f28c8f38c97e3dd20", "name": "Singles’ Day", "description": "", "country": "us", "date": 20401111, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "6ad4d26a4fd2c4c4f4e19666c0371ed6", "name": "Veterans Day", "description": "Veterans Day in the USA is a holiday to honor all who have served in the United States Military Services.", "country": "us", "date": 20401111, "type": [ "National holiday" ], "primary_type": "Federal Holiday", "locations": "All", "states": "All" }, { "uuid": "6ad4d26a4fd2c4c4f4e19666c0371ed6", "name": "Veterans Day", "description": "Veterans Day in the USA is a holiday to honor all who have served in the United States Military Services.", "country": "us", "date": 20401111, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "All except MA, MS, NY, RI, TX, WI, WY", "states": [ "us-al", "us-ak", "us-az", "us-ar", "us-ca", "us-co", "us-ct", "us-fl", "us-de", "us-dc", "us-ga", "us-hi", "us-id", "us-il", "us-in", "us-ia", "us-ks", "us-ky", "us-la", "us-md", "us-me", "us-mi", "us-mn", "us-mo", "us-mt", "us-ne", "us-nv", "us-nj", "us-nh", "us-nm", "us-nc", "us-nd", "us-oh", "us-ok", "us-or", "us-pa", "us-sc", "us-sd", "us-tn", "us-ut", "us-vt", "us-va", "us-wa", "us-wv" ] }, { "uuid": "cbe6d4aa50b712b6c594d7dcf73df363", "name": "World Pneumonia Day", "description": "World Pneumonia Day supports all efforts made to protect and treat people against pneumonia, the single largest cause of child deaths worldwide.", "country": "us", "date": 20401112, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "6ad4d26a4fd2c4c4f4e19666c0371ed6", "name": "Veterans Day (substitute)", "description": "Veterans Day in the USA is a holiday to honor all who have served in the United States Military Services.", "country": "us", "date": 20401112, "type": [ "National holiday" ], "primary_type": "Federal Holiday", "locations": "All", "states": "All" }, { "uuid": "6ad4d26a4fd2c4c4f4e19666c0371ed6", "name": "Veterans Day (substitute)", "description": "Veterans Day in the USA is a holiday to honor all who have served in the United States Military Services.", "country": "us", "date": 20401112, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "All except MA, MS, NY, RI, TX, WI, WY", "states": [ "us-al", "us-ak", "us-az", "us-ar", "us-ca", "us-co", "us-ct", "us-fl", "us-de", "us-dc", "us-ga", "us-hi", "us-id", "us-il", "us-in", "us-ia", "us-ks", "us-ky", "us-la", "us-md", "us-me", "us-mi", "us-mn", "us-mo", "us-mt", "us-ne", "us-nv", "us-nj", "us-nh", "us-nm", "us-nc", "us-nd", "us-oh", "us-ok", "us-or", "us-pa", "us-sc", "us-sd", "us-tn", "us-ut", "us-vt", "us-va", "us-wa", "us-wv" ] }, { "uuid": "7d6f3fe17242689d074911064942c521", "name": "World Diabetes Day", "description": "World Diabetes Day is held annually to raise awareness of diabetes and its complications and the care that people with this condition need. It is observed on November 14 each year.", "country": "us", "date": 20401114, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "b828b893cd8552034c9ce413a59b5d57", "name": "World Philosophy Day", "description": "World Philosophy Day is celebrated on the third Thursday of November each year.", "country": "us", "date": 20401115, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "f6866b8a62c29386ab89ea57ac52653a", "name": "International Day for Tolerance", "description": "The United Nations’ (UN) International Day for Tolerance is observed on November 16 each year to help people understand the importance of tolerance worldwide.", "country": "us", "date": 20401116, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "45cf0afcadaad26ddd7f59660c39e3a1", "name": "Fake Friday", "description": "Many early-bird shoppers look for bargains on Fake Friday to get ahead of the crowds in stores on Black Friday, observed a week later.", "country": "us", "date": 20401116, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "0bcb9a0b44cbadefb13ea37257893b2b", "name": "World Prematurity Day", "description": " World Prematurity Day is an annual observance that is dedicated to raising awareness about the health and emotional issues surrounding preterm birth.", "country": "us", "date": 20401117, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "fd94246ff406a42fa104c51cca0c450c", "name": "World Day of Remembrance for Road Traffic Victims", "description": "The World Day of Remembrance for Road Traffic Victims serves as a major advocacy day for road traffic injury prevention.", "country": "us", "date": 20401118, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "a519c07009b381005b8f748a0c787f20", "name": "World Toilet Day", "description": "World Toilet Day aims to promote public awareness of the need for adequate toilets to improve people’s health and save lives.", "country": "us", "date": 20401119, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "82b35785dd93cda6423ef7710e7436f8", "name": "International Men's Day", "description": "International Men’s Day celebrates men's achievements worldwide and throughout history.", "country": "us", "date": 20401119, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "6ed440a863f2955967525e152dbb36d0", "name": "Universal Children's Day", "description": "The United Nations' (UN) Universal Children's Day is an occasion to promote the welfare of children and an understanding between children all over the world. It is held on November 20 each year", "country": "us", "date": 20401120, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "3612cafd7848319ee6a3ac62ed0e74ee", "name": "Africa Industrialization Day", "description": "Africa Industrialization Day aims to stimulate the international community's commitment to the industrialization of Africa.", "country": "us", "date": 20401120, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "f4c84f5123b029aeead546c38641b8a1", "name": "Transgender Day of Remembrance", "description": "Transgender Day of Remembrance is a worldwide observance in the USA", "country": "us", "date": 20401120, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "5c5a5784cf9f6e4f7a93bbf1c45ef882", "name": "World Television Day", "description": "The United Nations’ (UN) World Television Day is globally celebrated on November 21 each year.", "country": "us", "date": 20401121, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "f8c85f44d3d5629d9197d68bf1c1589e", "name": "Thanksgiving Day", "description": "Thanksgiving Day in the United States is traditionally a holiday to give thanks for the food collected at the end of the harvest season.", "country": "us", "date": 20401122, "type": [ "National holiday" ], "primary_type": "Federal Holiday", "locations": "All", "states": "All" }, { "uuid": "f8c85f44d3d5629d9197d68bf1c1589e", "name": "Thanksgiving Day", "description": "Thanksgiving Day in the United States is traditionally a holiday to give thanks for the food collected at the end of the harvest season.", "country": "us", "date": 20401122, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "All", "states": [ "us-al", "us-ak", "us-az", "us-ar", "us-ca", "us-co", "us-ct", "us-fl", "us-de", "us-dc", "us-ga", "us-hi", "us-id", "us-il", "us-in", "us-ia", "us-ks", "us-ky", "us-la", "us-ma", "us-me", "us-md", "us-mi", "us-mn", "us-mo", "us-ms", "us-mt", "us-ne", "us-nh", "us-nv", "us-nj", "us-nm", "us-nc", "us-ny", "us-nd", "us-oh", "us-ok", "us-or", "us-pa", "us-ri", "us-sc", "us-sd", "us-tn", "us-tx", "us-ut", "us-vt", "us-va", "us-wa", "us-wv", "us-wy", "us-wi" ] }, { "uuid": "74fc5c4bfbb719433505e971b5aafde5", "name": "Day After Thanksgiving", "description": "The Day After Thanksgiving, also known as Black Friday, is a state holiday more than 20 states.", "country": "us", "date": 20401123, "type": [ "Local holiday" ], "primary_type": "State Holiday", "locations": "19 states", "states": [ "us-ca", "us-de", "us-fl", "us-il", "us-ia", "us-ks", "us-ky", "us-me", "us-mi", "us-mn", "us-nc", "us-ne", "us-nh", "us-ok", "us-pa", "us-sc", "us-tn", "us-tx", "us-va" ] }, { "uuid": "4cd4f747bc86d708db2ff0ef94c4ef81", "name": "Black Friday", "description": "Black Friday is the day after Thanksgiving Day in the USA. It is a busy shopping day and is a holiday in some states.", "country": "us", "date": 20401123, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "7ec561a23fc6fcface0e32a06557b540", "name": "Native American Heritage Day", "description": "Native American Heritage Day is a observance in the USA", "country": "us", "date": 20401123, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "309cd492182ea4a46a09d0ddbe089c0b", "name": "International Day for the Elimination of Violence against Women", "description": "The United Nations' (UN) International Day for the Elimination of Violence against Women raises public awareness of violence against women in all countries around the world and at all levels of society. It is observed each year on November 25.", "country": "us", "date": 20401125, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "880e7535b63ac2a5da52ac95a3ebd6df", "name": "Cyber Monday", "description": "Most online retailers in the US offer discounted prices on their products and services on Cyber Monday.", "country": "us", "date": 20401126, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "1c8a369ca2bf32a129e6a231a3674a35", "name": "Giving Tuesday", "description": "", "country": "us", "date": 20401127, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "b1813e6361112e797605455c840bef4e", "name": "Giving Tuesday", "description": "The first Tuesday after Thanksgiving has been dubbed “Giving Tuesday” by charities.", "country": "us", "date": 20401127, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "a3fc6c9ae85a92e3f16e4d97b0edae1d", "name": "International Day of Solidarity with the Palestinian People", "description": "The United Nations’ (UN) International Day of Solidarity with the Palestinian People is annually observed on November 29.", "country": "us", "date": 20401129, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "be75a4711c1acd0b8dea915acb37715d", "name": "Chanukah/Hanukkah (first day)", "description": "The first day of Hanukkah is the start of the Hanukkah period, which lasts for eight days, from the 25th day of the month of Kislev to the second day of Tevet in the Hebrew calendar.", "country": "us", "date": 20401130, "type": [ "Hebrew" ], "primary_type": "Jewish holiday", "locations": "All", "states": "All" }, { "uuid": "83f04aaedfd7c2a739f7474c5a653acb", "name": "Day of Remembrance for all Victims of Chemical Warfare", "description": "The UN’s Day of Remembrance for all Victims of Chemical Warfare is annually observed on April 29.", "country": "us", "date": 20401130, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "ded8126853354d07ff24c498b1546902", "name": "World AIDS Day", "description": "The United Nations' (UN) World AIDS Day is annually observed on December 1.", "country": "us", "date": 20401201, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "f31382681cbccfce1431d26d772fba0a", "name": "First Sunday of Advent", "description": "Many Christians in the United States observe the first Sunday of Advent, which marks the start of the Christian year.", "country": "us", "date": 20401202, "type": [ "Christian" ], "primary_type": "Christian", "locations": "All", "states": "All" }, { "uuid": "69f9183c9105c303630ac5a6312cdbc0", "name": "International Day for the Abolition of Slavery", "description": "The United Nations’ (UN) International Day for the Abolition of Slavery is annually observed on December 2.", "country": "us", "date": 20401202, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "0c947ead181beab0819e69c5a75fc34f", "name": "International Day of Persons with Disabilities", "description": "The United Nations' (UN) International Day of Persons with Disabilities is annually observed on December 3 to re-affirm and draw attention to the rights of people who live with disabilities.", "country": "us", "date": 20401203, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "f7d2f2220c16c8b16b5464121801bce8", "name": "International Day of Banks", "description": "International Day of Banks is a United Nations observance in the USA", "country": "us", "date": 20401204, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "43371d465d09b16fcb5d6f05afaa3388", "name": "International Volunteer Day for Economic and Social Development", "description": "The United Nations’ (UN) International Volunteer Day for Economic and Social Development, also known as International Volunteer Day (IVD), is observed on December 5 each year.", "country": "us", "date": 20401205, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "8ab599de4f390d545ab96ff78bf29d2d", "name": "World Soil Day", "description": "World Soil Day raises awareness of why soil is needed for sustainable living.", "country": "us", "date": 20401205, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "99ecf2be3592cff74d5427392b243192", "name": "St Nicholas Day", "description": "Some churches in the United States recognize St Nicholas' Day as a feast day.", "country": "us", "date": 20401206, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "2c8bba22a1d3d7fc716564ee25ea9db6", "name": "Last Day of Chanukah", "description": "The last day of Hanukkah marks the end of a festive Jewish occasion, known as Hanukkah or Chanukah.", "country": "us", "date": 20401207, "type": [ "Hebrew" ], "primary_type": "Jewish holiday", "locations": "All", "states": "All" }, { "uuid": "ea5443a44c2dbe59fa3d5cfbc5be7ddc", "name": "International Civil Aviation Day", "description": "International Civil Aviation Day is observed globally on December 7 each year. It is observed by organizations such as the International Civil Aviation Organization (ICAO).", "country": "us", "date": 20401207, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "b6e99df2aa90f32c71a994ab37818163", "name": "Pearl Harbor Remembrance Day", "description": "National Pearl Harbor Remembrance Day remembers those who died or were injured when Pearl Harbor, in Hawaii, was attacked in 1941.", "country": "us", "date": 20401207, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "0cbef3591f9ba87addd8d4fb341befb3", "name": "Feast of the Immaculate Conception", "description": "The Feast of the Immaculate Conception is a Christian observance on December 8 each year.", "country": "us", "date": 20401208, "type": [ "Christian" ], "primary_type": "Christian", "locations": "All", "states": "All" }, { "uuid": "919aac8b3cbff7e902f4160675e0a5cb", "name": "International Anti-Corruption Day", "description": "The United Nations’ (UN) International Anti-Corruption Day is annually observed on December 9 to raise public awareness of corruption and ways to fight it.", "country": "us", "date": 20401209, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "553b16e2d444cc0f5949fa915953414a", "name": "World Genocide Commemoration Day", "description": "World Genocide Commemoration Day is a UN holiday dedicated to the victims of genocide.", "country": "us", "date": 20401209, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "53ef487d638d1c32b831c698881c2bdb", "name": "Human Rights Day", "description": "Human Rights Day marks the anniversary of when the Universal Declaration of Human Rights was proclaimed.", "country": "us", "date": 20401210, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "8662741ee194c2c1473e613f2496dc8d", "name": "Green Monday", "description": "The last Monday at least ten days before Christmas has been dubbed “Green Monday” by online marketers.", "country": "us", "date": 20401210, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "115cc8938be52f318334d6d174ef4415", "name": "International Mountain Day", "description": "The United Nations' (UN) International Mountain Day is an occasion to help raise awareness of the people who live in mountainous regions and the role that these regions play in providing food, water, and recreation. It is observed on December 11 each year.", "country": "us", "date": 20401211, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "f0cd3c4042200ddf5e1479a78be9ebfb", "name": "International Day of Neutrality", "description": "International Day of Neutrality is a United Nations observance in the USA", "country": "us", "date": 20401212, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "6c7fa05ce770ba0d8a21bde490eeb3be", "name": "International Universal Health Coverage Day", "description": "International Universal Health Coverage Day is a United Nations observance in the USA", "country": "us", "date": 20401212, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "6050b621fae729c957c4322f5d443cc8", "name": "Feast of Our Lady of Guadalupe", "description": "The Feast of Our Lady Guadalupe, in honor of Jesus’ mother Mary, is a Catholic observance in the United States.", "country": "us", "date": 20401212, "type": [ "Christian" ], "primary_type": "Christian", "locations": "All", "states": "All" }, { "uuid": "25cc5b4424bb1a7a047836fa6b2fbb43", "name": "National Guard Birthday", "description": "National Guard Birthday is a observance in the USA", "country": "us", "date": 20401213, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "ebb9de419bec63f0a1fa56be502a286a", "name": "Asarah B'Tevet", "description": "Asarah B'Tevet is a Jewish holiday in the USA", "country": "us", "date": 20401214, "type": [ "Hebrew" ], "primary_type": "Jewish holiday", "locations": "All", "states": "All" }, { "uuid": "7dad0a4ad5c8a7188e3e3027047d6ed0", "name": "Eid al-Adha", "description": "For more than 3 millions Muslims in the US, Eid al-Adha, the Festival of Sacrifice, is one of the most important dates in the calendar.", "country": "us", "date": 20401215, "type": [ "Muslim" ], "primary_type": "Muslim", "locations": "All", "states": "All" }, { "uuid": "00fdb08660ed6ee6d676a37386173d19", "name": "Bill of Rights Day", "description": "Bill of Rights Day is a observance in the USA", "country": "us", "date": 20401215, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "e88bd15cefb1583c692c504929b02f5b", "name": "Pan American Aviation Day", "description": "December 17 marks Pan American Aviation Day, which is annually observed in the United States.", "country": "us", "date": 20401217, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "58e5f3cf3e13bbefeb77f3760a6fd5fc", "name": "Wright Brothers Day", "description": "The Wright Brothers Day is annually celebrated in the United States on December 17 to commemorate the historic flight made by Orville and Wilbur Wright on that date in 1903.", "country": "us", "date": 20401217, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "2620eebe13b17df765579b9478ecb8fb", "name": "International Migrants Day", "description": "The United Nations (UN) International Migrants Day is celebrated on December 18 each year.", "country": "us", "date": 20401218, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "1412d40e6baa7587588b598cccdfed1d", "name": "Arabic Language Day", "description": "World Arabic Language Day is a United Nations (UN) observance that celebrates one of the organization’s 6 official languages – Arabic.", "country": "us", "date": 20401218, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "522db973500e0554bf741e922283b72c", "name": "International Human Solidarity Day", "description": "The United Nations' (UN) International Human Solidarity Day is celebrated on December 20 each year to raise public awareness on the importance of solidarity in fighting poverty.", "country": "us", "date": 20401220, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "182f9d9462ef40cca60e6528e842a5c0", "name": "December Solstice", "description": "December Solstice in the USA (New York)", "country": "us", "date": "20401221T01:32:5005:00", "type": [ "Season" ], "primary_type": "Season", "locations": "All", "states": "All" }, { "uuid": "ab864e7cb9324cc3e926e14129ac5196", "name": "Super Saturday", "description": "The final Saturday before Christmas has become a very popular shopping day in the US, earning the nickname Super Saturday.", "country": "us", "date": 20401222, "type": [ "Worldwide observance" ], "primary_type": "Worldwide observance", "locations": "All", "states": "All" }, { "uuid": "cf499c9e16bdf03af9a73331dc71c0eb", "name": "Christmas Eve", "description": "Christmas Eve in the United States is on December 24 each year.", "country": "us", "date": 20401224, "type": [ "Observance", "Christian" ], "primary_type": "Christian", "locations": "All", "states": "All" }, { "uuid": "c413809cf79552589e1effd626d56d48", "name": "Christmas Day", "description": "Christmas Day celebrates Jesus Christ's birth.", "country": "us", "date": 20401225, "type": [ "National holiday", "Christian" ], "primary_type": "Federal Holiday", "locations": "All", "states": "All" }, { "uuid": "c413809cf79552589e1effd626d56d48", "name": "Christmas Day", "description": "Christmas Day celebrates Jesus Christ's birth.", "country": "us", "date": 20401225, "type": [ "Local holiday", "Christian" ], "primary_type": "State Holiday", "locations": "CA, MA, MS, NY", "states": [ "us-ca", "us-ma", "us-ms", "us-ny" ] }, { "uuid": "8909138876b1b82fe6c9af348801221a", "name": "Kwanzaa (first day)", "description": "Kwanzaa is a week-long holiday honoring the culture and traditions of African people and their descendants worldwide, especially in the United States.", "country": "us", "date": 20401226, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" }, { "uuid": "d353ed3dc148af1d39acae04981a1d7f", "name": "International Day of Epidemic Preparedness", "description": "International Day of Epidemic Preparedness is a United Nations observance in the USA", "country": "us", "date": 20401227, "type": [ "United Nations observance" ], "primary_type": "United Nations observance", "locations": "All", "states": "All" }, { "uuid": "087034cd9651bb7e5d432b33812bea58", "name": "New Year's Eve", "description": "New Year's Eve is the last day of the year in the Gregorian calendar. Many parties to welcome the New Year are held in in the United States on New Year's Eve.", "country": "us", "date": 20401231, "type": [ "Observance" ], "primary_type": "Observance", "locations": "All", "states": "All" } ] } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/insight/{label}": { "get": { "summary": "Query Data from iNSight", "deprecated": false, "description": "", "tags": [ "iNSight" ], "parameters": [ { "name": "label", "in": "path", "description": "", "required": true, "example": "core_activecalls", "schema": { "type": "string", "enum": [ "core_activecalls", "core_domains", "node_load5", "node_load5_max", "alerts", "core_subscribers", "core_registered", "nsnode_sockets", "system_packet_dispatched_total", "sip_invite_received_total", "sbus_system_queued", "custom" ] } }, { "name": "range", "in": "query", "description": "The range to use in the query, using this option will avoid the need to calculate start, end and step. \n", "required": false, "example": "last_24_hours", "schema": { "type": "string", "enum": [ "last_hour", "last_6_hours", "last_12_hours", "last_24_hours", "last_7_days", "last_28_days" ] } }, { "name": "aggregated", "in": "query", "description": "Select Eiterh aggregated data or by server. ", "required": false, "example": "aggregated", "schema": { "type": "string", "enum": [ "aggregated", "server" ] } }, { "name": "start", "in": "query", "description": "The timestamp to start the range. Optional and will override range values. ", "required": false, "example": 1757448000, "schema": { "$ref": "#/components/schemas/Start", "type": "integer", "minimum": 0 } }, { "name": "end", "in": "query", "description": "The timestamp to end the range. Optional and will override range values. ", "required": false, "example": 1757534400, "schema": { "type": "integer" } }, { "name": "step", "in": "query", "description": "The interval to use in the query. Optional and will override range values. ", "required": false, "example": "1m", "schema": { "type": "string" } }, { "name": "query", "in": "query", "description": "advanced use only, will override full query if label set to \"custom\" you can use to provide full promQL query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InsightValue" } }, "example": [ { "value": 76.8586956521739, "ts": 1757448540, "debug-parameters": { "query": "avg(((avg(node_load15{job='integrations/node_exporter'}) by (short,instance)) / (count(count(node_cpu_seconds_total{job='integrations/node_exporter'}) by (short,instance,cpu)) by (short,instance))) * 100)", "start": 1757448540, "end": 1757452080, "step": "1m" } }, { "value": 76.97463768115942, "ts": 1757448600 }, { "value": 77.0072463768116, "ts": 1757448660 }, { "value": 77.08695652173913, "ts": 1757448720 } ] } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/conferences": { "get": { "summary": "Get Conferences in Domain", "deprecated": false, "description": "", "tags": [ "Conference/Conferences" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conference" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "post": { "summary": "Create Conference for Domain", "deprecated": false, "description": "", "tags": [ "Conference/Conferences" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conference" }, "example": { "conference": "1234", "name": "My Conference Room", "conference_type": "dedicated", "owner": "1234", "direct_dial": "1234", "leader_pin": "123456", "participants_pin": "654321", "max_participants": 15, "quorum": 2, "leader_required": "yes", "annc_part": "yes", "request_name": "yes" } } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/conferences/{conference}": { "get": { "summary": "Get Conference in Domain", "deprecated": false, "description": "", "tags": [ "Conference/Conferences" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "conference", "in": "path", "description": "", "required": true, "example": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conference" } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "put": { "summary": "Update Conference in Domain", "deprecated": false, "description": "", "tags": [ "Conference/Conferences" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "conference", "in": "path", "description": "", "required": true, "example": "", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conference" }, "example": { "name": "Updated Conference", "direct_dial": "1234", "leader_pin": "987654", "participants_pin": "456789", "max_participants": "-", "quorum": 5, "leader_required": "no", "annc_part": "no", "request_name": "no" } } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "delete": { "summary": "Delete Conference in Domain", "deprecated": false, "description": "", "tags": [ "Conference/Conferences" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "conference", "in": "path", "description": "", "required": true, "example": "", "schema": { "type": "string" } } ], "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/conferences/count": { "get": { "summary": "Count Conferences in Domain", "deprecated": false, "description": "", "tags": [ "Conference/Conferences" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Count" }, "example": { "total": 4 } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 403, "message": "Domain not found or access denied" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 404, "message": "Domain domain does not exist" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/conferences/{conference}/cdr": { "get": { "summary": "Get Conference CDR from Domain", "deprecated": false, "description": "", "tags": [ "Conference/Conferences" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "conference", "in": "path", "description": "", "required": true, "example": "", "schema": { "type": "string" } }, { "name": "from", "in": "query", "description": "", "required": false, "example": "", "schema": { "type": "string" } }, { "name": "to", "in": "query", "description": "", "required": false, "example": "", "schema": { "type": "string" } }, { "name": "include_participants", "in": "query", "description": "", "required": false, "example": "yes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "cdr_conference": { "type": "array", "items": { "type": "object", "properties": { "domain": { "type": "string" }, "conference": { "type": "string" }, "conf_name": { "type": "string" }, "conf_id": { "type": "string" }, "time_begin": { "type": "string" }, "time_end": { "type": "string" }, "duration": { "type": "string" }, "participant_count": { "type": "integer" }, "participants": { "type": "array", "items": { "type": "object", "properties": { "domain": { "type": "string" }, "conference": { "type": "string" }, "conf_id": { "type": "string" }, "participant": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "user": { "type": "string" }, "host": { "type": "string" }, "contact": { "type": "string" }, "call_id": { "type": "string" }, "received_from": { "type": "string" }, "role": { "type": "string" }, "direction": { "type": "string" }, "time_begin": { "type": "string" }, "time_end": { "type": "string" }, "duration": { "type": "string" } }, "required": [ "domain", "conference", "conf_id", "participant", "name", "user", "host", "contact", "call_id", "received_from", "role", "direction", "time_begin", "time_end", "duration" ] } }, "url_session_report": { "type": "string" } }, "required": [ "domain", "conference", "conf_name", "conf_id", "time_begin", "time_end", "duration", "participant_count", "participants", "url_session_report" ] } } }, "required": [ "cdr_conference" ] } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/conferences/{conference}/participants": { "get": { "summary": "Get Participants from Conference", "deprecated": false, "description": "", "tags": [ "Conference/Participants" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "conference", "in": "path", "description": "", "required": true, "example": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConferenceParticipant" } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "post": { "summary": "Create Participant for Conference", "deprecated": false, "description": "", "tags": [ "Conference/Participants" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "conference", "in": "path", "description": "", "required": true, "example": "", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": { "participant": "1234", "name": "John Doe", "call": "no", "keep": "yes", "auto_ans": "no", "auto_con": "1", "auto_dsc": "2", "rcv_only": "no", "leader": "participant", "pin": "" } } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/conferences/{conference}/participants/{participant}": { "put": { "summary": "Update Participant for Conference", "deprecated": false, "description": "", "tags": [ "Conference/Participants" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "conference", "in": "path", "description": "", "required": true, "example": "", "schema": { "type": "string" } }, { "name": "participant", "in": "path", "description": "", "required": true, "example": "", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": { "name": "Jane Doe", "call": "no", "keep": "no", "auto_ans": "yes", "auto_con": "-1", "auto_dsc": "no", "rcv_only": "", "leader": "speaker", "pin": "" } } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "delete": { "summary": "Delete Participant from Conference", "deprecated": false, "description": "", "tags": [ "Conference/Participants" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "conference", "in": "path", "description": "", "required": true, "example": 0, "schema": { "type": "number" } }, { "name": "participant", "in": "path", "description": "", "required": true, "example": 0, "schema": { "type": "number" } } ], "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/phonetemplates": { "get": { "summary": "Read Phone Templates available to a Domain", "deprecated": false, "description": "", "tags": [ "SnapBuilder/Phone Templates" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Phoneconfiguration" } } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "post": { "summary": "Create Phone Template in domain", "deprecated": false, "description": "", "tags": [ "SnapBuilder/Phone Templates" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "phoneconfiguration-name": { "type": "string", "description": "This is the main name for the phone configuration when used as a template" }, "phoneconfiguration-description": { "type": "string", "description": "This is a plain description of the configuration" }, "phoneconfiguration-brand": { "type": "string", "description": "The brand for which this phone configuration will be build for. " }, "phoneconfiguration-model": { "type": "string", "description": "The model specific to brand for which this phone configuration will be build for. " }, "phoneconfiguration-sidecars": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "phoneconfiguration-brand": { "type": "string", "description": "This is the brand for sidecar specifically. It likely will match the parent phoneconfiguration-brand setting. " }, "phoneconfiguration-model": { "type": "string", "description": "This is the model specifically for the sidecar unit, it will be different to the model listed at the root level. " } } }, "description": "List of \"sidecars\" for the phone if in use. Use multiple if multiple side car's in use. " }, "phoneconfiguration-extra": { "type": "object", "properties": { "dynamic": { "type": "string", "description": "dynamic can be set to true if this is being used in dynamic BLF settings. " } }, "description": "This is an \"extra\" object that will be used for easy expansion when needed later. Available optional declerations will be defined below. " }, "phoneconfiguration-directory": { "type": "object", "properties": { "group": { "type": "string", "description": "This is the name of the Directory data set. It could be the like of \"All\", \"Coworkers\" or a specific entry like the name of a Department. ", "default": "All" }, "group-type": { "type": "string", "description": "This is the type of contacts to use, \"Standard\" or \"department\"", "default": "Standard" }, "sort": { "type": "string", "enum": [ "Extension", "First Name", "Last name" ], "default": "Extension", "description": "This is the label to use to sort the directory" }, "order": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc", "description": "This is the sort direction for the directory" }, "exclusions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The uid of the user being excluded from the directory.", "examples": [ "user@domain" ] }, "type": { "type": "string", "description": "The type of contact, most will be \"onnet\"", "default": "onnet" } } }, "description": "List of excluded entries for the domain" } } }, "phoneconfiguration-buttons": { "type": "array", "items": { "properties": { "phoneconfiguration-button-order": { "type": "integer" }, "phoneconfiguration-button-type": { "type": "string" }, "phoneconfiguration-button-feature": { "type": "string" }, "phoneconfiguration-button-target": { "type": [ "integer", "string" ] }, "phoneconfiguration-button-label": { "type": "string" }, "phoneconfiguration-button-locked": { "type": [ "integer", "null" ] }, "phoneconfiguration-extra": { "type": "array", "items": { "type": "string" }, "properties": { "phoneconfiguration-button-label": { "type": "string" }, "targetUser": { "type": "integer" }, "timeframe": { "type": "string" } }, "required": [ "targetUser", "timeframe" ] } }, "required": [ "phoneconfiguration-button-order", "phoneconfiguration-button-type", "phoneconfiguration-button-feature", "phoneconfiguration-button-target", "phoneconfiguration-button-label", "phoneconfiguration-button-locked", "phoneconfiguration-extra" ], "$ref": "#/components/schemas/PhoneConfigBtn" } } }, "required": [ "phoneconfiguration-description", "phoneconfiguration-brand", "phoneconfiguration-model" ] }, "examples": {} } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/phonetemplates/{name}": { "get": { "summary": "Read Specific Phone Templates by name ", "deprecated": false, "description": "", "tags": [ "SnapBuilder/Phone Templates" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "hane_llc", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "name", "in": "path", "description": "", "required": true, "example": "aaker test", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Phoneconfiguration" } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "put": { "summary": "Update Phone Template in domain", "deprecated": false, "description": "", "tags": [ "SnapBuilder/Phone Templates" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "name", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "phoneconfiguration-description": { "type": "string", "description": "This is a plain description of the configuration" }, "phoneconfiguration-sidecars": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "phoneconfiguration-brand": { "type": "string", "description": "This is the brand for sidecar specifically. It likely will match the parent phoneconfiguration-brand setting. " }, "phoneconfiguration-model": { "type": "string", "description": "This is the model specifically for the sidecar unit, it will be different to the model listed at the root level. " } } }, "description": "List of \"sidecars\" for the phone if in use. Use multiple if multiple side car's in use. " }, "phoneconfiguration-extra": { "type": "object", "properties": { "dynamic": { "type": "string", "description": "dynamic can be set to true if this is being used in dynamic BLF settings. " } }, "description": "This is an \"extra\" object that will be used for easy expansion when needed later. Available optional declerations will be defined below. " }, "phoneconfiguration-directory": { "type": "object", "properties": { "group": { "type": "string", "description": "This is the name of the Directory data set. It could be the like of \"All\", \"Coworkers\" or a specific entry like the name of a Department. ", "default": "All" }, "group-type": { "type": "string", "description": "This is the type of contacts to use, \"Standard\" or \"department\"", "default": "Standard" }, "sort": { "type": "string", "enum": [ "Extension", "First Name", "Last name" ], "default": "Extension", "description": "This is the label to use to sort the directory" }, "order": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc", "description": "This is the sort direction for the directory" }, "exclusions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The uid of the user being excluded from the directory.", "examples": [ "user@domain" ] }, "type": { "type": "string", "description": "The type of contact, most will be \"onnet\"", "default": "onnet" } } }, "description": "List of excluded entries for the domain" } } }, "phoneconfiguration-buttons": { "type": "array", "items": { "properties": { "phoneconfiguration-button-order": { "type": "integer" }, "phoneconfiguration-button-type": { "type": "string" }, "phoneconfiguration-button-feature": { "type": "string" }, "phoneconfiguration-button-target": { "type": [ "integer", "string" ] }, "phoneconfiguration-button-label": { "type": "string" }, "phoneconfiguration-button-locked": { "type": [ "integer", "null" ] }, "phoneconfiguration-extra": { "type": "array", "items": { "type": "string" }, "properties": { "phoneconfiguration-button-label": { "type": "string" }, "targetUser": { "type": "integer" }, "timeframe": { "type": "string" } }, "required": [ "targetUser", "timeframe" ] } }, "required": [ "phoneconfiguration-button-order", "phoneconfiguration-button-type", "phoneconfiguration-button-feature", "phoneconfiguration-button-target", "phoneconfiguration-button-label", "phoneconfiguration-button-locked", "phoneconfiguration-extra" ], "$ref": "#/components/schemas/PhoneConfigBtn" } } }, "required": [ "phoneconfiguration-description" ] }, "examples": {} } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "delete": { "summary": "Delete Phone Template in domain", "deprecated": false, "description": "", "tags": [ "SnapBuilder/Phone Templates" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "name", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/phonetemplates/count": { "get": { "summary": "Count Phone Templates for a Domain", "deprecated": false, "description": "", "tags": [ "SnapBuilder/Phone Templates" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Count" }, "example": { "total": 1 } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 403, "message": "Domain not found or access denied" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 404, "message": "Domain domain does not exist" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/deviceprofiles": { "get": { "summary": "Read Device Profiles", "deprecated": false, "description": "", "tags": [ "SnapBuilder" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "device-models-brand": { "type": "string", "description": "The brand for the profile" }, "device-models-model": { "type": "string", "description": "The model for the profile" }, "device-models-type": { "type": "string", "description": "The type for the profile, in most cases \"phone\" is set. " }, "image": { "$ref": "#/components/schemas/DeviceImage" } }, "required": [ "device-models-brand", "device-models-model", "device-models-type", "image" ] } } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/deviceprofiles/count": { "get": { "summary": "Count Device Profiles", "deprecated": false, "description": "", "tags": [ "SnapBuilder" ], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Count" }, "example": { "total": 229 } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/deviceprofiles/{make}/{model}": { "get": { "summary": "Get specific Device Profile for Model of Phone", "deprecated": false, "description": "", "tags": [ "SnapBuilder" ], "parameters": [ { "name": "make", "in": "path", "description": "", "required": true, "example": "Cisco", "schema": { "type": "string" } }, { "name": "model", "in": "path", "description": "", "required": true, "example": "8851", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceProfile" } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/phoneconfiguration/count": { "get": { "summary": "Count Phone Configurations in a Domain", "deprecated": false, "description": "", "tags": [ "SnapBuilder" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Count" }, "example": { "total": 4 } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 403, "message": "Domain not found or access denied" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 404, "message": "Domain domain does not exist" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/phoneconfiguration/{mac}": { "get": { "summary": "Get Phone Configuration for specific Mac", "deprecated": false, "description": "", "tags": [ "SnapBuilder" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "mac", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Phoneconfiguration" } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "put": { "summary": "Update Phone Configuration for Specific Mac Address", "deprecated": false, "description": "", "tags": [ "SnapBuilder" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "mac", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "phoneconfiguration-description": { "type": "string", "description": "This is a plain description of the configuration" }, "phoneconfiguration-brand": { "type": "string", "description": "The brand for which this phone configuration will be build for. " }, "phoneconfiguration-model": { "type": "string", "description": "The model specific to brand for which this phone configuration will be build for. " }, "phoneconfiguration-domain": { "type": "string", "description": "The domain owning this phone configuration" }, "phoneconfiguration-sidecars": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "phoneconfiguration-brand": { "type": "string", "description": "This is the brand for sidecar specifically. It likely will match the parent phoneconfiguration-brand setting. " }, "phoneconfiguration-model": { "type": "string", "description": "This is the model specifically for the sidecar unit, it will be different to the model listed at the root level. " } } }, "description": "List of \"sidecars\" for the phone if in use. Use multiple if multiple side car's in use. " }, "phoneconfiguration-extra": { "type": "object", "properties": { "dynamic": { "type": "string", "description": "dynamic can be set to true if this is being used in dynamic BLF settings. " } }, "description": "This is an \"extra\" object that will be used for easy expansion when needed later. Available optional declerations will be defined below. " }, "phoneconfiguration-directory": { "type": "object", "properties": { "group": { "type": "string", "description": "This is the name of the Directory data set. It could be the like of \"All\", \"Coworkers\" or a specific entry like the name of a Department. ", "default": "All" }, "group-type": { "type": "string", "description": "This is the type of contacts to use, \"Standard\" or \"department\"", "default": "Standard" }, "sort": { "type": "string", "enum": [ "Extension", "First Name", "Last name" ], "default": "Extension", "description": "This is the label to use to sort the directory" }, "order": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc", "description": "This is the sort direction for the directory" }, "exclusions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The uid of the user being excluded from the directory.", "examples": [ "user@domain" ] }, "type": { "type": "string", "description": "The type of contact, most will be \"onnet\"", "default": "onnet" } } }, "description": "List of excluded entries for the domain" } } }, "phoneconfiguration-buttons": { "type": "array", "items": { "properties": { "phoneconfiguration-button-order": { "type": "integer" }, "phoneconfiguration-button-type": { "type": "string" }, "phoneconfiguration-button-feature": { "type": "string" }, "phoneconfiguration-button-target": { "type": [ "integer", "string" ] }, "phoneconfiguration-button-label": { "type": "string" }, "phoneconfiguration-button-locked": { "type": [ "integer", "null" ] }, "phoneconfiguration-extra": { "type": "array", "items": { "type": "string" }, "properties": { "phoneconfiguration-button-label": { "type": "string" }, "targetUser": { "type": "integer" }, "timeframe": { "type": "string" } }, "required": [ "targetUser", "timeframe" ] } }, "required": [ "phoneconfiguration-button-order", "phoneconfiguration-button-type", "phoneconfiguration-button-feature", "phoneconfiguration-button-target", "phoneconfiguration-button-label", "phoneconfiguration-button-locked", "phoneconfiguration-extra" ], "$ref": "#/components/schemas/PhoneConfigBtn" } } }, "required": [ "phoneconfiguration-description", "phoneconfiguration-brand", "phoneconfiguration-model", "phoneconfiguration-domain" ] }, "examples": {} } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] }, "delete": { "summary": "Delete Phone Configuration for Specific Mac Address", "deprecated": false, "description": "", "tags": [ "SnapBuilder" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "mac", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/phoneconfiguration": { "post": { "summary": "Create Phone Configuration for Specific Mac Address", "deprecated": false, "description": "", "tags": [ "SnapBuilder" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "phoneconfiguration-mac-address": { "type": "string", "description": "When phone configuration is applied to a specific phone (not template) this will be a valid mac\n" }, "phoneconfiguration-description": { "type": "string", "description": "This is a plain description of the configuration" }, "phoneconfiguration-brand": { "type": "string", "description": "The brand for which this phone configuration will be build for. " }, "phoneconfiguration-model": { "type": "string", "description": "The model specific to brand for which this phone configuration will be build for. " }, "phoneconfiguration-domain": { "type": "string", "description": "The domain owning this phone configuration" }, "phoneconfiguration-sidecars": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "phoneconfiguration-brand": { "type": "string", "description": "This is the brand for sidecar specifically. It likely will match the parent phoneconfiguration-brand setting. " }, "phoneconfiguration-model": { "type": "string", "description": "This is the model specifically for the sidecar unit, it will be different to the model listed at the root level. " } } }, "description": "List of \"sidecars\" for the phone if in use. Use multiple if multiple side car's in use. " }, "phoneconfiguration-extra": { "type": "object", "properties": { "dynamic": { "type": "string", "description": "dynamic can be set to true if this is being used in dynamic BLF settings. " } }, "description": "This is an \"extra\" object that will be used for easy expansion when needed later. Available optional declerations will be defined below. " }, "phoneconfiguration-directory": { "type": "object", "properties": { "group": { "type": "string", "description": "This is the name of the Directory data set. It could be the like of \"All\", \"Coworkers\" or a specific entry like the name of a Department. ", "default": "All" }, "group-type": { "type": "string", "description": "This is the type of contacts to use, \"Standard\" or \"department\"", "default": "Standard" }, "sort": { "type": "string", "enum": [ "Extension", "First Name", "Last name" ], "default": "Extension", "description": "This is the label to use to sort the directory" }, "order": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc", "description": "This is the sort direction for the directory" }, "exclusions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The uid of the user being excluded from the directory.", "examples": [ "user@domain" ] }, "type": { "type": "string", "description": "The type of contact, most will be \"onnet\"", "default": "onnet" } } }, "description": "List of excluded entries for the domain" } } }, "phoneconfiguration-buttons": { "type": "array", "items": { "properties": { "phoneconfiguration-button-order": { "type": "integer" }, "phoneconfiguration-button-type": { "type": "string" }, "phoneconfiguration-button-feature": { "type": "string" }, "phoneconfiguration-button-target": { "type": [ "integer", "string" ] }, "phoneconfiguration-button-label": { "type": "string" }, "phoneconfiguration-button-locked": { "type": [ "integer", "null" ] }, "phoneconfiguration-extra": { "type": "array", "items": { "type": "string" }, "properties": { "phoneconfiguration-button-label": { "type": "string" }, "targetUser": { "type": "integer" }, "timeframe": { "type": "string" } }, "required": [ "targetUser", "timeframe" ] } }, "required": [ "phoneconfiguration-button-order", "phoneconfiguration-button-type", "phoneconfiguration-button-feature", "phoneconfiguration-button-target", "phoneconfiguration-button-label", "phoneconfiguration-button-locked", "phoneconfiguration-extra" ], "$ref": "#/components/schemas/PhoneConfigBtn" } } }, "required": [ "phoneconfiguration-description", "phoneconfiguration-brand", "phoneconfiguration-model", "phoneconfiguration-domain" ] }, "examples": {} } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/charts/{dashboard_id}/count": { "get": { "summary": "Count Charts", "deprecated": false, "description": "", "tags": [ "Charts" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "dashboard_id", "in": "path", "description": "", "required": true, "example": "{{dashboard_id}}", "schema": { "type": "number" } }, { "name": "type", "in": "query", "description": "", "required": false, "example": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Count" }, "example": { "total": 8 } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "4": { "summary": "Permission Denied", "description": "", "value": { "code": 403, "message": "Permission Denied" } }, "5": { "summary": "Forbidden", "description": "", "value": { "code": 403, "message": "Domain not found or access denied" } } } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "2": { "summary": "Record Not Found", "description": "", "value": { "code": 404, "message": "Domain domain does not exist" } }, "3": { "summary": "Board not found", "description": "", "value": { "code": 404, "message": "Board not found" } } } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/charts/{dashboard_id}/list": { "get": { "summary": "Get Chart List", "deprecated": false, "description": "", "tags": [ "Charts" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "dashboard_id", "in": "path", "description": "", "required": true, "example": "{{dashboard_id}}", "schema": { "type": "number" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Chart" } }, "example": [ { "id": 63, "name": "Abandoned Calls Aggregate", "type": "ResponsiveLine", "data_token": { "access_token": "c67fe7533d74a1e61765014c0e2e7bf8", "expires_in": 86400, "scope": "Call Center Data", "mask_chain": null, "token_type": "Bearer", "refresh_token": "de4de5765a2375754109b456b033ba51" } }, { "id": 53, "name": "Active Calls", "type": "ResponsiveStat", "data_token": { "access_token": "c67fe7533d74a1e61765014c0e2e7bf8", "expires_in": 86400, "scope": "Call Center Data", "mask_chain": null, "token_type": "Bearer", "refresh_token": "de4de5765a2375754109b456b033ba51" } }, { "id": 58, "name": "Agents", "type": "ResponsiveTable", "data_token": { "access_token": "c67fe7533d74a1e61765014c0e2e7bf8", "expires_in": 86400, "scope": "Call Center Data", "mask_chain": null, "token_type": "Bearer", "refresh_token": "de4de5765a2375754109b456b033ba51" } } ] } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "4": { "summary": "Permission Denied", "description": "", "value": { "code": 403, "message": "Permission Denied" } }, "5": { "summary": "Forbidden", "description": "", "value": { "code": 403, "message": "Domain not found or access denied" } } } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "2": { "summary": "Invalid Domain", "description": "", "value": { "code": 404, "message": "Domain domain does not exist" } }, "3": { "summary": "Invalid Board", "description": "", "value": { "code": 404, "message": "Board not found" } } } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/dashboards/count": { "get": { "summary": "Count Dashboards for a User", "deprecated": false, "description": "", "tags": [ "Dashboards" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "owner_id", "in": "query", "description": "", "required": false, "example": 0, "schema": { "type": "number" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Count" }, "example": { "total": 2 } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 403, "message": "Domain not found or access denied" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "2": { "summary": "Record Not Found", "description": "", "value": { "code": 404, "message": "Domain domain does not exist" } }, "3": { "summary": "User not found", "description": "", "value": { "code": 404, "message": "User not found or access denied" } } } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/dashboards/list": { "get": { "summary": "Get Dashboard List for a User", "deprecated": false, "description": "", "tags": [ "Dashboards" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "owner_id", "in": "query", "description": "", "required": false, "example": 0, "schema": { "type": "number" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Dashboard" } }, "examples": { "1": { "summary": "Success", "description": "", "value": [ { "id": 5, "name": "Board Number One", "domain": "example", "favorite": false, "owner_id": "1001", "owner_type": 1 }, { "id": 10, "name": "New Board", "domain": "example", "favorite": false, "owner_id": "1002", "owner_type": 1 } ] }, "2": { "summary": "Forbidden", "description": "", "value": { "code": 403, "message": "Domain not found or access denied" } } } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "3": { "summary": "Domain not found", "description": "", "value": { "code": 404, "message": "Domain example does not exist" } }, "4": { "summary": "User not found", "description": "", "value": { "code": 404, "message": "User not found or access denied" } } } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/quotas": { "get": { "summary": "Get Quota for Domain", "deprecated": false, "description": "", "tags": [ "Quotas" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "domain": { "type": "string" }, "countLimit": { "type": "string" }, "sizeLimit": { "type": "string" }, "timeLimit": { "type": "string" }, "ageLimit": { "type": "string" } } } } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/quotas/count": { "get": { "summary": "Count Quotas for Domain", "deprecated": false, "description": "", "tags": [ "Quotas" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Count" }, "example": { "total": 1 } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 403, "message": "Domain not found or access denied" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 404, "message": "Domain domain does not exist" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/departments/list": { "get": { "summary": "List Departments in a Domain", "deprecated": false, "description": "", "tags": [ "Departments" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "department 1" ] } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 403, "message": "Domain not found or access denied" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 404, "message": "Domain example does not exist" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/presence/list": { "get": { "summary": "List Presence in a Domain", "deprecated": false, "description": "", "tags": [ "Presence" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "last_update", "in": "query", "description": "", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Records per page. Defaults to 100, maximum 100. Higher values, or more than one `limit` parameter, are rejected with 400. Page through results with `start`.", "required": false, "schema": { "$ref": "#/components/schemas/Limit", "type": "integer", "minimum": 1, "maximum": 100, "default": 100 }, "example": 100 }, { "name": "order", "in": "query", "description": "", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Presence" } }, "example": [ { "user": "1003", "uid": "1003@example", "domain": "example", "site": "", "email": "another@test.com", "name-first-name": "Another", "name-last-name": "Test", "department": "", "user-presence-status": "open", "status-message": "" }, { "user": "1001", "uid": "1001@example", "domain": "example", "site": "", "email": "jexample@crexendo.com", "name-first-name": "Super", "name-last-name": "User", "department": "", "user-presence-status": "open", "status-message": "" }, { "user": "1002", "uid": "1002@example", "domain": "example", "site": "site 1", "email": "test@user.com", "name-first-name": "Test", "name-last-name": "User", "department": "department 1", "user-presence-status": "open", "status-message": "" }, { "user": "1004", "uid": "1004@example", "domain": "example", "site": "", "email": "CCS@user.com", "name-first-name": "CCS", "name-last-name": "User", "department": "", "user-presence-status": "inactive", "status-message": "" }, { "user": "1014", "uid": "1014@example", "domain": "example", "site": "", "email": "CCA@user.com", "name-first-name": "CCA", "name-last-name": "User", "department": "", "user-presence-status": "inactive", "status-message": "" }, { "user": "1111", "uid": "1111@example", "domain": "example", "site": "", "email": "reseller@user.com", "name-first-name": "Reseller", "name-last-name": "User", "department": "", "user-presence-status": "inactive" } ] } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 403, "message": "Domain not found or access denied" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 404, "message": "Domain example does not exist" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/departments/{department}/presence/list": { "get": { "summary": "List Presence in a Department", "deprecated": false, "description": "", "tags": [ "Presence" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "department", "in": "path", "description": "", "required": true, "example": "{{department}}", "schema": { "type": "string" } }, { "name": "last_update", "in": "query", "description": "", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Records per page. Defaults to 100, maximum 100. Higher values, or more than one `limit` parameter, are rejected with 400. Page through results with `start`.", "required": false, "schema": { "$ref": "#/components/schemas/Limit", "type": "integer", "minimum": 1, "maximum": 100, "default": 100 }, "example": 100 }, { "name": "order", "in": "query", "description": "", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Presence" } }, "example": [ { "user": "1002", "uid": "1002@example", "domain": "example", "site": "site 1", "email": "test@user.com", "name-first-name": "Test", "name-last-name": "User", "department": "department 1", "user-presence-status": "open", "status-message": "" } ] } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": {} }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 403, "message": "Domain not found or access denied" } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "2": { "summary": "Domain Not Found", "description": "", "value": { "code": 404, "message": "Domain domain does not exist" } }, "3": { "summary": "Department Not Found", "description": "", "value": { "code": 404, "message": "Department department does not exist" } } } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/auditlog": { "get": { "summary": "Read Audit Log", "deprecated": false, "description": "", "tags": [ "Audit Log" ], "parameters": [ { "name": "datetime-start", "in": "query", "description": "", "required": false, "example": "2025-09-01T20:00:53+00:00", "schema": { "$ref": "#/components/schemas/DatetimeStart" } }, { "name": "datetime-end", "in": "query", "description": "", "required": false, "example": "2025-09-02T20:00:53+00:00", "schema": { "$ref": "#/components/schemas/DatetimeEnd" } }, { "name": "by-ip", "in": "query", "description": "", "required": false, "example": "1.1.1.1", "schema": { "type": "string" } }, { "name": "action-type", "in": "query", "description": "", "required": false, "example": "create", "schema": { "type": "string" } }, { "name": "target-domain", "in": "query", "description": "", "required": false, "schema": { "type": "string" } }, { "name": "target-object", "in": "query", "description": "", "required": false, "schema": { "type": "string" } }, { "name": "target-host", "in": "query", "description": "", "required": false, "schema": { "type": "string" } }, { "name": "target-user", "in": "query", "description": "", "required": false, "schema": { "type": "string" } }, { "name": "by-client", "in": "query", "description": "", "required": false, "schema": { "type": "string" } }, { "name": "by-domain", "in": "query", "description": "", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Auditlog" } } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/accesslog": { "get": { "summary": "Read Accesslog", "deprecated": false, "description": "", "tags": [ "Access Log" ], "parameters": [ { "name": "datetime-start", "in": "query", "description": "", "required": false, "example": "2025-09-01T20:00:53+00:00", "schema": { "$ref": "#/components/schemas/DatetimeStart" } }, { "name": "datetime-end", "in": "query", "description": "", "required": false, "example": "2025-09-02T20:00:53+00:00", "schema": { "$ref": "#/components/schemas/DatetimeEnd" } }, { "name": "by-ip", "in": "query", "description": "", "required": false, "example": "1.1.1.1", "schema": { "type": "string" } }, { "name": "action-type", "in": "query", "description": "", "required": false, "example": "login", "schema": { "type": "string" } }, { "name": "target-domain", "in": "query", "description": "", "required": false, "schema": { "type": "string" } }, { "name": "target-object", "in": "query", "description": "", "required": false, "example": "", "schema": { "type": "string" } }, { "name": "target-host", "in": "query", "description": "", "required": false, "schema": { "type": "string" } }, { "name": "target-user", "in": "query", "description": "", "required": false, "schema": { "type": "string" } }, { "name": "by-client", "in": "query", "description": "", "required": false, "schema": { "type": "string" } }, { "name": "by-domain", "in": "query", "description": "", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Auditlog" } } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } }, "/domains/{domain}/users/{user}/moh/{index}/": { "put": { "summary": "Update MOH for User from Upload (JSON + Base64 File)", "deprecated": false, "description": "", "operationId": "UpdateMohUserBase64", "tags": [ "Media/Music on Hold/User" ], "parameters": [ { "name": "domain", "in": "path", "description": "", "required": true, "example": "{{domain}}", "schema": { "$ref": "#/components/schemas/DomainNamePath" } }, { "name": "user", "in": "path", "description": "", "required": true, "example": "{{user}}", "schema": { "$ref": "#/components/schemas/UserNamePath" } }, { "name": "index", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "synchronous": { "$ref": "#/components/schemas/Synchronous" }, "script": { "type": "string", "description": "This is a simple explanation of what the audio is and can include what is said in the audio file for explanation. " }, "convert": { "type": "string", "enum": [ "yes", "no" ], "default": "no", "description": "Setting yes will allow the API to attempt to convert the file from accepted formats into the correct format for media playback" }, "encoding": { "type": "string", "description": "Used when providing base64 encoded data to give the content tupe of the file. ", "examples": [ "audio/wav", "audio/mp3" ] }, "base64_file": { "type": "string", "description": "This is a base64 encoded string formated without line breaks or spaces. " } }, "required": [ "synchronous", "script" ] }, "example": { "index": "4", "script": "base64 encoded in JSON", "convert": "yes", "encoding": "audio/wav", "base64_file": "UklGRpw7AABXQVZFZm10IBIAAAAHAAEAQB8AAEAfAAABAAgAAABmYWN0BAAAAGk7AABkYXRhaTsAAP/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////+/v7+////fn5+fv////7+/v7/////fn5+fv////7+/v7//35+fn5+///+/v3+/v//fn5+fv////7+/v7/////fn5+fv////7+/v7///9+fn5+fv///v7+/v///35+fn7////+/v7+////fn5+fv////7+/v7/////fn5+fv////7+/v7///9+fn5+///+/v7+/v//fn5+fn7///7+/v7/////fn5+fv/////+/v7/////fn5+fv///v7+/v7//35+fn7////+/v7+////fn5+fv/////+/v7/////fn5+fv////7+/v7///9+fn5+/////v7+/v///35+fn7////+/v7/////fn5+///////+/v7/////fn5+fv////7+/v7//35+fn7////+/v7+////fn5+fv/////+/v7/////fn5+fv////7+/v7///9+fn5+/////v7+/v///35+fn7////+/v7//////35+///////+/v7/////fn5+fv////7+/v7///9+fn7////+/v7+/////35+fv/////+/v7//////35+///////+/v7///9+fn5+/////v7+/v///35+fn7////+/v7//////35+///////+/v7/////fn5+//////7+/v7///9+fn5+/////v7+/////35+fv/////+/v7//////35+///////+/v7/////fn5+/////v7+/v///35+fn7////+/v7//////35+/////////v///////35+//////7+/v7///9+fn5+/////v7+/////35+fv///////v/////////////////+/v7/////fn5+//////7+/v////9+fn7//////v7//////35+/////////////////35+///////+/v7///9+fn5+/////v7+/////35+fv///////v///////////////////v//////fn5+//////7+/v////9+fn7//////v7////////////////////////////////////+/v//////fn5+/////v7+//////9+fv///////////////////////////////////35+//////7+/v////9+fn7//////v7///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////+Sk5y+JhYRFia+nJOTm7wnFxIWJcKck5ObuigXEhYkxp2Tk5u4KhgSFiPLnpSTm7UrGBIWI9CelJOasywZEhUi2Z+Vk5qxLRkTFSHln5WTmq8uGhMVIP+glZOarjAaExUfZqGWk5muMhsTFR9ao5aTma00GxQVH1Gkl5OZrDccFBUeTKWXlJmrORwUFR5IppeUmao7HRUVHkSnmJSZqT0dFRUeQKiYlJioQB4VFR0+qZmUmKdEHhYVHTyqmZSYp0kfFhUdOqyalZimTR8WFRw4rZqVmKVTIBcVHDaum5WYpFshFxUcNK+blZikZyIXFhwysJyWmKP/IxgWHDGynJaYouckGBYbL7Wclpii2yUZFhsut52WmKHUJhkWGy25nZeYoc4nGRYbLbuel5igyigaFhssvZ6XmJ/GKRoWGyu/n5eYn8IqGhcaKsOfmJifvysbFxoqx6CYmJ+9LBsXGinKoZiYnrwtHBcaKM6imZieui4cFxoo1aOZmJ64Lx0YGifdpJmYnrcxHRgaJumlmpietTMdGBom/6aamJ2zNR4YGiVpp5qYnbI3HhgaJF2om5idsDkfGRokVqmbmJ2vOx8ZGiNPqZuYna49HxkaI0yqnJmdrj8gGRoiSKucmZ2tQSEaGiJFrJyZnKxFIhoaIUKtnZmcrEkjGhohP66dmZyrTCQaGiE9r56ZnKpQJRsaIDywnpqcqlclGxogOrKempypXiYbGh85tJ+anKlqJxwaHze2n5qcqP8oHBofNrefmpyo6ikcGh80uaCbnKfeKh0aHzO7oZucptgrHRsfMr2im5ym0isdGx8wvqKbnKbNLB4bHi/Bo5ucpcotHhseL8SknJylxy4eGx4ux6WcnKTELx8bHi3LppycpMEwHxseLc6mnJyjvzIfGx4s06ednKO+MyAcHizZqJ2co7w1IBweK9+pnZyiuzYhHB4r66menKK6OCIcHir/qp6corg6IhweKmurnpyhtzsjHR4pYKyenKG2PSQdHilarZ+cobQ+JB0eKFStn52hs0AlHR4oT66fnaGyQyYdHihMr6CdoLFGJx4eJ0mwoJ2gsEknHh4nR7GhnaCvTCgeHiZEs6GdoK9PKR4eJkG0op2grlUpHh4mP7ajnaCuWyofHiU+t6Oen61hKx8eJT25pJ6frWwsHx4lO7qknp+s/ywfHiU6vKWen6ztLSAeJDm9pp6fq+IuIB4kOL+mnp+r2y4hHiQ3wKefn6vWLyEeJDbDqJ+fqtEwIh4jNcaon5+qzjEjHyM0yamfn6nLMyMfIzPLqp+fqck0JB8jMs6qoJ+pxjUkHyMx0qugn6jENyUfIzDXq6GfqMI4JR8jL9ysoZ+owDkmHyIv462hoKi+OyYfIi7uraKgp708JyAiLv+uoqCnvD0oICIubq+joKe7PyggIi1kr6Ogp7pBKSEiLV2wpKCmuUMpISIsWLKkoKa4RiohIixUs6WhprdIKiIiLE+0paGmtksrIiIrTbWmoaa1TSwiIitLt6ahprVQLCMiK0m4p6GltFQtIyIrR7mnoqWzWS0jIipEuqiipbJeLiQiKkK7qKKlsWUuJCMqQL2poqWwbi8lIyo/vqmjpbD/LyQhJznFqqGhqcE9KSMmL1e6rauxyEs3NDxwvbCvvFwxJiMpPbqjm5uguDQdFhYcLrmdlZSZqE0iGRYaJUyvoZ2fqLliOjIxNDc4ODg8UMWtop2epsMuHBQSGCfAnJCNj5vBIhINDRQotpqQjpOewisbFhccKEe7qaKgoKSptek0IxsXGB40spqQjY+avyEPCgoPH7uWi4mLlLIkEQsLDx1joJSPkJekzS4fGhgZHShFtaCYk5OYpkwdDwsLECK1lIqHiZGuIA0HBgsZ5piMiImPojkZDgwOFifPopiTkpadrkciFxAPEhw7ppOLiYyWux0MBgUKGMyUiISFjaEqDwgGCRIvpZGLio2Yry8aEQ8PFiBFq5mPjY6UpD4ZDQgIDh62koiEhY2lIwwEAgYROpqKhYWKmW4ZDAkJDhxToZOOjY+Yqj8dEQ0MDxo7o5CJh4qTsx4MBAMHE1GWiIKCiZo3EAcDBQ0iq5GJh4qRpjYZDgwMER0/qJaOi4ySoj0YDAcHDBy9k4eDhIueKg0EAQQNKp6LhIKHkrwcDAcHCxc7o5KMi42Vpz8cDwwLDhg4o4+JhomQrSAMBQIGDziZiIKBh5VWEwcCAwoct5KJhoiOnz8ZDgoLDxo7p5WNi4yRoUEYDAcHDBrPlYiDg4qaNQ8FAAMLIaWMhIKGj60fDQcFCRMvppKLioyTpEQcDwsLDRg1ppGJh4mPqCYOBgMGDiydioKBhpHDFwgCAwkYz5WJhYaMm1gaDgoKDhk3qZWNi4yRn0oaDQgHDBhfmIqEhImXSxIHAQIKHK6OhYKFjaUmDgcFCBApqpOLiYuRoUwdDwsLDhcxqZOLiImPpCwQBwQGDSWjjISBhY+wGwoDAggUTZmLhoaLmdUcDgoKDRgzq5aNi4yRn1gcDgkIDBdEnIyGhImV1RcJAwMJGb6Rh4OEjJ8uEAgFCA8kr5WMiYuQn1oeEQwLDhgvrJWMiYqPojQTCQUGDSCsj4aDhY6oIQwFAwcRN52Mh4aLl74fDwoKDRcvrZeOjI2Sn3keDwsJDBc5n46IhomUuxsLBQQJFv+WiYSFi5w7FAkGCA4gupeNiouQnvcfEg0MDhgur5eNiouQnz4XCwcHDR24k4iEho2iKQ4HBAcPLaKOiIeKlbQjEQsKDRYtsJmPjI2Sn90hEgwLDRczppCKh4qTsCANBwUJFD+bi4WFi5laGAsHCA4dyZqOiouQndUiFA4NDxgttJqPjIyRn1AbDQkJDRzMl4uGh42eNBIJBQcPJqmQiYeKk60pEwwLDRYqtpuQjY6Tn88kFQ4MDhcuq5SMiYuSqygQCQYJEzKfjYeGi5fLHA0ICA0cfJ2Pi4yPncglFg8OEBksupyRjY2Sn/MeDwsKDhtfm42IiI2cRxcLBwgOIbKUi4iKkqkuFg0LDRUovJySjo+Un8koFw8NDxgtsZiNi4ySpy8UCwgKEiunkImHi5W5Hw8KCQ0aSZ+RjIyPnL8oFw8OERksvp6Tjo6TntAiEwwLDhpDn4+KiY2a5hsNCAkOHsCYjImLkaU4GQ4MDRUmxZ6Uj4+Vn8QrGREPEBkruZuPjI2TpDsYDQoLESaulIuJi5SuJxELCg0YO6WTjY2Qm7ksGREPEhorxaCWkI+Un8YnFg4NDxo5ppOMio2Zwh8PCgoOHOebjoqLkaFFGw8NDhUk0qCVkJCWn78tGxMQEhkqwJ6Sjo6UokscDwsMESO7mI2KjJOqLRUMCw0XMqqWjo2Qm7QvGxMQExorzKOYkpGWn78rGRAOEBoyrJaOjI6YtiYSDAsOG0qfkIyMkJ9lHhIODhUi+6SXkZGWn70wHRUSFBoqy6GVj4+VoXYfEg0NEiDOnI+LjJOlOBkODA4WLa+Zj46Qmq81HRQRFBsq1qaalJOXn7wvHBMPEhous5qPjY+YrywWDQwOGTulk42MkJ3PIhQPDxQhVaeZk5KXn7s0HhcUFRsq2aWYkpGWoNElFg8OEh9in5KNjZOiSBwQDQ4WKbmbkY+Rmq08HhYTFBsq5qiblpWYoLo1HhYSFBstvJ2Tj4+YqzUaDw0PGTKsl46NkJy/KBcQDxUfRqublJOXn7k4IBkWFxwq8amblZOXoMUqGREPEx5HppWOjpOf/x8TDg4VJseelI+RmatFIRgUFRspcaudmJaaobk6IBgUFRsrx6CWkJGYqUAdEg4PGC2zmpCOkZu3LRkSEBUePa6clpSYn7c8IxoXGB0qaKydl5WYob4vHBQRFB08q5mQj5OeyyUWDw8VI+WilpGSmahVJBkVFhsoXK2emZiborg+JBoXFxwr2KWZk5OZp1QhFRARGCq+nZOPkpqwNBwUERUeOLOel5WYn7VAJRwZGR4rWq6fmZeaobo1HhcTFh02spyTkJSevSsZERAVIVOnmJOTmab3KBsWFxsoT6+fmpmco7dDJxwZGR0qfqmblpWZpuomGBISGCfPoZaRkpqsPR4WExUdM7qgmZaZn7JHKB0aGh4rU7Ghm5mborg8IhkWFx4xup+WkpWdtjEcFBIWH0Ksm5SUmaXRKx0YFxwnSbOinJqcpLZJKh4aGh4qW62emJeapc4rGxUUGSVtppiTlJqqTCIYFBYdL8KjmpeZn7BPKh4bGx8rTrWknZuco7ZDJhsYGR4vxaOZlZadsDoeFhMWHzqxnZaVmaPFLx4ZGBwmQ7eknZudpbZOLCAcHB8rT7GgmpibpcMwHhcVGSRNq5uVlZqobicaFhcdLc+nnJian69dLB8cHCArS7mmnpydpLVLKR4aGh4u1Kebl5edrkUjGRUXHjS5n5iWmaK9NSAaGRwmPrumnpyepbZWLiIdHSArS7eknJqcpb03IRoXGiNAsJ6Xlpqm1CscFxccK+2qnZqan61+LiEdHSAsSLypn52fprVVLB8cGx8t+aydmZmdrFknGxcYHi/Co5qXmqG4PCQcGhwlO7+on52eprVeMCQfHiIsR7unnpydpbo+JRwZGyM7uKCZl5ukxS8eGRgcKVqun5ubn6zdMSQeHiEsRr6rop+gp7VhLyMdHSAsXK+gm5qeq+ssHRkZHi3SqJyZmqC0RCcdGx0lOMeroJ6fprRtMycgHyMsRb+qoJ2eprhHKR4bHCM3v6WcmZukvTchGxkdKEqyoZycn6vPNiYfHiIsQ8KspKChqLV2MyYfHiIsT7WknZueqtAwHxsaHiz/rJ6am6CwUCoeHB0kNs+top+fprT2NigiISUtQ8Sso5+gp7dRLCAcHSM0y6mem5yjuD4lHBodJ0G4pZ2cn6vJOiggHyMsQceupqKjqbXuNyghHyMtSbunn52fqcc3IxwbHipVr6Ccm6CubC0gHR0kM96vpJ+gp7PkOSokIyYtQsmvpqGiqLZgLyQeHiQx3a2fnJ2jtUkpHhwdJjy+qJ+dn6rCPioiICMsP8yvp6OkqrbjOiskIiUtRb+qoZ6gqcA9Jx4cHylItqSdnKCt3TEjHh4kMXqzpqGhp7LaOywmJCcuQc6xqKOkqbb+NCcgHyQwcLCjnp6jsVotIB0eJTjIq6CeoKm+RSwkISQrPdGyqaWmq7bcPS0mJCYuQsetpKCiqr1FKyAeHylAvKefnaCszTcmHx8kL1y3qKKip7HTPi0nJSgvQNO0qqamqrbkOSojISUvWLann5+kr/MwIx4eJTXWrqOfoKm7TS4mIiQrPNq1qqanq7bYPy8oJiguQM2wp6KjqrtPLiQfICk8xauhnqGrxTwpIR8kLk+7qqSjp7HOQS8pJykvQNm3rKinq7baPSwlIycvTryqoqCkrtc2Jx8fJTL0saWgoai4WjEnIyUrO+W4rKiorLfVQzEqKCkvP9W0qqWlq7ldMichIik6z66kn6Kqv0QsIyAkLUi/rKakqLDKRjAqKCovP9+6rqmprLbVQC4oJSgvScGtpaKlrsw8KiIgJTBdt6iioqi2czUpJSYrOf+6ramprLfSRzMsKSswP964rKenq7h7NykkJCk34bKnoaOqvE0uJSIlLULHrqelqK/GSzMrKSowP+i8r6uqrbfRRjEqKCkvRcmvp6SmrsZCLCUiJi9PvKuko6i04jkrJiYrOGa9rqqqrbfPSjYtKywxP+q7rqmprLjkOywmJSo2cLeppKSquVwyKCQlLD7OsammqK/DUDYsKiswP/O+saysrrjPSjUsKSswQtC0qqanrsFLLyckJy5Iwa2mpKiy1D0tKCcrN1q/sKuqrbfOTTguLC0yP/q+sKuqrbjZPy4pJyo1W7yspqWqt/83KiUmLDzbtaunqa+/WjguKywxPnq/s66tr7nNTjguKywxQdu4rKiprr5VNComJy5Dyq+opqmxzEMvKSgrNlLFsqyrrrfMUDowLS40P3TBs62srrjTRTIrKSs0UMGuqKeqtd48LCcnLDryuaypqa++ZzsvLCwxPmzDta+usLnNUzswLS0yQOm7rqqqrr1mOCwoKC4/07Sqp6mwx0oyKyksNU3Kta2srrfKVjwyLi81P2vFtq+tr7nPSzYtKiw0S8iyqqirtNJALykoLDhmva6qqq68/D4wLS0xPWPGt7CvsbrMWD0zLi40P/+/saysr7z2PC4qKi4947isqaqvwlI2LCosNEnPuK6trrfJWz00LzA2QGXIuLGvsbnNUDkvLC00SM+2rKqstMxIMispLDdXwbCrq6675EEzLi0yPV3JubKvs7vMXD81MDA1P2zDta6tsLvgQDErKy47eLyuqquvv145LissM0bXurCtr7fHYj81MTE3QGDLu7Ows7rMWDwxLi41Rtm6rquss8dONi0qLTZPyLStrK+62kY1Ly4yPFjMu7OxtLvLYUE3MjI2QGPIuK+usbvYRzUtLC86X8CxrKuvvXg9LywtM0LivbKur7fFbUI3MjI3QV7NvLWytLvLXj81Ly82ROa9sa2ttMRaOi4sLTVKzreurK+50ks4MC8yPFTPvLWytbzLaEQ5NDQ4QF7MurOws7vSTDgvLS86Vse1rayvvOZAMy0tM0D4v7SvsLfE/0U5NDM4QVzQvre0trzLZ0I3MjE3Q/3BtK6utMFqPTEtLjVG2Lqvra+4zVA6Mi8zO0/Vvra0trzLbkc7NjU5QVvPvbWytLzPUzsyLzA6T824r66wu9pHNi8uMz5rxLawsbfC7Ug6NTU5QVrUv7m2t73Lb0Y6NDM4QmzGuLCvtcD2QTQuLzVD5b2yrq+4ylk9NDAzO03bv7i1trzKeEk9ODc6QlnUv7i0trzNWz41MDI6TNW7sa+xutJMOTAvMz1dybmysbfB40s8NjU5QVjXwrq4ub3LfEk8NzU5QmHLurOxtr/jRzcwLzVB/8G1r7C3x2M/NjI0O0viw7m2t7zK/Es+OTg7Q1jZwrq2t73MZEI4MzQ6St6+tLCyus1TPDMwMz1Wzbu0s7e/3E4+ODY6QVbbxLy5ur7L+Ew+OTc6Ql3Pvba0t7/bTDozMTU/Z8a4srG3xHdDODM0O0ntxru3uL3J8U0/Ozo8RFfdxby4ub3Lb0Y6NTU6SO3Ct7KzuspdPjUyNDxQ1L22tLe/11M/OTc6QVTex726u7/L8E9AOzk7Q1rVv7i2uL/WUj01MzY/XMy7tLO3wu1IOjU1Okh+yby4ub3J609BPDs9RVfgyL66ur7L/0o9ODc7R3rHurW1ushrQjgzNTxN3L+4tbe+01lCOjg6QVLkyb67vL/M7FJDPDs8RFfbw7u4ub/RWkA4NTc+VtG9trS4wd9MPDc2OkZszL65ub3I5lNDPTw+RVblyr+8vL/L8U4/Ojk8RmnMvbe2usb7Rzo1NjtL58S6tri+z19FPDk7QVDqy7+8vcDM6VVFPjw+RVbgx726ur/PYUQ6Nzg+UdnAuLa4wNlRPjg3O0Viz7+7ur3I4FZFPj0+RlbqzMG9vcDL61FCPDo9RmDQv7m4u8XoTD03NztJ+8i8uLi+zWpIPTo7QU/yzcG9vcHM51hHPz0/RlXnyr+7vMDObUg9OTk+TuLEure5v9RYQTo4O0Nc1cK8u73H3VpHPz0/RlXuzsS/vsLM51ZFPjw+RlzXwru5u8TeUD85ODxHbcy+ubm+y3tLPjs8QE7/z8O+vsLM5VtJQT9AR1XtzcG9vcHNfkw/Ojo+TO/IvLm6v9BfRTw5O0NY28W9u77G2l5JQD4/R1X00MbAv8PM5FpIPz0/R1rcxr27vMTaV0I7OTxGYtC/u7q+yvBOQDw8QE1z0sW/v8PM4l1LQ0BBSFX1z8S/vsLN8U9CPDw/S3rMvrq7v85sST06PEJU4ci+vL7G2GNLQj9AR1T708jCwcXN4V1LQj9AR1jjyr+8vcTWXkY9Oz1FXNbDvLu+yeZSQz09QExr1cfAv8TM4F9NRUJDSVX908fBv8PN6lVFPj0/S2vQwby8v8z/TD88PEJQ68vAvb7G1WpNREBBSFR91cnEw8bN4GFNRUBBSFbrzcK+vsTUZ0o/PD1FWN3Hvry+yN9YRj4+QUtl2cnCwMTM32NOR0NESlV71snDwcXN5VpIQD5ASmPWxb69v8vtUEI9PUFO+87Cvr/F03NPRkFCSFN32MvFxMfO32VPR0NDSVb1z8W/v8XRck1BPT5EVObKv72+x9tdSUA+QUtf3cvDwcXM3WdQSEVGSlV22cvFw8bN4l5LQz9CSl7cyL++wMrlVkU+PkJNctHFv7/F0f5TR0JDSFJw2szHxcjO32lRSUVFSlX/1MjCwcbQ/FFFPz9FUvDNwr6/x9dlS0I/QUpc4s3Fw8XM3GtSSkZHS1Zy3M3HxcjO32NORkJDSlziy8K/wcreW0hAPkJMadbHwMDFz/FWSURESFJt3c7Ix8nP3mxUS0dHS1V32MrEw8fP71ZIQUBFT33Qxb+/xtVuTkRAQkla6c/HxMbM229VS0hITFZv3s/Jx8nO3mlQSERFS1rqzsXBwsrbYUtCP0JLYdvKwsHFzupaS0VESFFp38/JyMrP3m9XTElITFZw3M3HxcjP6VtKQ0JGT27WyMHBxtJ9UUdCQ0lY8NHIxcbM2ndXTElJTFZt4NHLycrP3m5USkZGS1nz0sjDxMrZak5FQUNLXeDMxcLGzuVeTUdFSVBm4tHLycvQ3nRZTkpKTVZt38/Jx8nP5V9NRkRGTmjbysTCx9DzVklERElV/dXKxsfM2f9ZTkpKTVZs49PMysvQ3nNXTEhITFj/1srFxcrXdVJIQ0RLW+nPx8TGzd9jT0hGSU9j59PMysvQ3nhbT0xLTldr4tLLycrQ4mVPSEVHTmLfzcbEx8/qW0tFRUlUdtnMx8fM1/hcT0tKTVdr5tXOzMzR3nlaTkpKTVd32s3Hx8rV/FdKRUVLWPLSycXHzd1qUUpHSU9g69XNy8zR3X1dUU1MTldq5tXNysvQ32tUS0dITl/nz8jFyM/lX01HRklSbdzNycjM1vBeUExLTldp6dfPzc3S3n5dUExLTldv3s/JyMvV8FtMR0dLV//Xy8fHzdtxVUtISk9e8NjOy8zR3f5eU05NT1hp6tfOzMzR33FXTUlKTl3u1MrHyM7gZlBJR0pRaODPysnM1exhUk1MTldo69nQzs7T3v1fU01MTlhs4tLLyszU619PSUhLVXPbzcjIzNl8WE1JSk9d+NrPzM3R3fpgVU9OUFlp7drQzc7S3nlbT0tLT1z42MzJyc7dbVRLSEpQY+bSy8rM1OlmVU5MTlZm7tvSz8/U3vphVk9OT1hq59XNy83U52RSS0lMVGzez8rJzdj4XE5LS09b/9zRzc3R3PZjV1BPUllo79zTz8/U3v9dUU1MT1t9287Kys7cdlhNSktQX+zVzcvM1OVqV09NT1Zl8dzUz9DV3vdkWFFPUVlp69jPzc7U5GpWTUtMVGjk0svKzdbvX1BMS09ad9/Tzs7S3PJlWFJQU1po8t3V0NDV3vpgVE5NUFp13tHMy8/b/ltPS0tPXvTZzszN0+JvWVBOT1Zj9t7V0dHW3vVnWlNQU1lo79vSzs/V4m9ZT0xNU2Tq1c3LzdbqZFRNTE9Zb+LVz87S2+9oWlNRVFpn9d/X0tLW3vZkV1BPUVpv49TOzc/a9F5RTExPXP7c0M3N0992XFJPT1Zi+9/X0tLX3/NpW1VSVFpn9N3Uz9DV4XhcUU1OU2Hw2c/MztXmaVdOTU9YbOfX0M/S2+1rW1VSVVtn+OHZ1NTX3vNoWlNQU1ps6NjPztDZ7mNUTk1QW3jf087O095+XlRPUFZg/+LY1NPX3/JrXVdUVltn+N/X0tHW4P9fVE9PVF/53NHOztXjb1lQTk9YaevZ0s/T2+ttXVZTVVtn++Pa1tXY3/FrXFVSVFtq7NrSz9HZ62lXT05QWnDj1c/O0936YVZRUVZfe+Ta1dTY3/BtXlhWV1xn/OPZ1NPX3/pjV1FQVF5939TPz9Xgd1xST1BXZu/c1NHT2ulxXldVVltm/uXb19bZ3+9tXldUVVtp8d3V0dLZ6G1aUk9RWWzo2NDP09zzZVhSUlZfdufb1tXY3+9vX1pXWFxn/+bb1tXY3/ZnWlNSVV5249fQ0NXf/19VUFFXY/be1dLU2ud2X1lWV1tm/+fd2dja4O9vX1lWV1xo99/X09PZ5nRdVFBSWWnt29PQ09vuaVpUU1Zecurc19bZ3+5xYVtYWV1nfujd2NfZ3/JqXFZTVl1x6NnT0dXe+GNXUlJXYf7g19PU2uV7YlpXV1xlfOne2tnb4e5yYltYWFxn/OPZ1dXZ5HtfV1JTWWby3dXS1NvrbVxVVFdebu3e2NfZ3+10Y1xZWl5nfOre2tja4O9uXlhVV11u7NzV09bd8mdaVFNXX3vk2dXV2uT/ZVtYWFxleuvf29rc4e51ZFxZWl1n/+bc19ba4/5kWVRUWWT639fT1dvpcl5XVVddbO/f2tja3+x3ZV1aW15ne+zg29rb4e9xYFpXWF1s8N7X1dfd7mxcVlRXX3Xo29bW2uL6aF1ZWFxkd+zg3Nvc4u53Zl5bW15nfOnd2djb4/loW1ZWWWN+5NnV1drneGFZVldda/Xi29na3+t6Z15bXF9oee3i3dvc4e51ZFxZWV5r9uHZ1tfd7G9eWFVYXm/s3djW2uH2a15aWVxkde7i3dzd4u55aF9cXF5neuzf29nc4/VrXlhXWmJ56NvX1trl/2RbV1hdafrk3Nna3+p9aF9cXF9oeO/k3tzd4u54Zl1aW15q++Xb2Njd6nZhWldYXm3v39nX2uDybV9bWlxjc/Dk3tze4+57amFdXV9oeO7i3Nvc4/JuX1pYW2F0693Y19vj+2hcWFhcZ/7n3drb3+r/amBdXV9od/Dm393e4+17aV9cXF9p/+jd2trd6HxlW1hZXmv14tvY2t/vcGJcWlxjcPPl3t3e4+19a2JeXmBod/Dk3tzd4+9yY1xaW2Fw7t/a2dvi9mteWllcZnzq3tvb3+n9bGJeXWBodvPn4N7f5O19a2FdXV9pfOvf29vd5/5oXVpaXmn65dza29/tdWRdW11ib/bn397e5O1+bGRfX2FpdvPn393e5O92Zl5bXGFu8+Pc2tvi8m5gW1pdZXjs4Nzc3+j6bmNeXmBodfXp4t/g5e3/bWNfXmBpeu3i3dze5/prX1tbXmj/6N7b29/remdeXF1ibvrp4d7f5O3/bmVhX2JpdfXp4d7f5O56aV9dXWFt+Obd29zh73JjXFtdZHTv4t3c3+f3b2VfXmFodPfq4+Dh5u3/bmZgX2Fpd/Dl3t3f5vZuYlxcXmd769/c3N/qfmlfXV1ibf3r4t/f5O3+b2diYWRqdPfq4+Dg5e59a2JeXmJs/enf3N3h7XhmXlxdY3Hz5d7d3+f1cmdgX2Foc/jr5eLi5+79b2diYGNpdvPn4N7f5vRxZV5dXmZ37uLd3N/p/WxhXl5ibP/s5N/g5Oz8cGhjYmRqdPns5eLi5u7/bWRfX2Jr/+zh3d3h7HxpX11eY2/359/e3+bydmhiX2Jocvrs5uPj5+78cWlkYmRqdfbp4t/g5vF2Z19eX2Z08eXe3d/o+W5kX15ia3zu5eHg5ez7cmlkY2VqdPvt5+Pj5+7+b2ZhYGNrfO7k397i6/9rYV5eY2376uHe3+bweWpjYGJocfzt5+Tk6O78c2plZGVqdPnr5OHi5/B6amJfX2Zx9uff3t/n9nFmX19ianrw5+Lh5ez5dGpmZGZrdPzu6OXl6O78cWljYWRrefHn4N/i6vtuZF9fY2z/7OPf4OXvfGxlYmNocP7u6OXl6O77dWxnZWZrc/vt5uPj5+99bGRgYGZv+uri3+Dn83VoYV9iaXfz6ePi5ev4dmtnZWdrc/3v6ubm6e77dGplY2Vrd/Tp4uDj6vhxZmBfY2t97uXg4OXu/21mY2Nob//v6ebm6e76dm1oZmdrc/3v6OXk6O//bmZiYmZu/ezk4OHn8HlqY2BiaXX26uXj5ev2eG1oZmdrc/7x6+fn6e76dmxnZWZrdvfr5eLk6vZ1aWJhY2t68Ofi4eXt/W9oZGRob37x6ufm6e76eG5pZ2hsc/7w6ubm6e/+cGhkY2du/+7m4uLn73xsZWJjaXP57Obk5uv1em5pZ2hrc//y7Ono6u76eG1pZmdrdfrt5+Tl6vR4a2RiZGp39Onk4uXs+3JpZWRobnz06+jn6e75eW5qaGlsc//y6+jn6e78c2pmZGdtfPHo5OPn7v9uZ2NkaHH87efl5uvzfG9qZ2hsc//07erp6+/5eW9qaGhsdPzu6eXm6vN7bWZjZWp1+Ovl4+bs+XVrZmVobnr27Ono6u75em9raWptc//07eno6u/7dmxnZmhtevTq5eTn7v1waWRkaG//7+nm5uryfnBraGlscn717erq6+/5e3BraWlsdP7w6ufn6vF+b2hlZmpz++3n5Obr9nhsZ2ZobXn47eno6u74e3BsamttdH727urp6+/6eG5pZ2ltePfs5+Xo7fp0amZlaG9+8ern5+rx/3JsaWlscn327uvq7O/5fHFsamptc//z7Ojo6/H/cWpmZmpx/e/p5ufr9XpuaWdobXf67urp6u73fHJta2tudH737+zq7O/5em9raGltd/ru6efo7fh3bGdmaW589Ovo5+rw/nRtampscX337+zr7PD4fXNta2ttc3717erp6/D9dGxoZ2pw//Hq5+fr831vamhpbXb77+vq6+73fXNubGxudH348O3r7O/4fHFsamptdvzv6ujp7fd6bmlnaW569+3p6Orv/HZtampscXz58O3s7fD4fXRubGxudH337uvq7PD8dm1paGtwffTs6Ojr8v9xa2hpbXX98ezq6+72fnRubGxudH358e3s7fD4fXNta2tudf7y7Onp7fV8b2poaW14+e7q6evv+nhua2pscXv68e3s7fD4fnVvbW1udH348Ozr7PD6eW9raWtve/bt6enr8f50bGlpbHT/8+3r6+71/3ZvbW1vdHz68u7t7vH4fnVubGxudf/07erq7fR+cmxpam12/O/r6evv+XpvbGtscHr78u7t7vH4/3Zwbm1vdHz68e3s7fD6e3Bsamxvevnv6+rr8Px2bmpqbHN+9e7r7O71/ndvbW1vdHz78+/u7vH4/3ZvbW1udX727uzr7fT/dG1qam11/vLs6uvu+HxxbWttcHn89O7t7vH4/3dxbm5vdXz78+7t7vH5fHNta2xvefvw7Ors7/p5b2trbXJ99+/s7O70/Xhxbm5vdHz79fDu7/L4/3dxbm5vdX348O3s7vP9dm5ra210//Tt6+vu931zbmxtcHj99e/u7vH4/3hyb29wdXz89e/u7vH5fnVubG1veP3z7evs7/l7cGxrbXF7+fDt7O7z/Hlybm5vdHv89fHv7/L4/3lyb25vdX368u7t7vP8eW9sbG5zfvbu7Ozu9v91bm1tcHf+9vDu7vH3/3lzcG9xdXv99vHv7/L4/3ZvbW1vd/717uzt7/h9c21sbXF6+/Lu7e7z+3tzb25vdHv99vLv8PP4/3p0cG9wdXz78+/u7vP7enJubW5zfPjw7ezu9f53b21tb3f/9/Hv7/H3/np0cXBxdnv99/Lv7/P4/3hxbm5wdv/37+3t7/d+dW5tbXB5/PTu7e7z+3x0b29wdHr+9/Pw8fP4/np1cXBxdXz89fDu7/P6fHRvbW5ze/ry7u3u9P15cW5ub3Z++fLv7/L3/nt1cnFydnv++PPx8fP4/3lzb29xdn748e7u7/b/d29tbnB4/vXv7u7y+n12cW9wdHr++PPx8fT4/nt2cnFydnv99/Hv7/P6fXVvbm9yevz07+7v9Px6c29ucHZ9+vPw7/L3/Xt2cnFzdnv++fTy8vT4/np0cW9xdn368+/u8Pb+eHFubnB3//fw7u/y+X53cm9wdHr/+fTy8vT5/nx3c3Jzdnv++PPw8PT5fndxb29yef317+7v8/t8dG9vcHV8+/Xx8PL3/Xx3c3Jzdnv/+fXz8/T4/nt2cnFydnz79fDv8Pb9enNvb3B3fvjy7+/y+P94c3BxdHn/+vXz8vX5/nx4dHN0dnv/+fTy8fT5/3lzcG9zef/38e/v8/p9dnBvcHV8/Pby8PL2/H13dHJzd3v/+vb08/X5/nx3c3Jzdnz99vLw8fX8e3Vwb3F2ffrz8O/y+P95dHFxdHn/+vbz8/X5/X14dXR0d3v/+vbz8vX5/3p0cXBzeP/58/Dw8/l+d3JvcHV7/ffz8fL2/H14dXN0d3v/+/f19Pb5/X14dHN0d3z9+PPx8vX7fXZxcHF2fPv18fDy9/56dXJxdHl++/f08/X5/X15dnR1d3v/+/f08/X5/nt2cnFzeH769PHw8/n/eXNwcXR6/vj08vP2+355dXR0d3v/+/f19fb5/X15dnR0d3v++fTy8vX7fnhzcXJ2fP328vHy9/18dnNydHh+/Pf09PX5/X15dnV2eHv/+/f19Pb5/nx3dHJ0eH379vLx8/j+enVycXR5//n18vP2+/96dnR1d3v//Pj29ff5/X56dnV1d3v/+vbz8/b6/3l0cnJ2e/748/Lz9/x9d3RzdHh9/fj19Pb5/X56d3Z2eHv//Pj29fb5/X14dXN0eH389/Py9Pj+e3ZzcnR5//r28/P2+v97d3V1d3r//Pn29vf5/X56d3Z2eHv/+/f09Pb6/3p2c3N2ev/59fLz9vt+eHVzdHh9/fn29fb5/H56eHZ2eHv//Pn39vf5/X15dnR1eHz9+PXz9Pj9fHd0c3V5fvv39PT2+v97d3V1d3p+/fn39vf6/X57eHZ2eHv//Pj19fb6/3t3dHR2ev/69vP09vv/eXV0dXh8/vr29fb5/P97eHd3eHv//fr39/f6/X56d3V2eHz++fb09fj8fXh1c3V4ffz49fT2+f58eHZ2d3p+/fr49/j6/f97eXd3eHv//Pn29vf6/nx4dXR2ev/79/T09vr/enZ0dXd8//r39vb4/P97eXd3eXt+/fr49/j6/f97eHZ2eHz/+vf19fj8fnl2dHV4ff359vX2+f59eXZ2d3p+/fr49/j6/f98eXh4eXt+/fr39vf6/n15dnV2eX78+PX19vr/e3d1dXd7//v49vb4/P98eXh4eXt+/fv5+Pj6/f98eXd3eXz/+/j29vj7/3p3dXV4fP769vX2+f19end2d3p9/vv4+Pj6/f98enh4eXt+/fr49/j6/X56d3Z3eX39+fb19/r+fHh2dnd7//z49/f4+/98enh4eXt+/vv5+Pn6/f98eXh4eXv//Pn39vj7/3t4dnZ4fP/69/b2+f1+enh3d3p9/vv5+Pj6/f99enl5ent+/vv5+Pj6/X57eHd3eX3++vf29/r+fXl3dnd6fvz59/f4+/99enh4eXt+/vv6+fn6/f99enh4eXv//fr49/j7/3x5d3Z4e//7+Pb3+fz/e3h3eHp9//z5+Pn6/f99e3l5enx+/vv5+Pn6/f97eXd4eX3/+/j39/n9fnp3d3h6fv36+Pf5+/59e3l4eXt+/vz6+fn7/f99e3l5enx+/fr4+Pj7/n16d3d4e//8+ff3+fz/fHl4eHp9//z6+fn6/f99e3p5enx+/vz6+fn7/f98enh4enz//Pn39/n9fnt4d3h6ff76+Pj5+/5+e3l5eXt+//z6+vr7/f99e3p5enx+/vv5+Pn7/n56eHd4e379+vj3+fz/fHl4eHp8//z6+fn6/P99e3p6enx+//z7+vr7/f99enl5enz//Pn4+Pn8/3x5eHh6ff77+fj5+/5+e3p5ent+//z7+vr7/f9+fHp6enx+/vz6+fn7/n57eXh5e37++vj4+fv/fXp4eHp8//37+fn6/P9+fHp6e3x+//37+vr7/f99e3l5enz//fr5+Pr8/3x6eHh6ff/8+fj5+/3/fHp5ent+//37+vr7/f9+fHt6e3x+//z6+fr7/f98enl5e37++/n4+fv+fnt5eXp8//37+vn6/P9+fHt6e3x+//37+vr7/f9+e3p6enz//fv5+fr8/316eXl6fP/8+vn5+/3/fHp6ent9//37+vr7/f9+fHt6e3x+//37+vr7/f98enl5e33//Pr5+fv+fnt5eXp8fv77+vr6/P5+fHt6e3x+//38+/v7/f9+fHt6e3x+/vz6+fr8/317eXl6fP/9+/n5+/3/fXt6ent9//38+/v7/f9+fXt7e3x+//37+vr7/f99e3p6e33//Pr5+fv9/3x6eXp8fv78+vr7/P5+fXt7e3x+//38+/v8/f9+fHt6e3x+/vz6+vr8/n58enl6fP/9+/r5+/3/fXt6ent9//78+/v8/f9+fXx7e3x+//38+/v7/f99e3p6e33//fv6+vv9/3x6enp7fv/8+/r7/P7/fXt7e3x+//78+/v8/f9+fXt7e3x+//37+vr8/n58enp6fH7+/Pr6+/z/fnx6ent9//78+/v8/f//fXx7fHx+//78+/v8/f9+fHt6e33//fv6+vv9/317enp7ff/9+/r7/P7/fXx7e3x+//79/Pz8/f//fXx7e3x+//37+/v8/v99e3p6fH7+/Pv6+/z/fnx7e3t9//78+/v8/f//fXx8fH1+//79/Pv8/f9+fHt7e33//vz7+vv9/317enp7ff/9+/v7/P7/fXx7e3x+//79/Pz8/f//fXx8fHx+//38+/v8/v99e3p7fH7//fv6+/z+fnx7e3t9//79/Pv8/f7/fXx8fH1+//79/Pz8/f//fXx7e33//vz7+/v9/358e3t7ff/+/Pv7/P7/fnx8fHx+//79/Pz8/f//fnx8fH1+//78+/v8/f9+fHt7fH7//fv7+/z+/317e3t9fv/9/Pz8/f7/fn18fH1+//79/Pz8/f//fXx7fH1+//37+/v9/358e3t7ff/+/Pv7/P3/fn18fHx+//79/Pz9/f//fn18fH1+//79/Pz8/f9+fHt7fH3//vz7+/z+/318e3t9fv/9/Pz8/f7/fn18fH1+//79/fz8/f//fnx8fH1+//38+/z9/v99fHt8ff/+/fz7/P3/fn18fHx+///9/fz9/f//fn18fH1+//79/Pz8/f9+fXx7fH3//vz7+/z+/358e3x9fv/+/Pz8/f7/fn18fH1+///+/fz9/f//fn18fH1+//78/Pz9/v99fHt8fX7//fz7/P3/fn18fHx9///+/fz9/f//fn19fX1+///9/Pz8/f//fXx8fH3//v38+/z+/358fHx9fv/+/fz8/f7/fn19fX1+///+/f39/f7/fn18fH1+//79/Pz9/v9+fHx8fX7//fz8/P3//318fHx9///+/f39/f7/fn19fX1+///+/fz9/f//fXx8fH3///38/Pz9/359fHx9fv/+/fz8/f7/fn19fX1+///+/f39/v7/fn19fX1+//79/Pz9/v9+fXx8fX7//vz8/P3+/359fH19////////////////////////////////////AA==" } } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" }, "example": { "code": 202, "message": "Accepted" } } }, "headers": {} } }, "security": [ { "bearer": [] } ] } } }, "webhooks": {}, "components": { "schemas": { "Domain": { "type": "object", "properties": { "domain": { "$ref": "#/components/schemas/DomainName" }, "reseller": { "type": "string", "description": "This is the reseller that owns this domain. Must be a valid resller name on creation. If Reseller level scope you can use \"~\" to set your own reseller on create, Super User's will need to set this to a valid Reseller. " }, "description": { "type": "string", "description": "This is a description of the domain. This will be shown in many places to help show a more user friendly version of the domain to help identify it. " }, "music-on-hold-enabled": { "$ref": "#/components/schemas/YesNoString", "description": "Enabled will trigger music on hold for the domain and allow it to be customized. " }, "music-on-ring-enabled": { "$ref": "#/components/schemas/YesNoString", "description": "Enabled will trigger music on hold for the domain and allow it to be customized. " }, "music-on-hold-randomized-enabled": { "$ref": "#/components/schemas/YesNoString", "description": "Enabled will trigger music on hold for the domain and allow it to be customized. " }, "domain-type": { "type": "string", "enum": [ "Standard", "Residential", "Hospitality" ], "description": "Allows a special domain type to be set for specific use cases. Currently Residenital and Hospitality are options which will limit and effect the users expierence. " }, "dial-plan": { "type": "string", "description": "This is the default dial plan that will be used for new users created in the domain. A dial plan is created by default on new domain creation with a name matching the domain. " }, "dial-policy": { "type": "string", "description": "This is the default dial policy (permission) that will be used for new users added ot the domain. Generally these are system wide policies and will not need to create one per domain. " }, "email-send-from-address": { "type": "string", "description": "This is the email source that will be used when sending out emails for this domain. This address should be configured properly through the email server so that emails are not blocked. In most cases this is recommended to be an address on the service providers or resellers hostname so DNS SPF records can be added on the hostname to prevent spam issues. More info on SPF records available via https://www.cloudflare.com/learning/dns/dns-records/dns-spf-record/" }, "single-sign-on-enabled": { "$ref": "#/components/schemas/YesNoString", "description": "Enabled will trigger music on hold for the domain and allow it to be customized. " }, "area-code": { "type": "number", "description": "The default area code for the domain. This is used by default on 7 digit dials to extent the number to a valid 10 digit number. ", "minimum": 100, "maximum": 999, "examples": [ 858 ] }, "caller-id-name": { "type": "string", "description": "This is the main caller id name for the user to be used for outbound calls outside of the domain. " }, "caller-id-number": { "type": [ "string", "integer", "boolean", "array", "object", "number", "null" ], "description": "This is the main caller id number for the user to be used for outbound calls outside of the domain. " }, "caller-id-number-emergency": { "type": [ "string", "integer", "boolean", "array", "object", "number", "null" ], "description": "This is the main caller id that will be used for emergency calls when placed by the user. " }, "limits-max-subcriber-resources-total": { "type": "integer", "description": "This is the maximum number of subscribers allowed for domain including the subscribers that would be created as part of resources like call queues and auto attendants. If looking to limit nornal users it would be better to use limits-max-users" }, "limits-max-active-calls-total": { "type": "integer", "description": "This is the limit for the number of active calls allowed in the domain simultaniously. Note: this will count and limit intra domain calls. " }, "limits-max-active-calls-offnet": { "type": "integer", "description": "This is the limit for the number of active calls allowed in the domain simultaniously that are connected to offnet or external numbers. " }, "limits-max-call-queues": { "type": "integer", "description": "This is the maximum number of call queues that would be allowed to be created in this domain. " }, "limits-max-auto-attendants": { "type": "integer", "description": "This is the maximum number of auto attendants that would be allowed to be created in this domain. " }, "limits-max-conferences": { "type": "integer", "description": "This is the maximum number of conference bridges that would be allowed to be created in this domain. " }, "limits-max-departments": { "type": "integer", "description": "This is the maximum number of departments that would be allowed to be created in this domain. " }, "limits-max-users": { "type": "integer", "description": "This is the maximum number of regular users that would be allowed to be created in this domain. " }, "limits-max-sites": { "type": "integer", "description": "This is the maximum number of sites that would be allowed to be created in this domain. " }, "limits-max-fax-accounts": { "type": "integer", "description": "This is the maximum number of fax accounts that would be allowed to be created in this domain. " }, "time-zone": { "$ref": "#/components/schemas/TimeZone" }, "email-send-smtp-hostname": { "type": [ "string", "null" ], "description": "This is the SMTP server hostname. SMTP server configs are NOT required at domain level as they will inherit reseller or system level as needed. ", "format": "hostname" }, "email-send-smtp-port": { "type": [ "string", "null" ], "description": "This is the SMTP port for sending emails. SMTP server configs are NOT required at domain level as they will inherit reseller or system level as needed. " }, "email-send-smtp-username": { "type": [ "string", "null" ], "description": "This is the username used in connecting to SMTP server for sending email. SMTP server configs are NOT required at domain level as they will inherit reseller or system level as needed. " }, "email-send-smtp-password": { "type": [ "string", "null" ], "description": "This is the password used in connecting to SMTP server for sending email. SMTP server configs are NOT required at domain level as they will inherit reseller or system level as needed. ", "format": "pass" }, "active-calls-total-current": { "type": "integer", "readOnly": true, "description": "This is the total active calls for the domain including on-net (intra domain) calls and calls across geo servers and calls linked to \"guest\" video sessions" }, "active-calls-against-license-count": { "type": "integer", "readOnly": true, "description": "This is the total active calls for the domain including on-net (intra domain) calls but counted as the license would be enforced inlcuding ignoring geo call legs and guest video sessions. " }, "active-calls-offnet-current": { "type": "integer", "readOnly": true, "description": "This is the total active calls for the domain only including calls that are connected to a remote (non intra domain) caller/calling party." }, "count-subcriber-resources-total": { "type": "integer", "description": "This is the total number of users plus all the system users as well for the entire domain. ", "readOnly": true }, "emergency-address-id": { "type": [ "string", "null" ], "description": "Value will need to be an exact match to an address-id which links to a address for DLR (dynamic location routing) for emergency calling" }, "voicemail-enabled": { "$ref": "#/components/schemas/YesNoString", "description": "Enabled will trigger music on hold for the domain and allow it to be customized. " }, "recording-configuration": { "$ref": "#/components/schemas/RecordingConfiguration" }, "voicemail-transcription-enabled": { "type": "string", "description": "Enable this setting and select a vendor if you wish to have voicemails transcripted after a voicemail is recorded. ", "enum": [ "no", "Deepgram", "Google", "Mutare", "Voicebase" ], "default": "no" }, "language-token": { "type": "string", "description": "This is the language that is set for the user to be used for portal viewing. ", "default": "en_US", "examples": [ "es_MX", "en_CA" ] }, "is-domain-locked": { "$ref": "#/components/schemas/YesNoString", "description": "Enabled will trigger music on hold for the domain and allow it to be customized. " }, "is-stir-enabled": { "$ref": "#/components/schemas/YesNoString", "description": "Enabled will trigger music on hold for the domain and allow it to be customized. " }, "is-ivr-forward-change-blocked": { "$ref": "#/components/schemas/YesNoString", "description": "Enabled will trigger music on hold for the domain and allow it to be customized. " } }, "required": [ "domain", "reseller", "description" ] }, "User": { "type": "object", "properties": { "domain": { "$ref": "#/components/schemas/DomainName" }, "user": { "$ref": "#/components/schemas/UserName" }, "name-first-name": { "type": "string", "description": "This is the first name for the user" }, "name-last-name": { "type": "string", "description": "This is the last name for the user" }, "login-username": { "type": "string", "description": "This is the login for the user used to access the portals and other applications. The default will be [user]@[domain] if not set otherwise. This value is required to be unique across the entire system so 409 will be returned if not unique." }, "email": { "type": "string", "description": "This is the email adresses or list of email addresses sepertaed with a semi-colon. ", "format": "email" }, "user-scope": { "$ref": "#/components/schemas/Scopes" }, "department": { "type": "string", "description": "This is the depertment that user belongs to in the domain. Can be any string to group users, a department is not require to be setup before in order to set it for a user. " }, "site": { "type": "string", "description": "This is the site or location for this user. The site will group users that are at the same phyiscal location, but can be used for other grouping purposes as well. New users will inherit some settings from the site if the site was previously setup. If the site is not previously created then a new site will be created with the value given on new user create assuming the domain's max sites setting has remaining sites. " }, "time-zone": { "$ref": "#/components/schemas/TimeZone" }, "voicemail-login-pin": { "type": "string", "description": "This is the numberic pin that would be used by the user validating their account when connecting into voice IVR to check voicemail. " }, "privacy": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "dial-plan": { "type": "string", "description": "This is the dial plan set for the user. Dial plans are used to control action and forward options that will be used when dialing out from the user. " }, "dial-policy": { "type": "string", "description": "This value is the dial policy/permission for this user whch will control the destinations this user can dial. Generally dial policys are preconfigured at system level and selected at user level. " }, "status-message": { "type": "string", "description": "This is is a value that is often set by the end user to show their current status, often a away message of some kind. ", "examples": [ "Im at lunch", "PTO till 3/15" ] }, "user-presence-status": { "type": "string", "readOnly": true, "description": "This is a read only presence status for the user that will be calculated by the core system based on registration, answer rules and active call status. " }, "directory-name-number-dtmf-mapping": { "type": "integer", "description": "This is a 3 digit numberic mapping that correlates to the first 3 digits of a user's first or last name for dial by name directory. Example Smith would be \"764\" translating the letters to numbers using the normal phone number mappings. ", "minimum": 100, "maximum": 999 }, "voicemail-user-control-enabled": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "phone-numbers-to-allow-enabled": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "phone-numbers-to-reject-enabled": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "call-screening-enabled": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "ring-no-answer-timeout-seconds": { "type": "integer", "description": "This time setting in seconds will controll how long a inbound call attempt will attempt to connect the call before stopping and attempting the next option which might be a forward setting in answer rules or voicemail if enabled. ", "minimum": 0, "maximum": 3600 }, "language-token": { "type": "string", "description": "This is the language that is set for the user to be used for portal viewing. ", "default": "en_US", "examples": [ "ca_FR", "es_MX", "en_UK" ] }, "limits-max-data-storage-kilobytes": { "type": "integer", "description": "This is the maximum value in kilobytes that is allowed to be stored in the user's voicemail, audio greetings and fax storage. ", "minimum": 0 }, "limits-max-active-calls-total": { "type": "integer", "description": "This is the maximum number of active calls allowed for the user. ", "minimum": 0, "maximum": 3600 }, "directory-announce-in-dial-by-name-enabled": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "directory-override-order-duplicate-dtmf-mapping": { "type": "integer", "description": "This value can be used in cases where multiple users have the same value for directory-name-number-dtmf-mapping, if they are the same then use this setting to set the order low to high for playback in dial by name directory menu. ", "minimum": 0, "maximum": 100 }, "voicemail-greeting-index": { "type": "integer", "description": "This is the index of the greeting that is enabled currently for the user. Greeting 0 is the generic \"[name] is not available\" message will be played. ", "minimum": 0 }, "voicemail-enabled": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "voicemail-receive-broadcast-enabled": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "reject-anonymous-calls-enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "voicemail-playback-announce-datetime-received": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "voicemail-playback-announce-caller-id": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "voicemail-playback-sort-newest-to-oldest": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "email-send-alert-new-voicemail-cc-list-csv": { "type": "string", "description": "This list of user's which will be forward copies of new voicemails left on that user. ", "examples": [ "1001,1002,3000" ] }, "email-send-alert-new-voicemail-behavior": { "type": "string", "description": "This is the behavior that the voicemail logic will take after a voicmail is left. The options include ability to send with attachements or hyperlinks.", "enum": [ "no", "yes", "attnew", "attsave", "atttrash", "brief", "briefattnew", "briefattsave", "briefatttrash" ], "default": "no" }, "email-send-alert-new-voicemail-enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "email-send-alert-new-missed-call-enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "email-send-alert-data-storage-limit-reached-enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "caller-id-number": { "type": "string", "description": "This is the main caller id number for the user to be used for outbound calls outside of the domain. ", "examples": [ "18585551234", "\"[*]\"" ], "format": "phonenumber" }, "caller-id-name": { "type": "string", "description": "This is the main caller id name for the user to be used for outbound calls outside of the domain. " }, "caller-id-number-emergency": { "anyOf": [ { "type": "integer", "title": "", "description": "" }, { "type": "string", "title": "", "description": "" } ], "description": "This is the main caller id that will be used for emergency calls when placed by the user." }, "area-code": { "type": "integer", "description": "This is a area code for the user. I will be used when user dial's 7 digits to translate it to full 10 or 11 digit number. ", "minimum": 100, "maximum": 999 }, "directory-name-visible-in-list-enabled": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "service-code": { "type": "string", "description": "Service codes are for internal use that allow user's to be tagged for billing and tracking purposes. Any service code starting with \"system-\" will be hidden by default in the portals and not count as regular users. " }, "voicemail-transcription-enabled": { "type": "string", "description": "Enable this setting and select a vendor if you wish to have voicemails transcripted after a voicemail is recorded. ", "enum": [ "no", "Deepgram", "Google", "Mutare", "Voicebase" ], "default": "no" }, "emergency-address-id": { "type": "string", "description": "Value will need to be an exact match to an address-id which links to a address for DLR (dynamic location routing) for emergency calling" }, "call-recordings-hide-from-others-enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "music-on-hold-randomized-enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "music-on-hold-comfort-message-repeat-interval-seconds": { "type": "integer", "minimum": 0, "maximum": 3600, "description": "This interval will control how frequently the music on hold would be interupted and have messages played. Should be used when using music on hod and custom messages. " }, "active-calls-total-current": { "type": "integer", "readOnly": true, "description": "This read only setting is the current active call count for this user. " }, "account-status": { "type": "string", "readOnly": true, "enum": [ "standard", "reset", "new", "pwd reset" ], "description": "This status is read only and is calcuated to suggest special states that can be relayed to the end user or manager views. Status's include when a user is new, the user has been reset or pasword needs to be set. " }, "created-datetime": { "type": "string", "readOnly": true, "format": "date-time", "description": "This datetime is when the user was created. " }, "last-modified-datetime": { "type": "string", "format": "date-time", "readOnly": true, "description": "This datetime is when the user was last modified. " }, "recording-configuration": { "$ref": "#/components/schemas/RecordingConfiguration" } }, "required": [ "domain", "user", "name-first-name", "name-last-name", "email", "user-scope" ] }, "Device": { "type": "object", "properties": { "device": { "type": "string", "description": "This is the \"device\" id which will be the first part of the device-sip-registration-uri which can be used to read specific device information. " }, "user": { "$ref": "#/components/schemas/UserName" }, "domain": { "$ref": "#/components/schemas/DomainName" }, "device-sip-registration-uri": { "type": "string", "readOnly": true, "description": "This read-only value is the full SIP uri and will often be sip:[device]@[domain]" }, "device-sip-registration-state": { "type": "string", "readOnly": true, "enum": [ "registered", "unregistered" ], "description": "This is the current registration status for the device. This value will be registered if its in the value time windoe " }, "device-sip-registration-password": { "type": "string", "format": "password", "description": "This is the password which would be used for device registration. If left unset on device create it will create a new random password with a default length of 16 characters. " }, "caller-id-number-emergency": { "type": "string", "description": "This is a override value for emergency caller id value that would be specific to this device and would override the user's set value. ", "default": "[*]" }, "device-force-notify-new-voicemails-enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "device-level-call-recording-enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "device-push-enabled": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "device-sip-registration-contact": { "type": "string", "readOnly": true, "description": "This is the contact value for the device from the last successfull registration. " }, "device-sip-registration-core-server": { "type": "string", "format": "hostname", "readOnly": true, "description": "This is the hostname for which the last registration was completed. This would be used to connect the device from on inbound call. " }, "device-sip-registration-datetime": { "type": [ "string", "null" ], "readOnly": true, "format": "date-time", "description": "This date-time will be the last registration time of the device. This time may be slightly delayed to improve replication throughput. " }, "device-sip-registration-expires-datetime": { "type": [ "string", "null" ], "readOnly": true, "format": "date-time", "description": "This date-time will be the time at which the device will be treated as unregisted and should be in the future for active registed devices." }, "device-sip-registration-expiry-seconds": { "type": "integer", "description": "This is the requested re-register perior for the device. The device will be treated as unregistered if they do not register in this window + a system wide grace period. ", "default": 60 }, "device-sip-registration-ignore-for-presence-calculation": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "device-sip-registration-ignore-report-enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "device-sip-registration-ip-address": { "type": "string", "readOnly": true, "format": "i", "description": "This is the read-only value is the IP:port for the last successfull registration. " }, "device-sip-registration-user-agent": { "type": "string", "readOnly": true, "examples": [ "Yealink T48 2.3.232", "SnapMobile Web 44.0.2" ], "description": "This is the read-only value for the user-agent used during the last successfully registration. " }, "device-sip-no-to-tag-in-cancel": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "device-srtp-enabled": { "type": "string", "enum": [ "yes", "no", "opportunistic" ], "default": "no", "description": "This setting will enable SRTP (secure/encrypted audio) on the the device. Yes will force and \"opp" }, "auto-answer-enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "device-sip-allowed-user-agent": { "type": "string", "description": "This value can be used to restrict registration to a specific User Agent or partial match of User Agent. This allows for an extra layer of secutiry if you know the expected user agent. " }, "device-sip-nat-traversal-enabled": { "type": "string", "description": "This is the main nat transveral setting. In most all device cases \"automatic\" is the correct answe", "enum": [ "automatic", "none", "never", "fixed" ], "default": "automatic" }, "device-sip-latency-seconds-current": { "type": "number", "readOnly": true, "description": "This is the latency from the latest registration measured in seconds from the time the core sent a 407 challenge to the 200ok with Auth. " }, "device-sip-latency-seconds-average": { "type": "number", "readOnly": true, "description": "This is the average of the last 5 registration attempts measured similiarly to device-sip-latency-seconds-current. " }, "emergency-address-id": { "type": [ "string", "null" ], "description": "This value if set will be the address-id specific to this device for emegeny calling" }, "error-reading-from-endpoint-module": { "type": "string", "readOnly": true, "description": "If yes, it means the API had an issue accessing the NDP for mac specific data" }, "login-username": { "type": "string", "readOnly": true, "description": "This is a read-only value of the user's login for the owner of the device. " }, "name-full-name": { "type": "string", "readOnly": true, "description": "This is a read-only value of the user's full name for the owner of the device. " }, "device-models-model": { "type": "string", "description": "This is an optional model that when provided with device-provisioning-mac-address will link this device to the mac address in the device provisioning platform. " }, "device-provisioning-mac-address": { "type": "string", "description": "This is the mac address that has this device linked to it. This field can be used to link a mac address on device create. Must also provide a device-models-model" }, "device-provisioning-registration-core-server": { "type": "string", "description": "This is the SiPbx Servers primary server config from a list of valid " }, "device-provisioning-sip-transport-protocol": { "type": "string", "enum": [ "udp", "tcp", "tls" ], "default": "udp", "description": "This is the transport that will be requested when provising the device. " }, "device-provisioning-username": { "type": [ "string", "null" ], "description": "The provisioning username for the request to authenticate the configuration request. " }, "device-provisioning-password": { "type": [ "string", "null" ], "description": "The provisioning password for the request to authenticate the configuration request. " }, "device-provisioning-line": { "type": "integer", "description": "Optional setting to select which line is used on the device when provisionined with device-models-model and device-provisioning-mac-address" }, "device-provisioning-overrides": { "type": "string", "description": "This is the overrides set for the mac address in the provisioning server on the mac linked to this device." }, "recording-configuration": { "$ref": "#/components/schemas/RecordingConfiguration" } }, "required": [ "device", "user", "domain" ] }, "CallQueue": { "type": "object", "properties": { "callqueue": { "type": "string", "description": "This is the main call queue extension which is the identifier for this call quieue. " }, "domain": { "$ref": "#/components/schemas/DomainName" }, "description": { "type": "string", "description": "This is a simple description of the callqueue which can be used to better explain the use or purpose of this call queue. " }, "callqueue-dispatch-type": { "type": "string", "description": "This is the main dispatch type for hunting agents. The options are described below. \n#Round-robin\n#Tiered Round-robin\n#Ring All\n#Linear Cascade\n#Linear Hunt\n#Call Park\n", "title": "", "enum": [ "Round-robin", "Tiered Round-robin", "Ring All", "Linear Cascade", "Linear Hunt", "Call Park" ] }, "callqueue-calculate-statistics": { "$ref": "#/components/schemas/YesNoString", "description": "Enabled will trigger music on hold for the domain and allow it to be customized. " }, "active-queued-calls-total-current": { "type": "integer", "description": "This is the current calls waiting in the call queue waiting to be dispatched. ", "readOnly": true }, "callqueue-agent-dispatch-timeout-seconds": { "type": "integer", "description": "This is the timeout in seconds the call queue will attempt an agent before timing out and retrying additional resources." }, "callqueue-count-agents-available": { "type": "integer", "description": "This is the current number of agents logged in and available for work. ", "readOnly": true }, "callqueue-count-agents-total": { "type": "integer", "description": "This is the current number of agents configured for this callqueue. " }, "callqueue-debug": { "$ref": "#/components/schemas/YesNoString", "description": "Enabled will trigger music on hold for the domain and allow it to be customized. " }, "callqueue-force-full-intro-playback": { "$ref": "#/components/schemas/YesNoString", "description": "Enabled will trigger music on hold for the domain and allow it to be customized. " }, "callqueue-max-callback-queueing-hours": { "type": "integer", "description": "This setting will allow callback's in the callqueue allowing callers to press a buton and opt for a callback instead of waiting. 0 the default is off, any other positive number will enable callback and allow callback up to that many hours after the callback is requested. ", "default": 0, "minimum": 0, "maximum": 6 }, "callqueue-max-current-callers-to-accept-new-callers": { "type": "integer", "description": "This setting is the maximum number of callers allowed in the queue before forward busy answer rules will be followed. 0 is unlimited", "minimum": 0, "default": 0 }, "callqueue-max-current-wait-to-accept-new-callers-seconds": { "type": "integer", "description": "This setting is the maximum expected wait time allowed in the queue before forward busy answer rules will be followed. 0 is unlimited", "minimum": 0, "default": 0 }, "callqueue-max-wait-timeout-minutes": { "type": "integer", "description": "This is the max wait time in minutes that it would allow a call to wait before being forced out of the queue. 0 is unlimited", "default": 0, "minimum": 0 }, "callqueue-require-available-agents-to-accept-new-callers": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "callqueue-source-match": { "type": [ "string", "null" ], "description": "This is a optional setting that will control the source match for the forward dispatch leg of calls allowing if needed different matches to connecting devices when calls come through the queue. " }, "callqueue-sms-enable": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "callqueue-sms-phrase-initiate-chat": { "type": [ "string", "null" ], "description": "This is the keyword that will be the trigger for a new SMS queueing session " }, "callqueue-sms-phrase-initiate-success": { "type": [ "string", "null" ], "description": "The message to auto reply to a inbound SMS message once the trigger keyword is detected" }, "callqueue-sms-phrase-initiation-fail ": { "type": [ "string", "null" ], "description": "The message that will be auto replied when a message wihtout the keywork is detected. " }, "callqueue-sms-phrase-no-agents-available": { "type": [ "string", "null" ], "description": "The message that will be auto replied when there are no agents available and the system is unable to setup a sms chat session at this time. " }, "callqueue-sms-phrase-terminate-chat": { "type": [ "string", "null" ], "description": "This is the keyword that will be the trigger to end a active SMS session. " }, "callqueue-sms-phrase-terminate-success": { "type": [ "string", "null" ], "description": "The message that will be played after a successfully termination of a session via a keyword. " }, "callqueue-agent-auto-logout-after-missed": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "callqueue-sim-ring-1st-round": { "type": "integer", "description": "When using a callqueue-dispatch-type value that allows for mutlple agents to be run on at a time this setting controls the amount of agents that are dispatched in the first round.", "minimum": 0, "maximum": 99, "default": 0 }, "callqueue-sim-ring-increment": { "type": "integer", "description": "When using a callqueue-dispatch-type value that allows for mutlple agents to be run on at a time this setting controls the amount of agents that will be added to the group activly ringing at each agent timeout level. ", "minimum": 0, "maximum": 99, "default": 1 }, "recording-configuration": { "$ref": "#/components/schemas/RecordingConfiguration" } }, "required": [ "domain", "callqueue" ] }, "Agent": { "type": "object", "properties": { "callqueue-agent-id": { "type": "string", "examples": [ "1000@domain", "sip:1001@domain.com" ], "description": "This is the main identifier for a \"agent\" in a queue. There are two format supported here, either a user based option which will look like user@domain or a device based method like sip:device@domain. " }, "callqueue": { "type": "string", "description": "This is the callqueue id for which the agent is in. The agent may be in multiple callqueus, but this value is a single entry. ", "examples": [ "3000" ] }, "domain": { "$ref": "#/components/schemas/DomainName" }, "callqueue-agent-availability-type": { "type": "string", "enum": [ "automatic", "manual", "disabled", "offnet-automatic" ], "description": "This is the main toggle for the agents status in the queue. \"automatic\" is logged in, which manual is logged out with the option for one call. From a angent perspective and the actions of logging in and out the recomention would be to use the specific \"agent actions\" api instead of the basic agent update request. " }, "callqueue-agent-wrap-up-allowance-seconds": { "type": "integer", "default": 0, "description": "This is the number of seconds that the system will hold the agent offline before logging them back in automatically. This time allows the agent to comolete needed notes and conclusions to previous calls and prepare for next call. " }, "auto-answer-enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "callqueue-agent-dispatch-order-ordinal": { "type": "integer", "description": "For use in callqueues that have a linear order, this value would be to the order of the agent in that list, the lower the number the higher agent in the order. " }, "callqueue-agent-dispatch-queue-priority-ordinal": { "type": "integer", "description": "This setting is a priority value for this agent's entry with respect to the other callqueues they are in. Lower number is higher priority. This means that when the agent comes back available after a call the priority would be used to determine which queue its attempted first. " }, "limits-max-active-calls-total": { "type": "integer", "description": "This is the maximum number of calls an agent will be given at at time. Default and ideal is 1, but if needed it can be higher" }, "callqueue-agent-answer-confirmation-enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "callqueue-agent-has-registered-devices": { "type": "string", "enum": [ "yes", "no", "push-enabled", "offnet" ], "readOnly": true, "description": "This read only status will show the agents registration infor and if the system believes the device is registered. " }, "callqueue-agent-availability-for-dispatch": { "type": "string", "description": "This is the status for the agent generated by the system using all available informaion. " }, "active-calls-total-current": { "type": "integer", "readOnly": true, "description": "This is the total number of calls on the agent's account across all their queues" }, "last-modified-datetime": { "type": "string", "format": "date-time", "readOnly": true, "description": "This timestamp is the datetime of the last change to the agent's configuration and status" }, "callqueue-agent-max-concurrent-sms-conversations": { "type": "integer", "description": "This is the maximum number of SMS queue sessions the agent will be requested to handle before queing up future requests. " }, "last-callqueue-dispatch-datetime": { "type": [ "string", "null" ], "format": "date-time", "readOnly": true, "description": "This timestamp is the datetime of the last dispatch to the agent. " }, "callqueue-agent-entry-type": { "type": "string", "description": "This is a read only field that will tell you the type of agent config that is setup, this might include device or user based agents or \"offnet\"", "readOnly": true, "enum": [ "device", "user", "offnet" ] }, "login-username": { "type": "string", "readOnly": true, "description": "This value read only from the user that is linked to this agent. Its the user's login if needed. " }, "name-full-name": { "type": "string", "readOnly": true, "description": "This value read only from the user that is linked to this agent. Its the user's full name. " }, "agent-name-first-name": { "type": "string", "readOnly": true, "description": "This value read only from the user that is linked to this agent. Its the user's first name. " }, "agent-name-last-name": { "type": "string", "readOnly": true, "description": "This value read only from the user that is linked to this agent. Its the user's last name. " }, "agent-department": { "type": "string", "readOnly": true, "description": "This value read only from the user that is linked to this agent. Its the user's depeartment. " }, "agent-site": { "type": "string", "readOnly": true, "description": "This value read only from the user that is linked to this agent. Its the user's site " }, "agent-user-scope": { "type": "string", "readOnly": true, "description": "This value read only from the user that is linked to this agent. Its the user's scope. " }, "agent-status-message": { "type": [ "string", "null" ], "readOnly": true, "description": "This value read only from the user that is linked to this agent. Its the user's status message. " } }, "required": [ "callqueue-agent-id" ] }, "Answerrule": { "type": "object", "properties": { "domain": { "$ref": "#/components/schemas/DomainName" }, "user": { "$ref": "#/components/schemas/UserName" }, "time-frame": { "type": "string", "description": "This is the timeframe that also is needed to make this set of answer rules unique. * is teh default and if no timeframes are setup this is is how to set anserrules. " }, "enabled": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "is-active": { "type": "boolean", "readOnly": true, "description": "This is read only option that will be true if this timeframe is active for this user when taking into account current settings, date/time and all timeframes. " }, "order": { "type": "integer", "description": "This is to allow for a priority based order of different timeframes. The default is to add it in value higher (lower priority) than the lowest priority timeframe. Timeframe * will get 99 if not already set. ", "minimum": 0, "default": 99, "readOnly": true }, "simultaneous-ring": { "description": "This is a feature that will allow multiple phones or remote extensions to be called at the same time. ", "$ref": "#/components/schemas/AnswerruleFeatureSimRing" }, "do-not-disturb": { "description": "When enabled this feature will block all inbound ringing and send the call to voicemails if enabled. ", "type": "object", "properties": { "enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" } }, "required": [ "enabled" ] }, "forward-always": { "$ref": "#/components/schemas/AnswerruleFeature" }, "forward-on-active": { "$ref": "#/components/schemas/AnswerruleFeature" }, "forward-on-busy": { "$ref": "#/components/schemas/AnswerruleFeature" }, "forward-no-answer": { "$ref": "#/components/schemas/AnswerruleFeature" }, "forward-when-unregistered": { "$ref": "#/components/schemas/AnswerruleFeature" }, "forward-on-dnd": { "$ref": "#/components/schemas/AnswerruleFeature" }, "forward-on-spam-call": { "$ref": "#/components/schemas/AnswerruleFeature" }, "call-screening": { "description": "When enabled this feature will enable the call screening application asking the caller to record their name before attempting the connection based on other answer rules. ", "type": "object", "properties": { "enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" } }, "required": [ "enabled" ] }, "phone-numbers-to-allow": { "description": "This is a list of numbers that would be allowed bypassing features like do-not-disturb and call-screening.", "$ref": "#/components/schemas/AnswerruleFeatureWithRemove" }, "new-position": { "type": "string", "writeOnly": true, "enum": [ "top", "bottom" ], "examples": [ "top", "bottom" ], "description": "This will move the answerrule to the top or bottom in the priority list. Top having the most priority, and bottom having the least priority" }, "phone-numbers-to-reject": { "description": "This is a list of numbers that would be allowed bypassing features like do-not-disturb and call-screening.", "$ref": "#/components/schemas/AnswerruleFeatureWithRemove" }, "time_range_data": { "type": "array", "items": { "$ref": "#/components/schemas/Timerange" }, "readOnly": true } }, "required": [ "domain", "user", "time-frame", "is-active", "enabled" ] }, "AnswerruleFeature": { "type": "object", "properties": { "enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "parameters": { "type": "array", "items": { "anyOf": [ { "type": "string", "examples": [ "park_1234", "user_5555", "queue_234", "aa_AutoAttendantName", "vmail_5555", "phone_5555" ] }, { "type": "number", "examples": [ 1234, 18005551234 ] } ] }, "description": "This field will provide the values needed to configure the parent feature. These values could be multiple strings or numbers. " } }, "required": [ "enabled" ] }, "AnswerruleFeatureWithRemove": { "type": "object", "properties": { "enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "parameters": { "type": "array", "items": { "anyOf": [ { "type": "string", "examples": [ "park_1234" ] }, { "type": "number", "examples": [ 18005551234 ] } ] }, "description": "This field will provide the values needed to configure the parent feature. These values could be multiple strings or numbers. " } } }, "AnswerruleFeatureSimRing": { "type": "object", "properties": { "enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "parameters": { "type": "array", "items": { "anyOf": [ { "type": "string", "examples": [ "1234wp", "3456;delay=15", "confirm_18005551234;delay=20", "" ] }, { "type": "number", "examples": [ 1234, 18005551234 ] } ] }, "description": "This field will provide the values needed to configure the parent feature. These values could be multiple strings or numbers. " } }, "required": [ "enabled" ] }, "Site": { "type": "object", "properties": { "synchronous": { "$ref": "#/components/schemas/Synchronous" }, "site": { "type": "string" }, "login-username": { "type": "string", "description": "This is the login for the user used to access the portals and other applications. The default will be [user]@[domain] if not set otherwise. This value is required to be unique across the entire system so 409 will be returned if not unique." }, "email": { "type": "string", "description": "This is the email adresses or list of email addresses sepertaed with a semi-colon. ", "format": "email" }, "time-zone": { "$ref": "#/components/schemas/TimeZone" }, "dial-plan": { "type": "string", "description": "This is the dial plan set for the user. Dial plans are used to control action and forward options that will be used when dialing out from the user. " }, "dial-policy": { "type": "string", "description": "This value is the dial policy/permission for this user whch will control the destinations this user can dial. Generally dial policys are preconfigured at system level and selected at user level. " }, "voicemail-user-control-enabled": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "phone-numbers-to-allow-enabled": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "phone-numbers-to-reject-enabled": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "call-screening-enabled": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "language-token": { "type": "string", "description": "This is the language that is set for the user to be used for portal viewing. ", "default": "en_US", "examples": [ "ca_FR", "es_MX", "en_UK" ] }, "limits-max-data-storage-kilobytes": { "type": "integer", "description": "This is the maximum value in kilobytes that is allowed to be stored in the user's voicemail, audio greetings and fax storage. ", "minimum": 0 }, "limits-max-active-calls-total": { "type": "integer", "description": "This is the maximum number of active calls allowed for the user. ", "minimum": 0, "maximum": 3600 }, "directory-announce-in-dial-by-name-enabled": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "voicemail-enabled": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "voicemail-receive-broadcast-enabled": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "reject-anonymous-calls-enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "voicemail-playback-announce-datetime-received": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "voicemail-playback-announce-caller-id": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "voicemail-playback-sort-newest-to-oldest": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "caller-id-number": { "type": "string", "description": "This is the main caller id number for the user to be used for outbound calls outside of the domain. ", "examples": [ "18585551234", "\"[*]\"" ], "format": "phonenumber" }, "caller-id-name": { "type": "string", "description": "This is the main caller id name for the user to be used for outbound calls outside of the domain. " }, "caller-id-number-emergency": { "anyOf": [ { "type": "integer", "title": "", "description": "" }, { "type": "string", "title": "", "description": "" } ], "description": "This is the main caller id that will be used for emergency calls when placed by the user." }, "area-code": { "type": "integer", "description": "This is a area code for the user. I will be used when user dial's 7 digits to translate it to full 10 or 11 digit number. ", "minimum": 100, "maximum": 999 }, "directory-name-visible-in-list-enabled": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "emergency-address-id": { "type": "string", "description": "Value will need to be an exact match to an address-id which links to a address for DLR (dynamic location routing) for emergency calling" }, "music-on-hold-randomized-enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "active-calls-total-current": { "type": "integer", "readOnly": true, "description": "This read only setting is the current active call count for this user. " }, "created-datetime": { "type": "string", "readOnly": true, "format": "date-time", "description": "This datetime is when the user was created. " }, "last-modified-datetime": { "type": "string", "format": "date-time", "readOnly": true, "description": "This datetime is when the user was last modified. " }, "recording-configuration": { "$ref": "#/components/schemas/RecordingConfiguration" } }, "required": [ "site", "email" ] }, "ActiveCall": { "type": "object", "properties": { "core-server": { "type": "string" }, "call-session-id": { "type": "string" }, "call-orig-call-id": { "type": "string" }, "call-orig-match-uri": { "type": "string" }, "call-orig-user": { "type": "string" }, "call-orig-domain": { "type": "string" }, "call-orig-uri": { "type": "string" }, "call-orig-name": { "type": "string" }, "caller-id-number": { "type": "string" }, "call-dialed-number": { "type": "string" }, "call-by-action": { "type": "string" }, "call-by-user": { "type": "string" }, "call-by-domain": { "type": "string" }, "call-by-call-id": { "type": "string" }, "call-term-call-id": { "type": "string" }, "call-term-user": { "type": "string" }, "call-term-domain": { "type": "string" }, "call-term-uri": { "type": "string" }, "call-start-datetime": { "type": "string", "format": "date" }, "call-answer-datetime": { "type": "string" }, "call-orig-info": { "type": "string" }, "term-orig-info": { "type": "string" }, "call-audio-codec": { "type": "string" } }, "required": [ "core-server", "call-session-id", "call-orig-call-id", "call-orig-match-uri", "call-orig-user", "call-orig-domain", "call-orig-uri", "call-orig-name", "caller-id-number", "call-dialed-number", "call-by-action", "call-by-user", "call-by-domain", "call-by-call-id", "call-term-call-id", "call-term-user", "call-term-domain", "call-term-uri", "call-start-datetime", "call-answer-datetime", "call-orig-info", "term-orig-info", "call-audio-codec" ] }, "DialRule": { "type": "object", "properties": { "domain": { "$ref": "#/components/schemas/DomainName" }, "dial-rule-dial-plan": { "type": "string", "description": "This is the dial plan name the dial rule exists in. " }, "dial-rule-matching-to-uri": { "type": "string", "description": "This is the main digit string match for the dial translation. ", "examples": [ "sip:611@*", "sip:1??????????@*" ] }, "dialrule": { "type": "string", "description": "This is the dialrule id that will be given with each read action that will be needed to read back individual value, update specific rules or delete rules. If wanting to programatically generate the dial rule id is a base64 encoding of the concatination with \"||\" of the following fields in order, dail-rule-matching-to-uri, dail-rule-matching-from-uri, dail-rule-matching-day-of-week, dail-rule-matching-start-date, dail-rule-matching-end-date, dail-rule-matching-start-time, dail-rule-matching-end-time" }, "enabled": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "dial-rule-matching-from-uri": { "type": "string", "description": "This is a source match that would allow for a specific dial rule match based on the caller as well as the forward destination of dial-rule-matching-to-uri. ", "default": "*", "examples": [ "sip:????@*", "*" ] }, "dial-rule-matching-day-of-week": { "type": "string", "default": "*", "examples": [ "[1-5]", "1" ], "description": "This is a field that will control the DOW (day of week) match for this rule. Default is * or to match all the time, but valid format will allow any single day of the week 0-6 (sunday-saturday) or a range in square brackets like [0-6]" }, "dial-rule-matching-start-date": { "type": "string", "format": "date", "default": "*", "examples": [ "2023-09-15", "*" ], "description": "This is the start of a the valid date range for this rule. Keep to * if you do not want to use date range for this rule. " }, "dial-rule-matching-end-date": { "type": "string", "format": "date", "examples": [ "2023-09-16", "*" ], "default": "*", "description": "This is the end of a the valid date range for this rule. Keep to * if you do not want to use date range for this rule. " }, "dial-rule-matching-start-time": { "type": "string", "default": "*", "examples": [ "02:00", "*" ], "description": "This is the start of a the valid time range for this rule. Keep to * if you do not want to use time range for this rule. The format is a valid HH:MM format from 00:00 to 23:59. The timezone would be the user's timezone if passing through a user already. " }, "dial-rule-matching-end-time": { "type": "string", "examples": [ "23:59", "*" ], "default": "*", "description": "This is the end of a the valid time range for this rule. Keep to * if you do not want to use time range for this rule. The format is a valid HH:MM format from 00:00 to 23:59. The timezone would be the user's timezone if passing through a user already. " }, "dial-rule-application": { "$ref": "#/components/schemas/DialruleApplication" }, "dial-rule-parameter": { "type": "string", "description": "This is the application parameter field that can be used for additional settings based on the dial-rule-application. Default is empty string. " }, "dial-rule-translation-destination-scheme": { "type": "string", "description": "This setting controls the \"sip schema\" on the destination, in most all case setting to \"[*]\" is correct. ", "enum": [ "[*]", "sip:", "" ], "default": "[*]" }, "dial-rule-translation-destination-user": { "type": "string", "description": "This is the forward destination the call will be sent to in partnership with the application (dial-rule-application) and host (dial-rule-translation-destination-host). This might be a user, queue or offnet number depending on the application. ", "examples": [ "1000", "2500", "18005551234" ] }, "dial-rule-translation-destination-host": { "type": "string", "description": "This is the forward destination host the call will be sent to in partnership with the application (dial-rule-application) and user (dial-rule-translation-destination-user). This might be the domain name or a connection name if trying to route offnet. ", "default": "[*]", "examples": [ "example.com", "" ] }, "dial-rule-translation-source-name": { "type": "string", "description": "This field will allow customization of the source \"name\" often used for the caller id name or the the descriptive quoted value outside of the sip uri. Defaults to [*] but you can add a prefix for example with something like this, sales_[*]", "default": "[*]", "examples": [ "sales_[*]", "[*]", "" ] }, "dial-rule-translation-source-scheme": { "type": "string", "description": "This setting controls the \"sip schema\" on the destination, in most all case setting to \"[*]\" is correct. ", "enum": [ "[*]", "sip:", "" ], "default": "[*]" }, "dial-rule-translation-source-user": { "type": "string", "description": "This field will allow customization of the source \"user\" which is often the caller id number or the value before the @ in then SIP uri. Defaults to [*] but you can modify and include [*] as the previous value. An example would be using a token like to replace with a user's caller id number. ", "default": "[*]", "examples": [ "", "[*]" ] }, "dial-rule-translation-source-host": { "type": "string", "description": "This field will allow customization of the source \"host\" which is the value after the @ in then SIP uri. Defaults to [*] but you can modify and include [*] as the previous value. An example would be using a token like to replace with a user's domain", "default": "[*]", "examples": [ "", "[*]" ] }, "dial-rule-description": { "type": "string", "description": "This is a description of the number/rule that can be used for defintion or tracking purposes. " } }, "required": [ "domain", "dialrule", "dial-rule-matching-to-uri", "dial-rule-dial-plan", "dial-rule-translation-destination-user" ] }, "Phonenumber": { "type": "object", "properties": { "phonenumber": { "type": "string", "description": "This is the main phonenumber setting. Should be a formated in a e164 format with country count and number. US domestic numbers should be similiar to 18005551234", "examples": [ "18005551234" ] }, "enabled": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "domain": { "$ref": "#/components/schemas/DomainName" }, "dial-rule-application": { "$ref": "#/components/schemas/DialruleApplication" }, "dial-rule-parameter": { "type": "string", "description": "This is the application parameter field that can be used for additional settings based on the dial-rule-application. Default is empty string. " }, "dial-rule-translation-destination-user": { "type": "string", "description": "This is the forward destination the call will be sent to in partnership with the application (dial-rule-application) and host (dial-rule-translation-destination-host). This might be a user, queue or offnet number depending on the application. ", "examples": [ "1000", "2500", "18005551234" ] }, "dial-rule-translation-destination-host": { "type": "string", "description": "This is the forward destination host the call will be sent to in partnership with the application (dial-rule-application) and user (dial-rule-translation-destination-user). This might be the domain name or a connection name if trying to route offnet. ", "default": "[*]", "examples": [ "example.com", "" ] }, "dial-rule-translation-source-name": { "type": "string", "description": "This field will allow customization of the source \"name\" often used for the caller id name or the the descriptive quoted value outside of the sip uri. Defaults to [*] but you can add a prefix for example with something like this, sales_[*]", "default": "[*]", "examples": [ "sales_[*]", "[*]", "" ] }, "dial-rule-description": { "type": "string", "description": "This is a description of the number/rule that can be used for defintion or tracking purposes. " } }, "required": [ "phonenumber", "domain", "dial-rule-translation-destination-user" ] }, "Contact": { "type": "object", "properties": { "unique-id": { "type": "string", "description": "This is a unique id that will be generated automatically on new contact create. " }, "name-first-name": { "type": "string" }, "name-middle-name": { "type": "string" }, "name-last-name": { "type": "string" }, "email": { "type": "string" }, "company": { "type": "string" }, "phonenumber-work": { "type": "string" }, "phonenumber-cell": { "type": "string" }, "phonenumber-fax": { "type": "string" }, "phonenumber-home": { "type": "string" }, "tags": { "type": "string" }, "created-datetime": { "type": "string" } }, "required": [ "company", "phonenumber-work", "email", "tags", "name-last-name", "name-first-name", "name-middle-name", "phonenumber-cell", "phonenumber-fax", "phonenumber-home", "created-datetime", "unique-id" ] }, "Timerange": { "type": "object", "properties": { "ordinal-order": { "type": "integer", "description": "This will be a unique index and orger for the specific timerange inside of the given timeframe. " }, "start-date": { "type": "string", "description": "This is field will be set for the start of a calender based time range in the format of YYYY-MM-DD. To disable the start of a range use \"now\". ", "format": "date", "examples": [ "2023-08-20", "now" ] }, "end-date": { "type": "string", "description": "This is field will be set for the end of a calender based time range in the format of YYYY-MM-DD. To disable the start of a range use \"never\". ", "format": "date", "examples": [ "2023-09-15", "never" ] }, "day-of-week-number": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 6, "description": "Integer can be used 0-6 for day in week. " }, { "type": "string", "default": "*", "examples": [ "*" ], "description": "String of * can be used for all days." } ], "description": "This is field will be set for a specific day of the week ( 0-6 / Sunday - Saturday) for this given time range. * would be used for all days of the week. " }, "start-time": { "type": "string", "format": "time", "default": "00:00", "examples": [ "00:00", "10:00" ], "description": "This is the time in HH:MM format for the given time range. This will be the start of the window and will be based on the user's time-zone. " }, "end-time": { "type": "string", "format": "time", "default": "23:59", "examples": [ "23:59", "12:59" ], "description": "This is the time in HH:MM format for the given time range. This will be the end of the window and will be based on the user's time-zone. " }, "invert-match": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" } }, "required": [ "day-of-week-number" ] }, "Address": { "type": "object", "properties": { "emergency-address-id": { "type": "string", "description": "This is an autogenerated ID for the Address." }, "domain": { "$ref": "#/components/schemas/DomainName" }, "user": { "$ref": "#/components/schemas/UserName" }, "address-name": { "type": "string", "description": "This is the name label for the address" }, "caller-name": { "type": "string", "description": "This is the caller's name for the address" }, "address-line-1": { "type": "string", "description": "This is the address line 1 for the address" }, "address-line-2": { "type": [ "string", "null" ], "description": "This is the address line 2 for the address" }, "address-city": { "type": "string", "description": "This is the city for the address" }, "address-state-province-abbreviation": { "type": "string", "description": "This is the state or province (Canadian) abbreviation for the address" }, "address-postal-code": { "type": "string", "description": "This is the postal code for the address" }, "address-country-abbreviation": { "type": "string", "description": "This is the country appreviation for the address" }, "address-location-description": { "type": [ "string", "null" ], "description": "This is an optional location description for the address" }, "ip-address-public": { "type": [ "string", "null" ], "description": "This is the public IP of the client window creating the address." }, "address-formatted-pidflo": { "type": "string", "description": "This is a return value of the formatted PIDFLO standardized value for the address" }, "carrier": { "type": [ "string", "null" ], "description": "This is the carrier name for the address" }, "count-users-configured": { "type": [ "integer", "null" ], "description": "This is the count of how many users are using the particular address", "readOnly": true }, "address-formatted-pretty": { "type": [ "string", "null" ], "description": "This is a human readable format of the address", "readOnly": true }, "address-is-default-for-site": { "type": [ "boolean", "null" ], "description": "This is whether the address is a default for the site", "readOnly": true } }, "required": [ "emergency-address-id", "domain", "user", "address-name", "caller-name", "address-line-1", "address-city", "address-state-province-abbreviation", "address-postal-code", "address-country-abbreviation", "address-formatted-pidflo" ] }, "AddressCreateReturn": { "type": "object", "properties": { "address-formatted-pidflo": { "type": "object", "properties": {} }, "object": { "type": "string" }, "domain": { "type": "string" }, "user": { "type": "string" }, "address_id": { "type": "string" }, "address_name": { "type": "string" }, "callid_nmbr": { "type": "string" }, "address_line_1": { "type": "string" }, "address_line_2": { "type": "string" }, "city": { "type": "string" }, "state_code": { "type": "string" }, "zip": { "type": "string" }, "country_code": { "type": "string" }, "location": { "type": "string" }, "carrier": { "type": "string" }, "public_ip": { "type": "string" }, "action": { "type": "string" }, "singular": { "type": "integer" }, "controller": { "type": "string" }, "format": { "type": "string" }, "apiVer": { "type": "string" } }, "required": [ "address-formatted-pidflo", "object", "domain", "singular", "address_id", "address_name", "callid_nmbr", "address_line_1", "address_line_2", "city", "state_code", "zip", "country_code", "location", "carrier", "public_ip", "action", "controller", "format", "apiVer", "user" ] }, "ApiKey": { "type": "object", "properties": { "description": { "type": "string", "minLength": 12, "examples": [ "Used by Vendor Xyz for Billing Automation" ], "description": "This is the main description/name for the API key that should describe its purpose for tracking and understanding its intended use. " }, "key-id": { "type": "string", "minLength": 12, "maxLength": 12, "examples": [ "nsd-123dsa23" ], "description": "This is the Key ID that will identify the key and allow for managment, audit tracking and monitoring. " }, "key": { "type": "string", "readOnly": true, "description": "This is the key that will need to be saved securly for use in accessing the API. It will only be shown once. " }, "reseller": { "type": "string", "default": "*", "description": "This is the reseller that will limit the API key to access the resellers data set. " }, "user": { "$ref": "#/components/schemas/UserName" }, "domain": { "$ref": "#/components/schemas/DomainName" }, "user-scope": { "type": "string", "description": "This is the scope that will be be used to enforce permissions for this API key and access. ", "enum": [ "Basic User", "Simple User", "Advanced User", "Call Center Agent", "Call Center Supervisor", "Office Manager" ] }, "ip-address": { "type": "string", "examples": [ "1.2.3.4,5.6.7.0/24" ], "description": "Optional IP restrictions for API to require access from matching IP or subnets. Multipe ips/subnets can be provided comma seperated" }, "readonly": { "type": "string", "enum": [ "yes", "no" ], "default": "no", "description": "If enabled it will limit any get Scope to a read only verion providing only GET acces to the read actions. POST, PUT and DELETE will be rejected. " }, "can-create-keys": { "type": "string", "enum": [ "yes", "no" ], "default": "no", "description": "If enabled it will allow this key to make keys for lesser scopes then itself. It will not allow creations of scopes same or higher access level. " }, "allowed-models": { "anyOf": [ { "type": "string", "description": "A string with a specific model or \"*\" for all. " }, { "type": "array", "items": { "type": "string", "description": "A string with a specific model or \"*\" for all. The specific models reference the API's scope defintions stored in the DB. ", "enum": [ "agentlog", "account", "address", "agent", "answerrule", "apikey", "attendant", "attendee", "audio", "call", "callidemgr", "callqueue", "callqueuereport", "callrequest", "cdr", "cdr2", "cdrschedule", "chart", "conference", "conferencecdr", "contact", "conversation", "dashboard", "department", "device", "deviceprofile", "dialrule", "disposition", "domain", "email", "event", "fax", "mac", "meeting", "message", "messagesession", "mfa", "moh", "participant", "phaxio", "phoneconfiguration", "phonenumber", "presence", "push", "recording", "sfu", "site", "smsnumber", "speechcommand", "sso", "statistics", "subscriber", "subscriberani", "timeframe", "timerange", "turn", "uiconfig", "upload", "vmailnag", "voice", "voicemail", "queued", "callqueueemailreport", "callqueuestat", "cdrexport", "connection", "devicedefault", "dialplan", "dialpolicy", "licf_lea", "oauth", "permission", "quota", "quotaUsage", "recordingstorage", "trace", "auditlog", "auditlog_lite", "elementdomain", "*" ] }, "description": "An array of models. " } ], "description": "This is an optional limitation to the ability of this apikey. The default is * or all models, but can be set to a specific model or array of models allowing specific access. The \"models\" are linked to objects as defined in the scope definition and might have varies terminolofy from the api itself. " }, "created-datetime": { "type": "string", "format": "date-time", "readOnly": true, "description": "The datetime that the key was created. " }, "lastused-datetime": { "type": [ "string", "null" ], "format": "date-time", "readOnly": true, "description": "The datetime of the last time the apikey was used for API access. The timestamp is acurrate up to the hour to avoid overhead in tracking high volume requests" } }, "required": [ "description", "key-id", "reseller", "domain" ] }, "Audiofile": { "type": "object", "properties": { "filename": { "type": "string", "description": "This is the filename without and path or folder. Should end in .wav" }, "ordinal-order": { "type": "integer", "description": "This is the index of the audio file. " }, "file-duration-seconds": { "type": "integer", "description": "This value is the length of the file in seconds. " }, "file-size-kilobytes": { "type": "string", "description": "This value will be a formated filesize of the file in kilobytes" }, "created-datetime": { "type": "string", "description": "This is the timestamp of create time fo the file" }, "file-access-url": { "type": "string", "description": "This will be URL of the file for remote playback. " }, "file-script-text": { "type": "string", "description": "This is the script that was used for text to speech and also used to create a new file. " }, "file-source": { "type": "string", "description": "This is the source of the file, it will show how the file was created originally. " }, "text-to-speech-voice-id": { "type": "string", "description": "This is the voice id used when using text to speech. ", "default": "en-US-Wavenet-C" }, "text-to-speech-language": { "type": "string", "description": "This is the voice language when using TTS. ", "default": "en_US" }, "FromName": { "type": "string" }, "FromUser": { "type": "string" }, "FromHost": { "type": "string" }, "NmsAni": { "type": "string" }, "recorded-datetime": { "type": "string", "description": "This is the timestamp of record time fo the file" }, "NmsRecStartTime": { "type": "string" }, "NmsRecDuration": { "type": "string" }, "TimeZone": { "type": "string" }, "transcription": { "type": "string" } } }, "CdrD": { "type": "object", "properties": { "id": { "type": "string" }, "domain": { "type": "string" }, "reseller": { "type": "string" }, "call-account-code": { "type": [ "string", "null" ] }, "call-answer-datetime": { "type": "string" }, "call-audio-codec": { "type": "string" }, "call-audio-relay-side-a-local-port": { "type": "integer" }, "call-audio-relay-side-a-packet-count": { "type": "integer" }, "call-audio-relay-side-a-remote-ip": { "type": "string" }, "call-audio-relay-side-b-packet-count": { "type": "integer" }, "call-audio-relay-side-b-remote-ip": { "type": "string" }, "call-batch-answer-datetime": { "type": "string" }, "call-batch-on-hold-duration-seconds": { "type": "integer" }, "call-batch-sequence-marker": { "type": "string" }, "call-batch-start-datetime": { "type": "string" }, "call-batch-total-duration-seconds": { "type": "integer" }, "call-direction": { "type": "integer" }, "call-disconnect-datetime": { "type": "string" }, "call-disconnect-reason-text": { "type": "string" }, "call-disposition": { "type": "null" }, "call-disposition-notes": { "type": "null" }, "call-disposition-reason": { "type": "null" }, "call-disposition-submitted-datetime": { "type": "null" }, "call-disposition-type": { "type": "null" }, "call-fax-codec": { "type": "null" }, "call-fax-relay-side-a-local-port": { "type": "null" }, "call-fax-relay-side-a-packet-count": { "type": "null" }, "call-fax-relay-side-a-remote-ip": { "type": "null" }, "call-fax-relay-side-b-packet-count": { "type": "null" }, "call-fax-relay-side-b-remote-ip": { "type": "null" }, "call-intelligence-job-id": { "type": "string" }, "call-intelligence-percent-negative": { "type": "string" }, "call-intelligence-percent-neutral": { "type": "string" }, "call-intelligence-percent-positive": { "type": "string" }, "call-intelligence-topics-top": { "type": "string" }, "call-leg-ordinal-index": { "type": "integer" }, "call-on-hold-duration-seconds": { "type": "integer" }, "call-orig-call-id": { "type": "string" }, "call-orig-caller-id": { "type": "integer" }, "call-orig-department": { "type": "string" }, "call-orig-domain": { "type": "string" }, "call-orig-from-host": { "type": "string" }, "call-orig-from-name": { "type": "string" }, "call-orig-from-uri": { "type": "string" }, "call-orig-from-user": { "type": "string" }, "call-orig-ip-address": { "type": "string" }, "call-orig-match-uri": { "type": "string" }, "call-orig-pre-routing-uri": { "type": "string" }, "call-orig-request-host": { "type": "string" }, "call-orig-request-uri": { "type": "string" }, "call-orig-request-user": { "type": "string" }, "call-orig-reseller": { "type": "string" }, "call-orig-site": { "type": "string" }, "call-orig-to-host": { "type": "string" }, "call-orig-to-uri": { "type": "string" }, "call-orig-to-user": { "type": "string" }, "call-orig-user": { "type": "integer" }, "call-parent-call-id": { "type": "string" }, "call-parent-cdr-id": { "type": "string" }, "call-record-creation-datetime": { "type": "null" }, "call-ringing-datetime": { "type": "null" }, "call-routing-class": { "type": "integer" }, "call-routing-match-uri": { "type": "string" }, "call-start-datetime": { "type": "string" }, "call-tag": { "type": "string" }, "call-talking-duration-seconds": { "type": "integer" }, "call-term-call-id": { "type": "string" }, "call-term-caller-id": { "type": "string" }, "call-term-department": { "type": "null" }, "call-term-domain": { "type": "string" }, "call-term-ip-address": { "type": "string" }, "call-term-match-uri": { "type": "string" }, "call-term-pre-reouting-uri": { "type": "string" }, "call-term-reseller": { "type": "null" }, "call-term-site": { "type": "null" }, "call-term-to-uri": { "type": "string" }, "call-term-user": { "type": "null" }, "call-through-action": { "type": "string" }, "call-through-call-id": { "type": "null" }, "call-through-caller-id": { "type": "null" }, "call-through-department": { "type": "null" }, "call-through-domain": { "type": "null" }, "call-through-reseller": { "type": "null" }, "call-through-site": { "type": "null" }, "call-through-uri": { "type": "null" }, "call-through-user": { "type": "null" }, "call-total-duration-seconds": { "type": "integer" }, "call-video-codec": { "type": "null" }, "call-video-relay-side-a-local-port": { "type": "null" }, "call-video-relay-side-a-packet-count": { "type": "null" }, "call-video-relay-side-a-remote-ip": { "type": "null" }, "call-video-relay-side-b-packet-count": { "type": "null" }, "call-video-relay-side-b-remote-ip": { "type": "null" }, "call-server-mac-address": { "type": "string" }, "core-server": { "type": "string" }, "hide-from-results": { "type": "integer" }, "is-trace-expected": { "type": "boolean" }, "prefilled-trace-api": { "type": "string" }, "prefilled-transcription-api": { "type": "string" } }, "required": [ "id", "domain", "reseller", "call-account-code", "call-answer-datetime", "call-audio-codec", "call-audio-relay-side-a-local-port", "call-audio-relay-side-a-packet-count", "call-audio-relay-side-a-remote-ip", "call-audio-relay-side-b-packet-count", "call-audio-relay-side-b-remote-ip", "call-batch-answer-datetime", "call-batch-on-hold-duration-seconds", "call-batch-sequence-marker", "call-batch-start-datetime", "call-batch-total-duration-seconds", "call-direction", "call-disconnect-datetime", "call-disconnect-reason-text", "call-disposition", "call-disposition-notes", "call-disposition-reason", "call-disposition-submitted-datetime", "call-disposition-type", "call-fax-codec", "call-fax-relay-side-a-local-port", "call-fax-relay-side-a-packet-count", "call-fax-relay-side-a-remote-ip", "call-fax-relay-side-b-packet-count", "call-fax-relay-side-b-remote-ip", "call-leg-ordinal-index", "call-on-hold-duration-seconds", "call-orig-call-id", "call-orig-caller-id", "call-orig-department", "call-orig-domain", "call-orig-from-host", "call-orig-from-name", "call-orig-from-uri", "call-orig-from-user", "call-orig-ip-address", "call-orig-match-uri", "call-orig-pre-routing-uri", "call-orig-request-host", "call-orig-request-uri", "call-orig-request-user", "call-orig-reseller", "call-orig-site", "call-orig-to-host", "call-orig-to-uri", "call-orig-to-user", "call-orig-user", "call-parent-call-id", "call-parent-cdr-id", "call-record-creation-datetime", "call-ringing-datetime", "call-routing-class", "call-routing-match-uri", "call-start-datetime", "call-tag", "call-talking-duration-seconds", "call-term-call-id", "call-term-caller-id", "call-term-department", "call-term-domain", "call-term-ip-address", "call-term-match-uri", "call-term-pre-reouting-uri", "call-term-reseller", "call-term-site", "call-term-to-uri", "call-term-user", "call-through-action", "call-through-call-id", "call-through-caller-id", "call-through-department", "call-through-domain", "call-through-reseller", "call-through-site", "call-through-uri", "call-through-user", "call-total-duration-seconds", "call-video-codec", "call-video-relay-side-a-local-port", "call-video-relay-side-a-packet-count", "call-video-relay-side-a-remote-ip", "call-video-relay-side-b-packet-count", "call-video-relay-side-b-remote-ip", "call-server-mac-address", "core-server", "hide-from-results", "is-trace-expected", "prefilled-trace-api", "prefilled-transcription-api", "call-intelligence-topics-top", "call-intelligence-percent-positive", "call-intelligence-percent-neutral", "call-intelligence-percent-negative", "call-intelligence-job-id" ] }, "CdrU": { "type": "object", "properties": { "uid": { "type": "string" }, "domain": { "type": "string" }, "cdr_id": { "type": "string" }, "type": { "type": "integer" }, "time_start": { "type": "integer" }, "time_answer": { "type": "integer" }, "time_release": { "type": "integer" }, "duration": { "type": "integer" }, "orig_to_uri": { "type": "string" }, "number": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] }, "onnet": { "type": "integer" }, "hide": { "type": "integer" }, "tag": { "type": "string" }, "expected_trace": { "type": "boolean" } }, "required": [ "uid", "domain", "cdr_id", "type", "time_start", "time_answer", "time_release", "duration", "orig_to_uri", "number", "name", "onnet", "hide", "tag", "expected_trace" ] }, "NdpPhone": { "type": "object", "properties": { "device-provisioning-mac-address": { "type": "string", "maxLength": 12, "minLength": 12, "format": "mac", "examples": [ "000011223344" ] }, "domain": { "$ref": "#/components/schemas/DomainName" }, "reseller": { "type": "string" }, "device-models-brand-and-model": { "type": "string" }, "device-provisioning-registration-core-server": { "type": "string" }, "notes": { "type": "string" }, "device-provisioning-sip-uri-1": { "type": "string" }, "device-provisioning-line-1-enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "device-provisioning-sip-uri-1-shared-line-enabled": { "type": "string" }, "device-provisioning-sip-uri-2": { "type": "string" }, "device-provisioning-line-2-enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "device-provisioning-sip-uri-2-shared-line-enabled": { "type": "string" }, "device-provisioning-sip-transport-protocol": { "type": "string" }, "device-provisioning-username": { "type": "string" }, "device-provisioning-password": { "type": "string", "format": "password" }, "device-models-count-buttons": { "type": "integer" }, "device-models-fxs-support-enabled": { "type": "integer" }, "device-models-overrides-blob": { "type": "string" }, "device-models-resync-support-enabled": { "type": "string" }, "device-models-shared-line-support-enabled": { "type": "string" }, "device-models-sidecar-support-enabled": { "type": "string" }, "device-provisioning-last-retrieved-datetime": { "type": "string" }, "device-provisioning-directory": { "type": "string" }, "device-provisioning-directory-support": { "type": "string" }, "device-provisioning-line-1-extensions": { "type": "string", "readOnly": true }, "device-provisioning-line-2-extensions": { "type": "string", "readOnly": true }, "device-provisioning-ndp-hostname": { "type": "string" }, "device-provisioning-presence": { "type": "string" }, "created-datetime": { "type": "string" }, "global-one-time-pass": { "type": "string" }, "last-modified-datetime": { "type": "string", "format": "date-time", "readOnly": true }, "redundency": { "type": "string" }, "device-provisioning-sip-uri-3": { "type": "string" }, "device-provisioning-line-3-enabled": { "type": "string" }, "device-provisioning-sip-uri-3-shared-line-enabled": { "type": "string" }, "device-provisioning-sip-uri-4": { "type": "string" }, "device-provisioning-line-4-enabled": { "type": "string" }, "device-provisioning-sip-uri-4-shared-line-enabled": { "type": "string" }, "device-provisioning-sip-uri-5": { "type": "string" }, "device-provisioning-line-5-enabled": { "type": "string" }, "device-provisioning-sip-uri-5-shared-line-enabled": { "type": "string" }, "device-provisioning-sip-uri-6": { "type": "string" }, "device-provisioning-line-6-enabled": { "type": "string" }, "device-provisioning-sip-uri-6-shared-line-enabled": { "type": "string" }, "device-provisioning-sip-uri-7": { "type": "string" }, "device-provisioning-line-7-enabled": { "type": "string" }, "device-provisioning-sip-uri-7-shared-line-enabled": { "type": "string" }, "device-provisioning-sip-uri-8": { "type": "string" }, "device-provisioning-line-8-enabled": { "type": "string" }, "device-provisioning-sip-uri-8-shared-line-enabled": { "type": "string" }, "device-sip-registration-contact": { "type": "string", "readOnly": true }, "device-sip-registration-datetime": { "type": "string", "readOnly": true }, "device-sip-registration-expires-datetime": { "type": "string", "readOnly": true }, "device-sip-registration-state": { "type": [ "string", "null" ], "readOnly": true }, "device-sip-registration-user-agent": { "type": "string", "readOnly": true } }, "required": [ "device-provisioning-mac-address", "domain", "reseller", "device-models-brand-and-model", "device-provisioning-registration-core-server", "notes", "device-provisioning-sip-uri-1", "device-provisioning-line-1-enabled", "device-provisioning-sip-uri-1-shared-line-enabled", "device-provisioning-sip-uri-2", "device-provisioning-line-2-enabled", "device-provisioning-sip-uri-2-shared-line-enabled", "device-provisioning-sip-transport-protocol", "device-provisioning-username", "device-provisioning-password", "device-models-count-buttons", "device-models-fxs-support-enabled", "device-models-overrides-blob", "device-models-resync-support-enabled", "device-models-shared-line-support-enabled", "device-models-sidecar-support-enabled", "device-provisioning-last-retrieved-datetime", "device-provisioning-directory", "device-provisioning-directory-support", "device-provisioning-ndp-hostname", "device-provisioning-presence", "created-datetime", "global-one-time-pass", "redundency" ] }, "NdpModel": { "type": "object", "properties": { "brand": { "type": "string" }, "model": { "type": "string" }, "portal_view": { "type": "string" }, "device_type": { "type": "string" }, "ndp_syntax": { "type": "string" }, "brand_model": { "type": "string" }, "force_https": { "type": "string" }, "allow_tftp": { "type": "string" }, "phone_ext": { "type": "integer" }, "fxs": { "type": "integer" }, "fxo": { "type": "integer" }, "trunk": { "type": "integer" }, "directory": { "type": "string" }, "presense": { "type": "string" }, "sla": { "type": "string" }, "sidecar": { "type": "string" }, "resync": { "type": "string" }, "encrypt_support": { "type": "string" }, "firmware_support": { "type": "string" }, "firmware_options": { "type": "string" }, "overrides": { "type": "string" }, "description": { "type": "string" } }, "required": [ "brand", "model", "device_type", "ndp_syntax", "portal_view", "brand_model" ] }, "NdpServer": { "type": "object", "properties": { "name": { "type": "string" }, "location": { "type": "string" }, "geo_group": { "type": "string" }, "port_tcp": { "type": "integer" }, "port_tls": { "type": "integer" }, "backup_ok": { "type": "string" }, "postfix": { "type": "string" }, "ns_api_hostname": { "type": "string" }, "status": { "type": "string" } }, "required": [ "name", "location", "geo_group", "port_tcp", "port_tls", "backup_ok", "postfix", "ns_api_hostname", "status" ] }, "Messagesession": { "type": "object", "properties": { "user": { "$ref": "#/components/schemas/UserName" }, "domain": { "$ref": "#/components/schemas/DomainName" }, "messagesession-remote": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ], "description": "This is the UserID (ie, 1234@portal) or the phonenumber of the recipient(s) of the messages. If more than one, will be comma seperated" }, "messagesession-muted": { "type": "string", "description": "This is whether or not the message session is muted or not. \"yes\" or \"no\"" }, "messagesession-id": { "type": "string", "description": "This is the identifier for the session" }, "messagesession-sms-number": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "null" } ], "description": "This is the SMS number used to send outbound. Will be null if not an SMS message session" }, "messagesession-last-datetime": { "type": [ "string", "null" ], "description": "This is the last time the session had an inbound or outbound message" }, "messagesession-start-datetime": { "type": [ "string", "null" ], "description": "This is the when the message session started" }, "messagesession-last-message": { "anyOf": [ { "type": "string", "readOnly": true }, { "type": "integer", "readOnly": true }, { "type": "null" } ], "description": "This is the last message in the messagesession" }, "messagesession-last-sender": { "type": [ "string", "null" ], "description": "This shows the UID or the phonenumber of who was the last message sender", "readOnly": true }, "messagesession-last-status": { "type": [ "string", "null" ], "description": "This is the last status of the messagesession. Will contain read/unread status", "readOnly": true }, "messagesession-last-email-reminder-datetime": { "type": [ "string", "null" ], "description": "This is when the last email reminder was sent out notifiying the user of a missed message", "readOnly": true }, "messagesession-reciever-hostname": { "type": "string", "description": "This is the hostname of the last received message", "readOnly": true }, "messagesession-queue-termination": { "type": [ "string", "null" ], "description": "This is which SMS queue the messagesession is assigned to", "readOnly": true }, "messagesession-queue-status": { "type": [ "string", "null" ], "description": "This is the queue status of the messagesession", "readOnly": true }, "messagesession-queue-session-id": { "type": [ "string", "null" ], "description": "This is the queue session id placed on the messagesession", "readOnly": true }, "messagesession-agent-start-datetime": { "type": [ "string", "null" ], "description": "This is when the messagesession was started by the agent", "readOnly": true }, "messagesession-last-type": { "description": "This is the last message type of the messagesession", "anyOf": [ { "$ref": "#/components/schemas/MessageType" }, { "type": "null" } ] }, "messagesession-last-media-type": { "type": [ "string", "null" ], "description": "This is the last media type of the messagesession" }, "messagesession-last-media-size": { "type": [ "integer", "null" ], "description": "This is the size of the last media of the messagesession" }, "messagesession-type": { "type": "string", "description": "This is the type of messagesession" }, "messagesession-name": { "type": [ "string", "null" ], "description": "This is the name of the messagesession. Names can be assigned to group chats" }, "messagesession-participants": { "type": [ "string", "null" ], "description": "This is a comma seperated list of participants within a group chat or group sms messagesession" } }, "required": [ "user", "domain", "messagesession-remote", "messagesession-muted", "messagesession-id", "messagesession-sms-number", "messagesession-last-datetime", "messagesession-start-datetime", "messagesession-last-message", "messagesession-last-sender", "messagesession-last-status", "messagesession-last-email-reminder-datetime", "messagesession-reciever-hostname", "messagesession-queue-termination", "messagesession-queue-status", "messagesession-queue-session-id", "messagesession-agent-start-datetime", "messagesession-last-type", "messagesession-last-media-type", "messagesession-last-media-size", "messagesession-type" ] }, "Message": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "readOnly": true }, { "type": "integer", "readOnly": true } ], "description": "This is the ID of the message" }, "timestamp": { "description": "This is when the message was recieved or sent", "$ref": "#/components/schemas/Timestamp" }, "type": { "$ref": "#/components/schemas/MessageType" }, "domain": { "$ref": "#/components/schemas/DomainName" }, "direction": { "type": "string", "description": "This is the direction of the message. Either term for outbound or orig for inbound", "examples": [ "term", "orig" ] }, "from-number": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ], "description": "This is the SMS number the message came from. Is not set for chat messages" }, "from-user-id": { "type": [ "string", "null" ], "description": "This is the User ID the message came from. Not set for offnet numbers" }, "from-video-attendee-id": { "type": [ "string", "null" ], "description": "This is the video attendee id the message came from if sent within a video call" }, "from-user-agent": { "type": [ "string", "null" ], "description": "This is the HTTP USER AGENT the message came from" }, "dialed": { "type": [ "string", "null" ], "description": "This is the number that this message is sent to. This can be comma seperated list of numbers if more than one in a group MMS session. Or null for chat sessions" }, "text": { "type": [ "string", "integer", "boolean", "array", "object", "number", "null" ], "description": "This is the text sent in the message" }, "terminating-user-id": { "type": [ "string", "null" ], "description": "This is the receiving User ID of the message" }, "terminating-number": { "type": [ "string", "null" ], "description": "This is the number that this message is sent to. This can be comma seperated list of numbers if more than one in a group MMS session. Or null for chat sessions" }, "status": { "type": "string", "description": "This is the status of the message" }, "video-instance-id": { "type": [ "string", "null" ], "description": "This is the video instance ID of the message if the message was sent from a video session." }, "media-type": { "type": [ "string", "null" ], "description": "This is the media type of the message if applicable" }, "media-size": { "type": [ "integer", "null" ], "description": "This is the media size of the message if applicable" }, "deleted-datetime": { "description": "This is the deleted timestamp of the message if the message was deleted by a host in a video meeting", "anyOf": [ { "description": "This is when the message was recieved or sent", "$ref": "#/components/schemas/Timestamp" }, { "type": "null" } ] }, "messagesession-reciever-hostname": { "type": "string", "description": "This is the receiver hostname for the message" }, "messagesession-id": { "type": "string", "description": "This is the messagesession ID for this message" }, "messagesession-participants": { "type": [ "string", "null" ], "description": "This is the comma seperated participants of the messagesession associated with this message" } }, "required": [ "id", "timestamp", "type", "domain", "direction", "from-user-id", "from-video-attendee-id", "from-user-agent", "dialed", "text", "terminating-user-id", "terminating-number", "status", "media-type", "media-size", "messagesession-reciever-hostname", "messagesession-id", "messagesession-participants" ] }, "SmsNumber": { "type": "object", "properties": { "number": { "type": "string", "description": "This is the SMS Number" }, "application": { "type": "string", "description": "This is the application of the number. Can be for a user, callqueue, or available", "examples": [ "user", "callqueue", "available" ] }, "domain": { "$ref": "#/components/schemas/DomainName" }, "carrier": { "type": "string", "description": "This is the carrier the SMS number will send and receive messages through" }, "dest": { "type": "string", "description": "This is the destination for the SMS number if assigned. Can be a user or a call queue", "examples": [ "1123", "2500" ] }, "mms-capable": { "type": "boolean", "description": "This is whether or not the SMS number can send MMS messages", "default": "false" }, "group-mms-capable": { "type": "boolean", "description": "This is whether or not the SMS number can send group messages", "default": "false" } }, "required": [ "number", "application", "domain", "dest" ] }, "Vmailnag": { "type": "object", "properties": { "domain": { "$ref": "#/components/schemas/DomainName" }, "user": { "$ref": "#/components/schemas/UserName" }, "voicemail-reminder-phonecall-enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "voicemail-reminder-phonecall-phonenumber-array": { "type": "array", "items": { "type": "integer", "examples": [ 8585551234, 6195551234 ] }, "description": "Phone reminder numbers" }, "voicemail-reminder-sms-enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "voicemail-reminder-sms-phonenumber-array": { "type": "array", "items": { "type": "integer", "examples": [ 8585551234, 6195551234 ] }, "description": "SMS reminder numbers" }, "voicemail-reminder-email-enabled": { "description": "This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings. ", "$ref": "#/components/schemas/YesNoStringNoDefault" }, "voicemail-reminder-email-address-array": { "type": "array", "items": { "type": "string", "examples": [ "test@email.com", "abc@def.ghi" ] }, "description": "Email reminder addresses" }, "voicemail-reminder-interval-minutes": { "type": "integer", "description": "Interval of reminders (minutes)" }, "voicemail-reminder-last-sent": { "type": "integer", "description": "Timestamp of last sent reminder", "readOnly": true }, "voicemail-reminder-control-server": { "type": "string", "description": "Current server managing the reminders for the user", "readOnly": true } } }, "Subscription": { "type": "object", "properties": { "id": { "type": "string", "description": "This is the main subscription id. This will be needed to edit and delete the subscription. " }, "model": { "type": "string", "description": "This is the type of data that will be sent. you will need to reqest multiple subscriptions if you want more than one model.", "enum": [ "agent", "auditlog", "auditlog_lite", "call", "call_origid", "cdr", "message", "messagesession", "subscriber", "presence", "voicemail" ] }, "post-url": { "type": "string", "description": "This is the url the API will be posting data to. Should be in the format including https://. Can make a custom port if needed and the URL should have a valid SSL certificate as well. Http:// is supproted but not ideal for production. ", "examples": [ "https://webhook.example.com/event" ], "format": "url" }, "subscription-geo-support": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "user-scope": { "$ref": "#/components/schemas/Scopes" }, "reseller": { "type": "string", "description": "This is the reseller that the subscription will filter data for. * will be used for all resellers, but only valid with Super User scope on the request. " }, "domain": { "type": "string", "description": "This is the domain that the subscription will filter data for. \"*\" will be used for all domains, but only valid with Super User scope", "default": "*" }, "user": { "type": "string", "description": "This is the user that the subscription will filter data for. * will be used for all users.", "default": "*" }, "subscription-creation-datetime": { "type": "string", "description": "This is a timestamp of creation of the event subscrtipion. ", "format": "date-time" }, "subscription-expires-datetime": { "type": "string", "description": "This timestamp in the format of YYYY-MM-DD HH:MM:SS will be with the subscription will expire. After it expires it will be removed after some amount of time. If left blank it will set the expires time to the expires time of the timed token used, if using a APIkey it will be 20 years from the creation date that it will set for the expires for the new subscription", "format": "date-time" }, "preferred-server": { "type": "string", "description": "This is the server hostname for the prefered server for this subscription, meaning if this server is up and online it will be the one sending the events. It wil fail back to this servre after 60s of stability. ", "format": "hostname", "examples": [ "core1.example.com" ] }, "current-active-server": { "type": "string", "description": "This is the current server that is running this schedule. It will chagne only when a new server takes over and is a read only field. ", "format": "hostname", "examples": [ "core1.exmaple.com" ], "readOnly": true }, "status": { "type": "string", "description": "This is the status of the schedule. A new schedule will get \"pending\" till it gets some data to send and once successfull it will go to \"active\". If any attempts get a error over a interval it will toggle this field to \"error\" and reset only once it gets a clean interval of posts. ", "enum": [ "pending", "active", "error" ], "readOnly": true }, "error-count": { "type": "integer", "description": "This is the number of attempted post's that resulted in a error, either an inability to send to a server (network,dns, timeout, etc..) or a response code that is above a 302. This value can be \"reset\" by setting it to 0 in a update request, but only 0 is allowed value. " }, "posts-count": { "type": "integer", "description": "This is the number of attempted post's in this schedule. This includes error and success attempts. This value can be \"reset\" by setting it to 0 in a update request, but only 0 is allowed value. " } }, "required": [ "id" ] }, "Recording": { "type": "object", "properties": { "call-recording-status": { "type": "string", "description": "Status of the recording" }, "call-id": { "type": "string", "description": "Call-ID associated with the recording" }, "call-recording-started-datetime": { "type": "string", "description": "Date & time the recording started" }, "call-recording-ended-datetime": { "type": "string", "description": "Date & time the recording stopped" }, "call-recording-remote-wav": { "type": "string", "description": "Thie file location on the remote archive path. " }, "call-recording-remote-wav-size-kilobytes": { "type": "integer", "description": "The file size in bytes which, if set, suggests that the file is located in remote storage " }, "call-recording-remote-storage-config-id": { "type": "string", "description": "The config id for the file 's remote location. " }, "call-recording-match-pattern": { "type": "string", "description": "This is the case id or the recording match the was used to trigger the request. " }, "call-recording-retrieved-datetime": { "type": "string", "description": "This is the time at which the recoridng was requested." }, "file-duration-seconds": { "type": "integer", "description": "The duration of the recording in seconds. " }, "file-access-url": { "type": "string", "description": "The main url to access the recording. " }, "geo-call-id": { "type": "string", "description": "Corresponding Orig Call ID, if call_id is for a geo tunneled entry" }, "file-size-kilobytes": { "type": "integer", "description": "The size of the recording in kilobytes" } } }, "EmailCreate": { "type": "object", "properties": { "template": { "type": "string" }, "subject": { "type": "string" } }, "required": [ "template", "subject" ] }, "CallActions": { "type": "object", "properties": { "call-term-user": { "type": "string", "description": "This is the new forward location for the call to be transfered to. Do NOT set when using for attended transfer process." }, "hostname": { "type": "string", "description": "Required only for supervised/assisted transfers, this is the hostname where the call currently resides. ", "format": "hostname" }, "call-destination-session-id": { "type": "string", "description": "Required only for supervised/assisted transfers, this is the session identifier that is required to help the switch merge in the correct call. " } } }, "TtsVoice": { "type": "object", "properties": { "gender": { "type": "string" }, "id": { "type": "string" }, "languageCode": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "subType": { "type": "string" } }, "required": [ "gender", "id", "languageCode", "name", "type", "subType" ] }, "AutoAttendant": { "type": "object", "properties": { "attendant-name": { "type": "string", "description": "This is the main name for the auto attendant. Should be used to explain the main purpose for the auto attendant. " }, "user": { "type": "string" }, "time-frame": { "type": "string" }, "starting-prompt": { "type": "string", "description": "This is a \"id\" of sorts making this auto attendant unique in terms of this user and dial plan. Will be needed when reading details on a specific AA or making any modifications including removal. " }, "read-path": { "type": "string", "description": "Shown only on a read of multiple auto attendants, will assist in getting the path for reading specific Attendant details. " }, "auto-attendant": { "$ref": "#/components/schemas/AutoAttendantTier" } }, "required": [ "user", "attendant-name" ] }, "AutoAttendantTier": { "title": "", "type": "object", "properties": { "intro-greetings": { "type": "string" }, "audio": { "type": "object", "properties": { "filename": { "type": "string", "description": "This is the filename without and path or folder. Should end in .wav" }, "ordinal-order": { "type": "integer", "description": "This is the index of the audio file. " }, "file-duration-seconds": { "type": "integer", "description": "This value is the length of the file in seconds. " }, "file-size-kilobytes": { "type": "string", "description": "This value will be a formated filesize of the file in kilobytes" }, "file-access-url": { "type": "string", "description": "This will be URL of the file for remote playback. " }, "file-script-text": { "type": "string", "description": "This is the script that was used for text to speech and also used to create a new file. " }, "text-to-speech-voice-id": { "type": "string", "description": "This is the voice id used when using text to speech. ", "default": "en-US-Wavenet-C" }, "text-to-speech-language": { "type": "string", "description": "This is the voice language when using TTS. ", "default": "en_US" } } }, "unassigned-key-press": { "$ref": "#/components/schemas/AutoAttendantFailOptions" }, "no-key-press": { "$ref": "#/components/schemas/AutoAttendantFailOptions" }, "3-digit-dial-by-extension": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "4-digit-dial-by-extension": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "5-digit-dial-by-extension": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "option-1": { "$ref": "#/components/schemas/AutoAttendantTierOption" }, "option-2": { "$ref": "#/components/schemas/AutoAttendantTierOption" }, "option-3": { "$ref": "#/components/schemas/AutoAttendantTierOption" }, "option-4": { "$ref": "#/components/schemas/AutoAttendantTierOption" }, "option-5": { "$ref": "#/components/schemas/AutoAttendantTierOption" }, "option-6": { "$ref": "#/components/schemas/AutoAttendantTierOption" }, "option-7": { "$ref": "#/components/schemas/AutoAttendantTierOption" }, "option-8": { "$ref": "#/components/schemas/AutoAttendantTierOption" }, "option-9": { "$ref": "#/components/schemas/AutoAttendantTierOption" }, "option-0": { "$ref": "#/components/schemas/AutoAttendantTierOption" }, "option-*": { "$ref": "#/components/schemas/AutoAttendantTierOption" } } }, "AutoAttendantTierOption": { "type": "object", "properties": { "destination-application": { "$ref": "#/components/schemas/DialruleApplication" }, "destination-user": { "type": "string" }, "caller-name-translation": { "type": "string", "default": "[*]" }, "description": { "type": "string" }, "call-to-record": { "type": "string" }, "auto-attendant": { "type": "object", "properties": { "audio": { "type": "object", "properties": { "filename": { "type": "string", "description": "This is the filename without and path or folder. Should end in .wav" }, "ordinal-order": { "type": "integer", "description": "This is the index of the audio file. " }, "file-duration-seconds": { "type": "integer", "description": "This value is the length of the file in seconds. " }, "file-size-kilobytes": { "type": "string", "description": "This value will be a formated filesize of the file in kilobytes" }, "file-access-url": { "type": "string", "description": "This will be URL of the file for remote playback. " }, "file-script-text": { "type": "string", "description": "This is the script that was used for text to speech and also used to create a new file. " }, "text-to-speech-voice-id": { "type": "string", "description": "This is the voice id used when using text to speech. ", "default": "en-US-Wavenet-C" }, "text-to-speech-language": { "type": "string", "description": "This is the voice language when using TTS. ", "default": "en_US" } } }, "unassigned-key-press": { "$ref": "#/components/schemas/AutoAttendantFailOptions" }, "no-key-press": { "$ref": "#/components/schemas/AutoAttendantFailOptions" }, "3-digit-dial-by-extension": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "4-digit-dial-by-extension": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "5-digit-dial-by-extension": { "description": "When enabled this setting will turn on voicemail for the user. ", "$ref": "#/components/schemas/YesNoStringYesDefault" }, "option-1": { "type": "object", "properties": { "destination-application": { "$ref": "#/components/schemas/DialruleApplication" } }, "required": [ "destination-application" ] }, "option-2": { "type": "object", "properties": { "destination-application": { "$ref": "#/components/schemas/DialruleApplication" } }, "required": [ "destination-application" ] }, "option-3": { "type": "object", "properties": { "destination-application": { "$ref": "#/components/schemas/DialruleApplication" } }, "required": [ "destination-application" ] }, "option-4": { "type": "object", "properties": { "destination-application": { "$ref": "#/components/schemas/DialruleApplication" } }, "required": [ "destination-application" ] }, "option-5": { "type": "object", "properties": { "destination-application": { "$ref": "#/components/schemas/DialruleApplication" } }, "required": [ "destination-application" ] }, "option-6": { "type": "object", "properties": { "destination-application": { "$ref": "#/components/schemas/DialruleApplication" } }, "required": [ "destination-application" ] }, "option-7": { "type": "object", "properties": { "destination-application": { "$ref": "#/components/schemas/DialruleApplication" } }, "required": [ "destination-application" ] }, "option-8": { "type": "object", "properties": { "destination-application": { "$ref": "#/components/schemas/DialruleApplication" } }, "required": [ "destination-application" ] }, "option-9": { "type": "object", "properties": { "destination-application": { "$ref": "#/components/schemas/DialruleApplication" } }, "required": [ "destination-application" ] }, "option-0": { "type": "object", "properties": { "destination-application": { "$ref": "#/components/schemas/DialruleApplication" } }, "required": [ "destination-application" ] }, "option-*": { "type": "object", "properties": { "destination-application": { "$ref": "#/components/schemas/DialruleApplication" } }, "required": [ "destination-application" ] } } }, "remove": { "description": "If set to yes it will remove the option from the menu. ", "anyOf": [ { "$ref": "#/components/schemas/YesNoString", "description": "Enabled will trigger music on hold for the domain and allow it to be customized. " }, { "type": "null" } ] } } }, "Meeting": { "type": "object", "properties": { "id": { "type": "integer", "description": "The meeting id", "readOnly": true }, "domain": { "$ref": "#/components/schemas/DomainName" }, "user": { "$ref": "#/components/schemas/UserName" }, "description": { "type": "string", "description": "The description about the meeting" }, "current_timestamp": { "type": "string", "description": "The current timestamp value of the meeting", "format": "date-time" }, "meeting-calendar-invite-id": { "type": "string", "readOnly": true, "description": "The read only value for the meeting to use with calendar integration" }, "meeting-ordinal-sequence": { "type": "integer", "readOnly": true, "description": "The read only value for the meeting with manage the calendar integrations" }, "core-server": { "type": "string", "description": "The core server which the meeting was created on and events are driven from", "readOnly": true }, "chat-session-id": { "type": "string", "readOnly": true, "description": "The read only value identifying the meeting chat room session" }, "meeting-registration-id": { "type": "string", "description": "The token value for guest to use to register for a webinar" }, "meeting-instance-id": { "type": "string", "description": "The instance value of a meeting with used to associate with a recording or differentiating recurring meetings" }, "meeting-name": { "type": "string", "description": "The descriptive name of the meeting" }, "meeting-type": { "type": "string", "description": "The meeting category either the standard meeting 'conference' or a webinar style meeting by using 'presentation'", "enum": [ "presentation", "conference" ], "default": "conference" }, "limits-max-participants": { "type": "integer", "description": "The maximum number of participants allows in the meeting" }, "meeting-status": { "anyOf": [ { "$ref": "#/components/schemas/MeetingStatus" }, { "type": "string", "title": "empty string", "maxLength": 0 } ], "description": "The current status of the meeting" }, "meeting-schedule-start-datetime": { "type": "string", "description": "The scheduled start time for the meeting", "format": "date-time" }, "timezone": { "$ref": "#/components/schemas/TimeZone" }, "meeting-schedule-duration-minutes": { "type": "integer", "description": "The scheduled length of the meeting" }, "meeting-schedule-recurrence-rule": { "type": "string", "description": "The read only value describing the recuring nature of the meeting using RFC 5545", "readOnly": true }, "meeting-video-allowed-from": { "type": "string", "enum": [ "everyone", "host", "presenters" ], "description": "The value indicating which attendee types can share video" }, "meeting-audio-allowed-from": { "type": "string", "enum": [ "everyone", "host", "presenters" ], "description": "The value indicating which attendee types can share audio" }, "meeting-chat-enabled": { "description": "The value indicating if chat is enabled for this meeting", "$ref": "#/components/schemas/OneZeroDefaultOne" }, "meeting-chat-history-enabled": { "description": "The value indicating if chat is enabled for this meeting", "$ref": "#/components/schemas/OneZeroDefaultOne" }, "meeting-question-answer-enabled": { "description": "The value indicating if question and answer feature is enabled", "$ref": "#/components/schemas/OneZeroDefaultZero" }, "meeting-recording-enabled": { "description": "The value indicating if question and answer feature is enabled", "$ref": "#/components/schemas/OneZeroDefaultZero" }, "meeting-join-require-invite-enabled": { "description": "The value indicating if question and answer feature is enabled", "$ref": "#/components/schemas/OneZeroDefaultZero" }, "meeting-join-require-passcode-enabled": { "description": "The value indicating if question and answer feature is enabled", "$ref": "#/components/schemas/OneZeroDefaultZero" }, "meeting-require-host-to-begin-enabled": { "description": "The value indicating if question and answer feature is enabled", "$ref": "#/components/schemas/OneZeroDefaultZero" }, "meeting-allow-changes-from-hosts-enabled": { "description": "The value indicating if chat is enabled for this meeting", "$ref": "#/components/schemas/OneZeroDefaultOne" }, "meeting-hide-attendee-list-enabled": { "description": "The value indicating if question and answer feature is enabled", "$ref": "#/components/schemas/OneZeroDefaultZero" }, "meeting-lock-enabled": { "description": "The value indicating if question and answer feature is enabled", "$ref": "#/components/schemas/OneZeroDefaultZero" }, "meeting-lock-allowed": { "type": "string", "description": "The value indicating if the meeting is allowed to be locked" }, "meeting-room-enabled": { "description": "The value indicating if question and answer feature is enabled", "$ref": "#/components/schemas/OneZeroDefaultZero" }, "meeting-dial-in-number-blob": { "anyOf": [ { "type": "string" }, { "type": "integer" } ], "description": "The number for audio-only users to dial in to the meeting" }, "meeting-passcode": { "type": "string", "description": "The passcode used to enter meeting if it is required" }, "meeting-previous-presenter-attendee-id": { "type": "string", "description": "The value of the previous attendee that prsented their screen", "readOnly": true }, "meeting-presenter-attendee-id": { "type": "string", "description": "The value of the current attendee that is sharing their screen" }, "meeting-video-layout ": { "type": "string", "description": "The current meeting layout default for entire meeting", "enum": [ "spotlight", "conversation", "grid" ] }, "last-modified-datetime": { "type": "string", "description": "The timestamp of the last time the meeting was modified", "format": "date-time" }, "meeting-instance-actual-start-datetime": { "type": "string", "description": "The timestamp the current meeting instance was started", "format": "date-time" } }, "required": [ "id", "domain", "user", "meeting-status", "timezone", "current_timestamp", "meeting-schedule-start-datetime", "meeting-room-enabled" ] }, "RecurringTimeframe": { "type": "object", "properties": { "timeframe-id": { "type": "string" }, "timeframe-name": { "type": "string" }, "user": { "type": "string" }, "domain": { "type": "string" }, "timeframe-type": { "$ref": "#/components/schemas/RecurringTimeframeType" }, "timeframe-specific-dates-array": { "type": "array", "items": { "$ref": "#/components/schemas/TimeframeSpecificDate" } }, "timeframe-holiday-array": { "type": "array", "items": { "$ref": "#/components/schemas/TimeframeHoliday" } }, "timeframe-days-of-week-array": { "type": "array", "items": { "$ref": "#/components/schemas/TimeframeDOW" } } } }, "TimeframeSpecificDate": { "type": "object", "properties": { "timeframe-id": { "type": "string" }, "timeframe-parent-id": { "type": "string", "readOnly": true }, "ordinal-order": { "type": "number", "readOnly": true }, "timeframe-specific-dates-begin-date": { "type": "string", "description": "Start date of the specific date period - format: YYYYMMDD" }, "timeframe-specific-dates-begin-time": { "type": "string", "description": "Start time of the specific date period - format: hhmm (24 hour)" }, "timeframe-specific-dates-end-date": { "type": "string", "description": "End date of the specific date period - format: YYYYMMDD" }, "timeframe-specific-dates-end-time": { "type": "string", "description": "End time of the specific date period - format: hhmm (24 hour)" }, "timeframe-recurrence-type": { "type": "string", "description": "```doesNotRecur```: no recurrence\n\n```monthly-on-last-day```: every month on the last day of the month\n\n```monthly-on-first-last```: monthly on the first or last ordinal weekday, e.g.: the first Friday, the last Thursday - note: this will produce potentially unexpected behavior if used with a date that is not the first or last occurrence of that particular weekday\n\n```monthly-on-ordinal-weekday```: can be used for any ordinal weekday that is NOT the first or last occurrence of that weekday in the given month e.g. the third Friday, the second Monday\n\n```monthly-date```: every month on the same day, e.g.: the 14th day, the 29th day - note: if there are months in which the “day” does not occur, the date will not be active during that month, e.g.: the 31st day of February\n\n```yearly-on-selected-dates```: every year on the exact month and day, e.g.: April 30th, September 4th\n\n```annual-month-day```: functionally identical to ```yearly-on-selected-dates```\n\n```yearly-first```: every year on the first ordinal weekday of the exact month, e.g.: the first Monday of every June, the first Friday of every August - note: this will produce potentially unexpected behavior if used with a date that is not the first occurrence of that particular weekday\n\n```yearly-last```: every year on the last ordinal weekday of the exact month, e.g.: the last Friday of every July, the last Tuesday of every November - note: this will produce potentially unexpected behavior if used with a date that is not the last occurrence of that particular weekday\n\n```custom```: if this option is selected the fields ```timeframe-recurrence-custom-interval```, ```timeframe-recurrence-custom-interval-option```, and ```timeframe-recurrence-custom-interval-count``` must be set correctly to produce any behavior" }, "timeframe-recurrence-custom-interval": { "type": "string", "description": "Must be combined with the field ```timeframe-recurrence-custom-interval-count```\n\n```days```: recur every ```timeframe-recurrence-custom-interval-count``` days\n```weeks```: recur every ```timeframe-recurrence-custom-interval-count``` weeks\n```months```: recur every ```timeframe-recurrence-custom-interval-count``` months\n```years```: recur every ```timeframe-recurrence-custom-interval-count``` years" }, "timeframe-recurrence-custom-interval-count": { "type": "string", "description": "Specifies the recurrence count based on the period specified in ```timeframe-recurrence-custom-interval-count``` e.g. 'every 6 days' or 'every 3 months'\n\nIf the field ```timeframe-recurrence-custom-interval-count``` is set to ```months``` this field determines the count in combination with the option set in ```timeframe-recurrence-custom-interval-option```, if ```timeframe-recurrence-custom-interval``` is set to ```years``` the count is fixed to a value of 1 and will recur every year according to the option set in ```timeframe-recurrence-custom-interval-option```" }, "timeframe-recurrence-custom-interval-option": { "type": "string", "description": "If ```timeframe-recurrence-custom-interval``` is set to ```days``` or ```weeks``` this field is not used. This field is for ```months``` and ```years``` only.\n\nFor ```timeframe-recurrence-custom-interval``` of ```months```:\n```monthly-same-day```: recur on the same day of the month, e.g.: the 14th day, the 29th day - note: if there are months in which the “day” does not occur, the date will not be active during that month, e.g.: the 31st day of February\n```monthly-ordinal-weekday```: recur on the same ordinal weekday e.g. the third Friday, the second Monday\n```monthly-first-last-weekday```: recur on the first or last instance of the selected weekday in the month, e.g.: the first Wednesday, the last Tuesday - note: this will produce potentially unexpected behavior if used with a date that is not the first or last occurrence of that particular weekday\n```monthly-on-last-day```: recur on the last day of the month - note: this will produce potentially unexpected behavior if used with a date that is not the last day of the month\n\nFor ```timeframe-recurrence-custom-interval``` of ```years```:\n```yearly-same-day```: recur on the same day of the same month, e.g.: the 10th of May, the 20th of October\n```yearly-ordinal-weekday```: recur on the same ordinal weekday of the same month, e.g.: the second Tuesday of April, the third Thursday of November\n```yearly-first-last-weekday```: recur on the first or last weekday of the same month, e.g.: the third Wednesday of August, the first Tuesday of December - note: this will produce potentially unexpected behavior if used with a date that is not the first or last occurrence of that particular weekday" }, "timeframe-recurrence-end-option": { "type": "string", "description": "```never```: recurrence will continue indefinitely\n\n```onADate```: recurrence will end on a date, specified in ```timeframe-recurrence-end-date```" }, "timeframe-recurrence-end-date": { "type": "string", "description": "End date of the recurrence - format: YYYYMMDD" }, "timeframe-expiry-datetime": { "type": "string", "readOnly": true }, "domain": { "type": "string", "readOnly": true }, "timeframe-recurrence-rrule": { "type": [ "string", "null" ], "description": "The RRULE string, if recurrence is configured", "readOnly": true }, "timeframe-next-observance-datetime": { "type": "array", "items": { "type": "number" }, "description": "List of the upcoming occurrences of the specific date if recurrence is configured, formatted as epoch timestamp in seconds", "readOnly": true }, "timeframe-is-v1": { "type": [ "boolean", "null" ], "description": "Will be set to ```true``` if the specific date is part of a timeframe created before v44.1", "readOnly": true } }, "required": [ "timeframe-specific-dates-begin-date", "timeframe-specific-dates-begin-time", "timeframe-specific-dates-end-date", "timeframe-specific-dates-end-time", "timeframe-recurrence-type", "timeframe-recurrence-custom-interval-count", "timeframe-recurrence-custom-interval", "timeframe-recurrence-custom-interval-option", "timeframe-recurrence-end-option", "timeframe-recurrence-end-date" ] }, "TimeframeHoliday": { "type": "object", "properties": { "timeframe-id": { "type": "string" }, "timeframe-parent-id": { "type": "string", "readOnly": true }, "ordinal-order": { "type": "number", "readOnly": true }, "timeframe-holiday-uuid": { "type": "string", "description": "UUID of the holiday as provided by the Holiday API" }, "timeframe-holiday-name": { "type": "string", "description": "Name of holiday as provided by the Holiday API" }, "timeframe-holiday-begin-date": { "type": "string", "description": "First desired occurrence of the holiday - format: YYYYMMDD" }, "country-abbreviation": { "type": "string", "description": "Country of the holiday as provided by the Holiday API" }, "state-province-abbreviation": { "type": "string", "description": "Region of the holiday as provided by the Holiday API, formatted according to ISO 3166-2 standard.e.g.:```US-CA``` for California, United States```MX-SIN``` for Sinaloa, Mexico" }, "holiday-api-location-hint": { "type": "string", "description": "Locations of the holiday exactly as provided by the Holiday API" }, "timeframe-holiday-begin-time-1": { "type": "string", "description": "Beginning of the first time period during which the time frame will take effect on the holiday - format: hhmm" }, "timeframe-holiday-end-time-1": { "type": "string", "description": "End of the first time period during which the time frame will take effect on the holiday - format: hhmm" }, "timeframe-holiday-begin-time-2": { "type": "string", "description": "Beginning of the second time period, if there is one, during which the time frame will take effect on the holiday - format: hhmm" }, "timeframe-holiday-end-time-2": { "type": "string", "description": "End of the second time period, if there is one, during which the time frame will take effect on the holiday - format: hhmm" }, "timeframe-weekly-monday-observance-option": { "$ref": "#/components/schemas/RecurringTimeframeHolidayObservance" }, "timeframe-weekly-tuesday-observance-option": { "$ref": "#/components/schemas/RecurringTimeframeHolidayObservance" }, "timeframe-weekly-wednesday-observance-option": { "$ref": "#/components/schemas/RecurringTimeframeHolidayObservance" }, "timeframe-weekly-thursday-observance-option": { "$ref": "#/components/schemas/RecurringTimeframeHolidayObservance" }, "timeframe-weekly-friday-observance-option": { "$ref": "#/components/schemas/RecurringTimeframeHolidayObservance" }, "timeframe-weekly-saturday-observance-option": { "$ref": "#/components/schemas/RecurringTimeframeHolidayObservance" }, "timeframe-weekly-sunday-observance-option": { "$ref": "#/components/schemas/RecurringTimeframeHolidayObservance" }, "timeframe-workweek-list": { "type": "string", "description": "Comma-separated list containing days of the week to be considered workdays (minimum of 4, maximum of 6).\ne.g.: ```M,T,Th,F,S,Su``` would produce a workweek of Monday, Tuesday, Thursday, Friday, Saturday, and Sunday" }, "timeframe-recurrence-type": { "type": "string", "description": "```never```: No recurrence.\n```yearlyOnHoliday```: Recurs every year on the holiday." }, "timeframe-recurrence-end-option": { "type": "string", "description": "```never```: recurs indefinitely.\n\n```onDate```: ends on the date specified in ```recurrence_end_date``` - note: both fields must be set to produce the desired behavior" }, "timeframe-recurrence-end-date": { "type": "string", "description": "YYYYMMDD" }, "timeframe-expiry-datetime": { "type": "string", "description": "End date of recurrence - format: YYYYMMDD" }, "domain": { "type": "string", "readOnly": true }, "timeframe-next-observance-datetime": { "type": "array", "items": { "type": "number" }, "readOnly": true } }, "required": [ "timeframe-holiday-uuid", "timeframe-holiday-name", "timeframe-holiday-begin-date", "country-abbreviation", "state-province-abbreviation", "holiday-api-location-hint", "timeframe-holiday-begin-time-1", "timeframe-holiday-end-time-1", "timeframe-holiday-begin-time-2", "timeframe-holiday-end-time-2", "timeframe-weekly-monday-observance-option", "timeframe-weekly-tuesday-observance-option", "timeframe-weekly-wednesday-observance-option", "timeframe-weekly-thursday-observance-option", "timeframe-weekly-friday-observance-option", "timeframe-weekly-saturday-observance-option", "timeframe-weekly-sunday-observance-option", "timeframe-workweek-list", "timeframe-recurrence-type", "timeframe-recurrence-end-option", "timeframe-recurrence-end-date" ] }, "TimeframeDOW": { "type": "object", "properties": { "timeframe-id": { "type": "string" }, "timeframe-parent-id": { "type": "string", "readOnly": true }, "ordinal-order": { "type": "number", "readOnly": true }, "timeframe-weekly-sunday-begin-time-1": { "type": "string", "description": "Beginning of the first time period during which the time frame will take effect on Sundays - format: hhmm" }, "timeframe-weekly-sunday-end-time-1": { "type": "string", "description": "End of the first time period during which the time frame will take effect on Sundays - format: hhmm" }, "timeframe-weekly-sunday-begin-time-2": { "type": "string", "description": "Beginning of the second time period, if there is one, during which the time frame will take effect on Sundays - format: hhmm" }, "timeframe-weekly-sunday-end-time-2": { "type": "string", "description": "End of the second time period, if there is one, during which the time frame will take effect on Sundays - format: hhmm" }, "timeframe-weekly-monday-begin-time-1": { "type": "string", "description": "Beginning of the first time period during which the time frame will take effect on Mondays - format: hhmm" }, "timeframe-weekly-monday-end-time-1": { "type": "string", "description": "End of the first time period during which the time frame will take effect on Mondays - format: hhmm" }, "timeframe-weekly-monday-begin-time-2": { "type": "string", "description": "Beginning of the second time period, if there is one, during which the time frame will take effect on Mondays - format: hhmm" }, "timeframe-weekly-monday-end-time-2": { "type": "string", "description": "End of the second time period, if there is one, during which the time frame will take effect on Mondays - format: hhmm" }, "timeframe-weekly-tuesday-begin-time-1": { "type": "string", "description": "Beginning of the first time period during which the time frame will take effect on Tuesdays - format: hhmm" }, "timeframe-weekly-tuesday-end-time-1": { "type": "string", "description": "End of the first time period during which the time frame will take effect on Tuesdays - format: hhmm" }, "timeframe-weekly-tuesday-begin-time-2": { "type": "string", "description": "Beginning of the second time period, if there is one, during which the time frame will take effect on Tuesdays - format: hhmm" }, "timeframe-weekly-tuesday-end-time-2": { "type": "string", "description": "End of the second time period, if there is one, during which the time frame will take effect on Tuesdays - format: hhmm" }, "timeframe-weekly-wednesday-begin-time-1": { "type": "string", "description": "Beginning of the first time period during which the time frame will take effect on Wednesdays - format: hhmm" }, "timeframe-weekly-wednesday-end-time-1": { "type": "string", "description": "End of the first time period during which the time frame will take effect on Wednesdays - format: hhmm" }, "timeframe-weekly-wednesday-begin-time-2": { "type": "string", "description": "Beginning of the second time period, if there is one, during which the time frame will take effect on Wednesdays - format: hhmm" }, "timeframe-weekly-wednesday-end-time-2": { "type": "string", "description": "End of the second time period, if there is one, during which the time frame will take effect on Wednesdays - format: hhmm" }, "timeframe-weekly-thursday-begin-time-1": { "type": "string", "description": "Beginning of the first time period during which the time frame will take effect on Thursdays - format: hhmm" }, "timeframe-weekly-thursday-end-time-1": { "type": "string", "description": "End of the first time period during which the time frame will take effect on Thursdays - format: hhmm" }, "timeframe-weekly-thursday-begin-time-2": { "type": "string", "description": "Beginning of the second time period, if there is one, during which the time frame will take effect on Thursdays - format: hhmm" }, "timeframe-weekly-thursday-end-time-2": { "type": "string", "description": "End of the second time period, if there is one, during which the time frame will take effect on Thursdays - format: hhmm" }, "timeframe-weekly-friday-begin-time-1": { "type": "string", "description": "Beginning of the first time period during which the time frame will take effect on Fridays - format: hhmm" }, "timeframe-weekly-friday-end-time-1": { "type": "string", "description": "End of the first time period during which the time frame will take effect on Fridays - format: hhmm" }, "timeframe-weekly-friday-begin-time-2": { "type": "string", "description": "Beginning of the second time period, if there is one, during which the time frame will take effect on Fridays - format: hhmm" }, "timeframe-weekly-friday-end-time-2": { "type": "string", "description": "End of the second time period, if there is one, during which the time frame will take effect on Fridays - format: hhmm" }, "timeframe-weekly-saturday-begin-time-1": { "type": "string", "description": "Beginning of the first time period during which the time frame will take effect on Saturdays - format: hhmm" }, "timeframe-weekly-saturday-end-time-1": { "type": "string", "description": "End of the first time period during which the time frame will take effect on Saturdays - format: hhmm" }, "timeframe-weekly-saturday-begin-time-2": { "type": "string", "description": "Beginning of the second time period, if there is one, during which the time frame will take effect on Saturdays - format: hhmm" }, "timeframe-weekly-saturday-end-time-2": { "type": "string", "description": "End of the second time period, if there is one, during which the time frame will take effect on Saturdays - format: hhmm" }, "timeframe-recurrence-type": { "type": "string", "description": "```weekly```: recur every week\n```custom```: if this option is selected the fields ```timeframe-recurrence-begin-date```, ```timeframe-recurrence-custom-interval```, ```timeframe-recurrence-custom-interval-option```, and ```timeframe-recurrence-custom-interval-count``` must be set correctly to produce any behavior" }, "timeframe-recurrence-begin-date": { "type": "string", "description": "Start date of the recurrence - format: YYYYMMDD - note: this field is only applicable for the ```timeframe-recurrence-type``` option ```custom```" }, "timeframe-recurrence-custom-interval": { "type": "string", "description": "Must be combined with the field ```timeframe-recurrence-custom-interval-count```\n\n```weeks```: recur every ```timeframe-recurrence-custom-interval-count``` weeks\n```months```: recur every ```timeframe-recurrence-custom-interval-count``` months" }, "timeframe-recurrence-custom-interval-count": { "type": "string", "description": "Specifies the recurrence count based on the period specified in ```timeframe-recurrence-custom-interval``` e.g. 'every 6 weeks' or 'every 3 months'\n\nIf the field ```timeframe-recurrence-custom-interval``` is set to ```months``` this field determines the count in combination with the option set in ```timeframe-recurrence-custom-interval-option```" }, "timeframe-recurrence-custom-interval-option": { "type": "string", "description": "If ```timeframe-recurrence-custom-interval``` is set to ```weeks``` this field is not used. This field is for ```months``` only.\nThe following options configure recurrence for the Days of Week period according to the start date defined in ```timeframe-recurrence-begin-date```.\n\nFor ```timeframe-recurrence-custom-interval``` of ```months```:\n```monthly-same-day```: recur on the same day of the month, e.g.: the 14th day, the 29th day - note: if there are months in which the “day” does not occur, the Days fo Week will not be active during that month, e.g.: the 31st day of February\n```monthly-ordinal-weekday```: recur on any ordinal weekday in the given month e.g. the third Friday, the second Monday\n```monthly-first-last-weekday```: recur on the first or last instance of the selected weekday in the month, e.g.: the first Wednesday, the last Tuesday - note: this will produce potentially unexpected behavior if used with a date that is not the first or last occurrence of that particular weekday" }, "timeframe-recurrence-end-option": { "type": "string", "description": "```never```: recurrence will continue indefinitely\n```onADate```: recurrence will end on a date, specified in ```timeframe-recurrence-end-date```" }, "timeframe-recurrence-end-date": { "type": "string", "description": "End date of the recurrence - format: YYYYMMDD" }, "timeframe-expiry-datetime": { "type": "string", "readOnly": true }, "domain": { "type": "string", "readOnly": true }, "timeframe-next-observance-datetime": { "type": "array", "items": { "type": "number" }, "readOnly": true, "description": "List of the upcoming occurrences of the days of week if ```recurrence``` is configured as ```custom```, formatted as epoch timestamp in seconds" }, "timeframe-recurrence-rrule": { "type": [ "string", "null" ], "readOnly": true }, "timeframe-is-v1": { "type": [ "boolean", "null" ], "readOnly": true } }, "required": [ "timeframe-recurrence-begin-date", "timeframe-recurrence-type", "timeframe-recurrence-custom-interval-count", "timeframe-recurrence-custom-interval", "timeframe-recurrence-custom-interval-option", "timeframe-recurrence-end-option", "timeframe-recurrence-end-date" ] }, "IotumHost": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" }, "password": { "type": "string" }, "role": { "type": "string" }, "auto_record": { "type": "string" }, "plan_slug": { "type": "string" }, "add_on_slug": { "type": "string" } }, "required": [ "name", "auto_record", "plan_slug", "email", "password", "add_on_slug" ] }, "IotumContact": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Contact" }, "email": { "type": "string", "description": "The email address of the Contact." }, "business_phone": { "type": "string", "description": " optional, business phone number" }, "mobile_phone": { "type": "string", "description": " optional, mobile phone number" }, "home_phone": { "type": "string", "description": " optional, home phone number" }, "other_phone": { "type": "string", "description": "optional, other phone number" }, "time_zone": { "type": "string", "description": "optional, IANA time zone name. Values are those (e.g. US/Central, Europe/London, Asia/Tokyo, etc.) in the IANA Time Zone database (https://www.iana.org/time-zones)" } }, "required": [ "name", "email" ] }, "Transcription": { "type": "object", "properties": { "call-intelligence-job-id": { "type": "integer", "examples": [ 179133950 ], "format": "int", "readOnly": true, "description": "This is the main ID identifying the transcription job and will link all intelligence features. " }, "call-intelligence-processing-status": { "type": "string", "examples": [ "finished" ], "readOnly": true, "description": "This is the status of the transcription and intelegence work. The data will be enter as soon as the request is made to remote vendor, but might not be availabel fully untill status is \"finished\"" }, "created-datetime": { "type": "string", "examples": [ "2024-10-01T22:48:21+00:00" ], "format": "da", "readOnly": true, "description": "The date-time of the request for transcription. " }, "call-id": { "type": "string", "description": "The linked call-id for the SIP call being recorded. Could be an orig_callid or term_callid depending on who requested recording and type of call. " }, "call-intelligence-features-enabled": { "type": "string", "description": "List of features enabled for request. " }, "call-intelligence-summary": { "type": "string", "description": "The main summary of the call when available. " }, "call-intelligence-topics-top": { "type": "array", "items": { "type": "string" }, "description": "The list of top topics detected on the call based on frequency. " }, "call-intelligence-duration-seconds": { "type": "number", "description": "The duration in seconds for the length of time where detected voice was seen. " }, "call-intelligence-duration-seconds-negative": { "type": "integer", "description": "The duration in seconds for the length of time where detected voice was seen with a Negative sentiment" }, "call-intelligence-duration-seconds-neutral": { "type": "number", "description": "The duration in seconds for the length of time where detected voice was seen. " }, "call-intelligence-duration-seconds-positive": { "type": "number", "description": "The duration in seconds for the length of time where detected voice was seen with a Positve sentiment" }, "call-intelligence-ending-duration-seconds": { "type": "number" }, "call-intelligence-ending-duration-seconds-negative": { "type": "integer" }, "call-intelligence-ending-duration-seconds-neutral": { "type": "number" }, "call-intelligence-ending-duration-seconds-positive": { "type": "number" }, "call-intelligence-ending-percent-negative": { "type": "integer" }, "call-intelligence-ending-percent-neutral": { "type": "integer" }, "call-intelligence-ending-percent-positive": { "type": "integer" }, "call-intelligence-ending-sentiment-scale": { "type": "integer" }, "call-intelligence-percent-negative": { "type": "integer" }, "call-intelligence-percent-neutral": { "type": "integer" }, "call-intelligence-percent-positive": { "type": "integer" }, "call-intelligence-segments": { "type": "array", "items": { "type": "object", "properties": { "speaker": { "type": "string" }, "comment": { "type": "string" }, "sentiment": { "type": "string" }, "start-time": { "type": "string" }, "end-time": { "type": "string" } }, "required": [ "speaker", "comment", "sentiment", "start-time", "end-time" ] } }, "call-intelligence-summary-status": { "type": "string" }, "call-intelligence-topics-all": { "type": "array", "items": { "type": "string" }, "description": "The complete list of detected topics in the conversation" }, "errors": { "type": "string", "description": "If errors are present it will display here. " }, "last-modified-datetime": { "type": "string", "format": "date", "examples": [ "2024-10-01T22:48:28+00:00" ], "description": "The modified time of the transcription job. Difference between this and created-datetime will be the duration of the job in most cases. " } } }, "Dialplan": { "type": "object", "properties": { "dialplan_id": { "type": "integer" }, "domain": { "type": "string" }, "dial-rule-dial-plan": { "type": "string" }, "dial-rule-description": { "type": "string" } }, "required": [ "domain", "dial-rule-dial-plan", "dial-rule-description" ] }, "Conference": { "type": "array", "items": { "type": "object", "properties": { "aor": { "type": "string" }, "owner_domain": { "type": "string" }, "owner": { "type": "string" }, "owner_uid": { "type": "string" }, "leader_pin": { "type": "string" }, "speaker_pin": { "type": "string" }, "participants_pin": { "type": "string" }, "num_participants": { "type": "string" }, "max_participants": { "type": "string" }, "time_begin": { "type": "string" }, "time_end": { "type": "string" }, "gmt_offset": { "type": "string" }, "activate": { "type": "string" }, "audio_dir": { "type": "string" }, "annc_join": { "type": "string" }, "annc_depart": { "type": "string" }, "dial_plan": { "type": "string" }, "name": { "type": "string" }, "save_participants": { "type": "string" }, "request_name": { "type": "string" }, "lock_part": { "type": "string" }, "annc_part": { "type": "string" }, "mute": { "type": "string" }, "trigger_by": { "type": "string" }, "leader_required": { "type": "string" }, "quorum": { "type": "string" }, "SipSipProxy": { "type": "string" }, "SipSipAuthUser": { "type": "string" }, "SipSipAuthKey": { "type": "string" }, "RegRequired": { "type": "string" }, "promptAudioId": { "type": "string" }, "confOptions": { "type": "string" } } } }, "ConferenceParticipant": { "type": "array", "items": { "type": "object", "properties": { "participant_match": { "type": "string" }, "conference_match": { "type": "string" }, "name": { "type": "string" }, "aor_user": { "type": "string" }, "aor_host": { "type": "string" }, "contact": { "type": "string" }, "received_from": { "type": "string" }, "user_agent": { "type": "string" }, "hostname": { "type": "string" }, "pin": { "type": "string" }, "time_begin": { "type": "string" }, "leader": { "type": "string" }, "auto_ans": { "type": "string" }, "auto_con": { "type": "string" }, "auto_dsc": { "type": "string" }, "rcv_only": { "type": "string" }, "keep": { "type": "string" }, "mode": { "type": "string" }, "rate": { "type": "string" }, "gain_tx": { "type": "string" }, "gain_rx": { "type": "string" }, "audioId": { "type": "string" }, "media": { "type": "string" }, "ts": { "type": "string" } } } }, "Chart": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "type": { "type": "string" }, "data_token": { "type": "object", "properties": { "access_token": { "type": "string" }, "expires_in": { "type": "integer" }, "scope": { "type": "string" }, "mask_chain": { "type": "null" }, "token_type": { "type": "string" }, "refresh_token": { "type": "string" } }, "required": [ "access_token", "expires_in", "scope", "mask_chain", "token_type", "refresh_token" ] } }, "required": [ "id", "name", "type", "data_token" ] }, "Dashboard": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "domain": { "type": "string" }, "favorite": { "type": "boolean" }, "owner_id": { "type": "string" }, "owner_type": { "type": "integer" } }, "required": [ "id", "name", "domain", "favorite", "owner_id", "owner_type" ] }, "Presence": { "type": "object", "properties": { "user": { "type": "string" }, "uid": { "type": "string" }, "domain": { "type": "string" }, "site": { "type": "string" }, "name-first-name": { "type": "string" }, "name-last-name": { "type": "string" }, "department": { "type": "string" }, "user-presence-status": { "type": "string" }, "email-address": { "type": "string" } }, "required": [ "user", "uid", "domain", "site", "name-first-name", "name-last-name", "department", "user-presence-status", "email-address" ] }, "PublicUserInfo": { "type": "object", "properties": { "user": { "type": "string" }, "domain": { "type": "string" }, "site": { "type": "string" }, "name-first-name": { "type": "string" }, "name-last-name": { "type": "string" }, "department": { "type": "string" }, "directory-name-number-dtmf-mapping": { "type": "integer" } }, "required": [ "user", "domain", "site", "name-first-name", "name-last-name", "department", "directory-name-number-dtmf-mapping" ] }, "DeviceModel": { "type": "object", "properties": { "description": { "type": "string" }, "device-models-brand": { "type": "string", "description": "This is the brand of the phone/device" }, "device-models-model": { "type": "string", "description": "This is the model of the phone/device" }, "device-models-type": { "type": "string", "description": "The type of equipemnt, most will be \"Device\" " }, "device-models-config-format": { "type": "string", "description": "The NDP format that will be used to format the config, this must match a valid format known to the ndp either a preconfigure or custom one, but cannot be just made up. " }, "device-models-button-types": { "type": "array", "items": { "type": "object", "properties": { "device-models-button-name": { "type": "string" }, "profile-button-type": { "type": "string" }, "features": { "type": "array", "items": { "properties": { "feature_type": { "type": "string" }, "autocomplete": { "type": "string" }, "name": { "type": "string" }, "extra_settings": { "type": "array", "items": { "type": "object", "properties": { "Label": { "type": "string" }, "type": { "type": "string" } }, "required": [ "Label", "type" ] } }, "shared": { "type": "boolean" }, "notarget": { "type": "boolean" } }, "required": [ "feature_type", "autocomplete", "name", "extra_settings", "notarget" ], "$ref": "#/components/schemas/DeviceModelButtonType", "type": "object" } } }, "required": [ "features", "device-models-button-name", "profile-button-type" ] }, "description": "Read only concatination of brand and mod", "readOnly": true }, "device-models-https-enabled": { "type": "string" }, "device-models-tftp-enabled": { "type": "string" }, "device-models-count-buttons": { "type": "integer" }, "device-models-fxs-support-enabled": { "type": "integer" }, "device-models-fxo-support-enabled": { "type": "integer" }, "device-models-trunk-support-enabled": { "type": "integer" }, "device-models-directory-support-enabled": { "type": "string" }, "device-models-presence-support-enabled": { "type": "string" }, "device-models-shared-line-support-enabled": { "type": "string" }, "device-models-sidecar-support-enabled": { "type": "string" }, "device-models-resync-support-enabled": { "type": "string" }, "device-models-encryption-support-enabled": { "type": "string" }, "device-models-firmware-support-enabled": { "type": "string" }, "device-models-overrides-blob": { "type": "string" }, "device-models-visible-in-portal": { "type": "string" }, "device-models-brand-and-model": { "type": "string" }, "device-models-firmware-options": { "type": "string" } }, "required": [ "device-models-firmware-options", "description", "device-models-button-types", "device-models-brand", "device-models-model", "device-models-type", "device-models-config-format", "device-models-https-enabled", "device-models-tftp-enabled", "device-models-count-buttons", "device-models-fxs-support-enabled", "device-models-fxo-support-enabled", "device-models-trunk-support-enabled", "device-models-directory-support-enabled", "device-models-presence-support-enabled", "device-models-shared-line-support-enabled", "device-models-sidecar-support-enabled", "device-models-resync-support-enabled", "device-models-encryption-support-enabled", "device-models-firmware-support-enabled", "device-models-overrides-blob", "device-models-visible-in-portal", "device-models-brand-and-model" ] }, "Auditlog": { "type": "object", "properties": { "by-ip": { "type": "string" }, "timestamp-datetime": { "type": "string" }, "by-domain": { "type": "string" }, "by-user": { "type": "string" }, "by-client": { "type": "string" }, "action-type": { "type": "string" }, "target-host": { "type": "string" }, "target-domain": { "type": "string" }, "target-user": { "type": "string" }, "target-object": { "type": "string" }, "auditlog-details": { "type": "object", "properties": {} } }, "required": [ "by-ip", "timestamp-datetime", "by-domain", "by-user", "by-client", "action-type", "target-host", "target-domain", "target-user", "target-object" ] }, "Phoneconfiguration": { "type": "object", "properties": { "phoneconfiguration-name": { "type": "string", "description": "This is the main name for the phone configuration when used as a template" }, "phoneconfiguration-mac-address": { "type": "string", "description": "When phone configuration is applied to a specific phone (not template) this will be a valid mac\n" }, "phoneconfiguration-description": { "type": "string", "description": "This is a plain description of the configuration" }, "phoneconfiguration-brand": { "type": "string", "description": "The brand for which this phone configuration will be build for. " }, "phoneconfiguration-model": { "type": "string", "description": "The model specific to brand for which this phone configuration will be build for. " }, "phoneconfiguration-domain": { "type": "string", "description": "The domain owning this phone configuration" }, "phoneconfiguration-sidecars": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "phoneconfiguration-brand": { "type": "string", "description": "This is the brand for sidecar specifically. It likely will match the parent phoneconfiguration-brand setting. " }, "phoneconfiguration-model": { "type": "string", "description": "This is the model specifically for the sidecar unit, it will be different to the model listed at the root level. " } } }, "description": "List of \"sidecars\" for the phone if in use. Use multiple if multiple side car's in use. " }, "phoneconfiguration-extra": { "type": "object", "properties": { "dynamic": { "type": "string", "description": "dynamic can be set to true if this is being used in dynamic BLF settings. " } }, "description": "This is an \"extra\" object that will be used for easy expansion when needed later. Available optional declerations will be defined below. " }, "phoneconfiguration-directory": { "type": "object", "properties": { "group": { "type": "string", "description": "This is the name of the Directory data set. It could be the like of \"All\", \"Coworkers\" or a specific entry like the name of a Department. ", "default": "All" }, "group-type": { "type": "string", "description": "This is the type of contacts to use, \"Standard\" or \"department\"", "default": "Standard" }, "sort": { "type": "string", "enum": [ "Extension", "First Name", "Last name" ], "default": "Extension", "description": "This is the label to use to sort the directory" }, "order": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc", "description": "This is the sort direction for the directory" }, "exclusions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The uid of the user being excluded from the directory.", "examples": [ "user@domain" ] }, "type": { "type": "string", "description": "The type of contact, most will be \"onnet\"", "default": "onnet" } } }, "description": "List of excluded entries for the domain" } } }, "phoneconfiguration-buttons": { "type": "array", "items": { "properties": { "phoneconfiguration-button-order": { "type": "integer" }, "phoneconfiguration-button-type": { "type": "string" }, "phoneconfiguration-button-feature": { "type": "string" }, "phoneconfiguration-button-target": { "type": [ "integer", "string" ] }, "phoneconfiguration-button-label": { "type": "string" }, "phoneconfiguration-button-locked": { "type": [ "integer", "null" ] }, "phoneconfiguration-extra": { "type": "array", "items": { "type": "string" }, "properties": { "phoneconfiguration-button-label": { "type": "string" }, "targetUser": { "type": "integer" }, "timeframe": { "type": "string" } }, "required": [ "targetUser", "timeframe" ] } }, "required": [ "phoneconfiguration-button-order", "phoneconfiguration-button-type", "phoneconfiguration-button-feature", "phoneconfiguration-button-target", "phoneconfiguration-button-label", "phoneconfiguration-button-locked", "phoneconfiguration-extra" ], "$ref": "#/components/schemas/PhoneConfigBtn" } }, "last-modified-datetime": { "type": "string", "readOnly": true, "description": "The last updated timestamp for the config" } }, "required": [ "phoneconfiguration-description", "phoneconfiguration-brand", "phoneconfiguration-model", "phoneconfiguration-domain" ] }, "AbandondedCallStat": { "type": "object", "properties": { "domain": { "type": "string", "description": "This is the main name of the domain. This name should be capable of being in SIP enpoints so no special characters or spaces." }, "call-orig-call-id": { "type": "string", "description": "Unique identifier for the Origination call leg" }, "agent-term-uri": { "type": "string", "description": "SIP URI of the terminating Agent." }, "agent-term-user": { "type": "string", "description": "This is the extension of the Agent." }, "agent-term-domain": { "type": "string", "description": "This is the domain of the Agent." }, "agent-name-first-name": { "type": "string", "description": "This is the first name for the Agent." }, "agent-name-last-name": { "type": "string", "description": "This is the last name for the Agent." }, "callqueue": { "type": "string", "description": "Extension id for a preconfigured callqueue" }, "call-dialed-number": { "type": "integer", "description": "Dialed Number Identification Service - the number that was called." }, "agent-talking-duration-seconds": { "type": "integer", "description": "Time Agent spent on the call talking to caller." }, "agent-call-duration-seconds": { "type": "integer", "description": "Total time Agent spent on the call including hold time." }, "queue-duration-seconds": { "type": "integer", "description": "Time call spent in the queue before answered by an Agent." }, "agent-holding-duration-seconds": { "type": "integer", "description": "Time Agent spent on hold during the call." }, "disposition-duration-seconds": { "type": "integer", "description": "Disposition / Wrap up time for agent before going Online for next call." }, "agent-call-start-datetime": { "type": "string", "description": "Time when call was presented to the Agent." }, "queue-call-start-datetime": { "type": "string", "description": "Time when call entered to the queue." }, "queue-call-disconnect-datetime": { "type": "string", "description": "Time when call was released from the queue." }, "agent-call-disconnect-datetime": { "type": "string", "description": "Time when call was released by the Agent." }, "agent-call-answer-datetime": { "type": "string", "description": "Time when call was answered by the Agent." }, "agent-call-disconnect-reason-text": { "type": "string", "description": "Agent release reason." }, "queue-call-disconnect-reason-text": { "type": "string", "description": "Queue release reason." }, "call-orig-from-name": { "type": "string", "description": "Caller ID name." }, "call-orig-from-user": { "type": "integer", "description": "Caller's phone number." }, "call-orig-from-uri": { "type": "string", "description": "Full SIP URI of the caller." } } }, "YesNoString": { "type": "string", "enum": [ "yes", "no" ] }, "YesNoStringYesDefault": { "type": "string", "enum": [ "yes", "no" ], "default": "yes" }, "YesNoStringNoDefault": { "type": "string", "enum": [ "yes", "no" ], "default": "no" }, "DomainName": { "type": "string", "description": "This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. ~ and * can be used alone in special cases to mean My Domain (~) and All Domains (\\*). ", "pattern": "^[A-Za-z0-9._-]+|\\*", "maxLength": 64, "examples": [ "example.com" ] }, "DomainNamePath": { "type": "string", "description": "This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. Then using in path for GET you can set to \"~\" to use the domain name linked to your token/key instead of the domain name itself when reading for your own domain. ", "pattern": "^[A-Za-z0-9._-]*|~|\\*+", "maxLength": 64, "examples": [ "example.com", "myDomain", "test.12123" ], "default": "~" }, "UserName": { "type": "string", "examples": [ "1000", "200" ], "description": "This is the main user extension for the user account. " }, "UserNamePath": { "type": "string", "description": "This is the main user extension for the user account. ~ can be used to mean \"my account\" which will extract the user from the token/key used for authentication. ", "examples": [ "1000", "200", "~" ], "minLength": 0, "maxLength": 16, "default": "~" }, "SuccessResponse": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ] }, "ErrorResponse": { "type": "object", "properties": { "code": { "type": "integer", "description": "This is the HTTP error code that was returned." }, "message": { "type": "string", "description": "This is a more detailed description of what the error was and any potential correction steps. " } }, "required": [ "code", "message" ] }, "Count": { "type": "object", "properties": { "total": { "type": "integer" } }, "required": [ "total" ] }, "TimeZone": { "type": "string", "enum": [ "US/Alaska", "US/Central", "US/Eastern", "US/Hawaii", "US/Mountain", "US/Pacific", "Africa/Addis_Ababa", "Africa/Algiers", "Africa/Brazzaville", "Africa/Cairo", "Africa/Casablanca", "Africa/Dakar", "Africa/Dar_es_Salaam", "Africa/Djibouti", "Africa/Johannesburg", "Africa/Khartoum", "Africa/Kigali", "Africa/Kinshasa", "Africa/Lagos", "Africa/Nairobi", "Africa/Timbuktu", "Africa/Tripoli", "Africa/Tunis", "America/Antigua", "America/Aruba", "America/Belize", "America/Bogota", "America/Buenos_Aires", "America/Cancun", "America/Caracas", "America/Cayman", "America/Chihuahua", "America/Costa_Rica", "America/Denver", "America/Detroit", "America/Edmonton", "America/El_Salvador", "America/Ensenada", "America/Grenada", "America/Guadeloupe", "America/Guatemala", "America/Havana", "America/Indianapolis", "America/Jamaica", "America/Juneau", "America/La_Paz", "America/Lima", "America/Los_Angeles", "America/Louisville", "America/Martinique", "America/Mazatlan", "America/Mendoza", "America/Menominee", "America/Merida", "America/Mexico_City", "America/Miquelon", "America/Moncton", "America/Monterrey", "America/Montevideo", "America/Montreal", "America/Montserrat", "America/Nassau", "America/New_York", "America/Panama", "America/Phoenix", "America/Port-au-Prince", "America/Port_of_Spain", "America/Regina", "America/Santiago", "America/Santo_Domingo", "America/Sao_Paulo", "America/Thule", "America/Thunder_Bay", "America/Tijuana", "America/Toronto", "America/Vancouver", "America/Winnipeg", "America/Yellowknife", "Antarctica/South_Pole", "Arctic/Longyearbyen", "Asia/Amman", "Asia/Baghdad", "Asia/Bahrain", "Asia/Bangkok", "Asia/Beirut", "Asia/Brunei", "Asia/Calcutta", "Asia/Colombo", "Asia/Dacca", "Asia/Damascus", "Asia/Dhaka", "Asia/Dubai", "Asia/Gaza", "Asia/Hong_Kong", "Asia/Istanbul", "Asia/Jakarta", "Asia/Jerusalem", "Asia/Kabul", "Asia/Katmandu", "Asia/Kuala_Lumpur", "Asia/Kuching", "Asia/Kuwait", "Asia/Macau", "Asia/Manila", "Asia/Muscat", "Asia/Phnom_Penh", "Asia/Rangoon", "Asia/Riyadh", "Asia/Saigon", "Asia/Seoul", "Asia/Shanghai", "Asia/Singapore", "Asia/Taipei", "Asia/Tehran", "Asia/Tel_Aviv", "Asia/Thimphu", "Asia/Tokyo", "Asia/Ulan_Bator", "Asia/Vientiane", "Asia/Vladivostok", "Atlantic/Azores", "Atlantic/Bermuda", "Atlantic/Canary", "Atlantic/Cape_Verde", "Atlantic/Faeroe", "Atlantic/Reykjavik", "Australia/ACT", "Australia/Adelaide", "Australia/Brisbane", "Australia/Canberra", "Australia/Darwin", "Australia/LHI", "Australia/Melbourne", "Australia/North", "Australia/NSW", "Australia/Perth", "Australia/Queensland", "Australia/South", "Australia/Sydney", "Australia/Tasmania", "Australia/Victoria", "Australia/West", "Canada/Atlantic", "Canada/Central", "Canada/Eastern", "Canada/Mountain", "Canada/Newfoundland", "Canada/Pacific", "Canada/Saskatchewan", "Canada/Yukon", "Cuba", "Etc/GMT", "Etc/GMT+1", "Etc/GMT+10", "Etc/GMT+11", "Etc/GMT+12", "Etc/GMT+2", "Etc/GMT+3", "Etc/GMT+4", "Etc/GMT+5", "Etc/GMT+6", "Etc/GMT+7", "Etc/GMT+8", "Etc/GMT+9", "Etc/GMT-1", "Etc/GMT-10", "Etc/GMT-11", "Etc/GMT-12", "Etc/GMT-13", "Etc/GMT-14", "Etc/GMT-2", "Etc/GMT-3", "Etc/GMT-4", "Etc/GMT-5", "Etc/GMT-6", "Etc/GMT-7", "Etc/GMT-8", "Etc/GMT-9", "Etc/Greenwich", "Europe/Amsterdam", "Europe/Athens", "Europe/Belfast", "Europe/Belgrade", "Europe/Berlin", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "Europe/Copenhagen", "Europe/Dublin", "Europe/Helsinki", "Europe/Istanbul", "Europe/Kiev", "Europe/Lisbon", "Europe/Ljubljana", "Europe/London", "Europe/Madrid", "Europe/Malta", "Europe/Monaco", "Europe/Moscow", "Europe/Oslo", "Europe/Paris", "Europe/Prague", "Europe/Rome", "Europe/Sofia", "Europe/Stockholm", "Europe/Vienna", "Europe/Warsaw", "Europe/Zurich", "Greenwich", "Pacific/Auckland", "Pacific/Easter", "Pacific/Fiji", "Pacific/Galapagos", "Pacific/Gambier", "Pacific/Guam", "Pacific/Honolulu", "Pacific/Marquesas", "Pacific/Midway", "Pacific/Palau", "Pacific/Rarotonga", "Pacific/Tahiti" ], "description": "This is the time zone that the user is primarily located in" }, "Scopes": { "type": "string", "description": "Will link this resource with a User Scope granting it certain permisionf to the system for use in API and Portal. ", "enum": [ "Basic User", "Simple User", "Advanced User", "Call Center Agent", "Site Manager", "Call Center Supervisor", "Office Manager", "No Portal" ], "default": "Basic User" }, "Synchronous": { "type": "string", "enum": [ "yes", "no" ], "writeOnly": true, "default": "no", "description": "When synchronous is requested with \"yes\" the response will be a 200 on success and will contain a valid JSON representiation of the new resource. If no or left off request a 202 \"Accepted\" will be given in a success case and this can be considered a success. Synchronous responses will be a little slower as the API will process the geo replication request and wait till the local copy has been written and can be read back berfore sending a response. " }, "DialruleApplication": { "type": "string", "description": "This is the application that the call will be routed using. It works in partnership with dial-rule-translation-destination-user and dial-rule-translation-destination-host to forward to a next destination. ", "enum": [ "available-number", "to-voicemail-residential", "to-callqueue", "to-callqueue-announce-count-callers-ahead", "to-callqueue-announce-expected-wait-time", "to-connection", "to-connection-or-user-no-failover", "to-single-device", "to-user", "to-user-residential", "to-voicemail", "spam-screening", "to-connection-block-caller-id", "to-connection-no-timeout", "to-connection-add-header-force-caller-id", "to-connection-add-header-no-timeout", "to-connection-add-header", "to-single-device-add-header-allow-voicemail", "to-single-device-add-header-allow-voicemail-residential", "to-single-device-add-header", "to-user-add-header", "to-user-residential-add-header", "to-user-notify-of-recording", "hangup", "to-user-answer-and-fake-ringback", "toggle-timeframe" ] }, "CallqueuePath": { "type": "string", "examples": [ "2000", "all" ], "description": "When used in path the callqueue value will link to a extension id for a preconfigured callqueue. If using agent actions like \"login\" you can use \"all\" to change action for all of the queues the agent is in currently, it can not be used for agent update requests. " }, "AgentPath": { "type": "string", "description": "This is the agent identified to be used to manage a agent in a call queue. The format can be user@domain or sip:device@domain depending on how the queue is indented to be administered. If you are using a auth method with a valid user level access you can use \"~\" and the api will assume the agent is user@domain format and grab that from the token. ", "examples": [ "1000@example.com", "sip:1000wp@example.com" ] }, "AutoAttendantFailOptions": { "type": "string", "enum": [ "repeat", "hangup", "option-1", "option-2", "option-3", "option-4", "option-5", "option-6", "option-7", "option-8", "option-9", "option-0", "option-*", "option-#" ], "default": "repeat" }, "Timestamp": { "type": "string", "enum": [ "YYYY-MM-DDTHH:MM:SS.ssZ" ], "description": "This is the time stamp that the formated via RFC 3339" }, "DeleteType": { "type": "string", "description": "the type of delete to perform", "Instance": "instance", "Meeting": "meeting", "Record": "record", "Attendee": "attendee", "enum": [ "instance", "attendee", "meeting", "record" ] }, "OneZeroDefaultOne": { "type": "integer", "examples": [ 0, 1 ], "default": 1 }, "OneZeroDefaultZero": { "type": "integer", "examples": [ 0, 1 ], "default": 0 }, "MeetingStatus": { "type": "string", "enum": [ "started", "active", "ended", "complete", "deleted" ] }, "RecordingConfiguration": { "type": "string", "description": "Option whether to record calls or not. Available options are \"yes\", \"yes-with-transcription\", \"yes-with-transcription-and-sentiment\", or \"no\"", "enum": [ "yes", "yes-with-transcription", "yes-with-transcription-and-sentiment", "no" ], "default": "no" }, "MessageType": { "type": "string", "examples": [ "chat", "sms", "mms", "chat-media", "chat-video", "chat-participant-(status-changes)" ] }, "MimeTypes": { "type": "string", "examples": [ "image/png", "image/jpeg", "image/gif", "text/html" ] }, "DatetimeStart": { "type": "string", "description": "This is the start of the time window for a given query. The format is based on RFC3339 but also will support additonal params for use in providing a timezone which will allow the API to give the correct range for a given set of data and will be formated in respone using the same format. \n\nSupported formats include. \n* 2023-11-27 13:00:00\n* 2023-11-27T13:00:00Z\n* 2023-11-27T13:00:00-08:00\n* 2023-11-27T13:00:00-08:00[US/Pacific]\n* 2023-11-27T13:00:00Z[America/Phoenix]\n", "format": "rfc3339" }, "DatetimeEnd": { "type": "string", "description": "This is the end of the time window for a given query. The format is based on RFC3339 but also will support additonal params for use in providing a timezone which will allow the API to give the correct range for a given set of data and will be formated in respone using the same format. Allowed values same as datetime-start. ", "format": "rfc3339" }, "RecurringTimeframeType": { "type": "string", "description": "```days-of-week```: Days of Week\n```specific-dates```: Specific Dates\n```holiday```: Holidays\n```custom```: Custom\n```always```: Always" }, "RecurringTimeframeHolidayObservance": { "type": "string", "description": "```observe-on-holiday-only```: Observe only on the exact holiday\n```observe-on-holiday-and-next-day```: Observe on the exact holiday and the next day\n```observe-on-holiday-and-prior-day```: Observe on the exact holiday and the prior day\n```observe-on-exact-date-and-next-workday```: Observe on the exact holiday and the next workday\n```observe-on-holiday-and-prior-workday```: Observe on the exact holiday and the prior workday\n```observe-on-next-workday```: Observe only on the next workday\n```observe-on-prior-workday```: Observe only on the prior workday" }, "Limit": { "type": "number", "format": "int", "default": 100, "minimum": 1, "maximum": 1000, "description": "This is the limit of the number of objects that will be returned in the read/list API call. This can be used with pagination to help retrieve smaller chunks of data. Should be used in conjunction with Start." }, "Start": { "type": "number", "format": "int", "default": 0, "minimum": 0, "description": "This is the start value when using pagination. 0 is the default and the minimum value. For example the default of 0 paired with the default limit of 100 would return the first 100 objects in the data request. A start of 100 and a default limit of 100 would give you the second 100 results in the response." }, "Permission": { "type": "object", "properties": { "dialpolicy": { "type": "string", "description": "The Dial Policy Name" }, "domain": { "type": "string", "description": "The domain the owns the Dial Policy" }, "permission-match": { "type": "string", "description": "The specific match to check against" }, "permission-mode": { "type": "string", "enum": [ "permit", "deny" ], "description": "To allow or deny specific match" }, "permission-reason": { "type": "string", "description": "The description/reason for making the rule. " }, "created-datetime": { "type": "string", "description": "The time the rule was created" }, "permission-id": { "type": "string", "description": "This is the ID fro the permission rule. Its the base64 encode of permission-match, but is needed for edit and delete. \n" } }, "required": [ "dialpolicy", "permission-match", "permission-mode", "permission-reason", "permission-id" ] }, "Dialpolicy": { "type": "object", "properties": { "dialpolicy": { "type": "string", "description": "The Name of the DialPolicy" }, "domain": { "type": "string", "description": "The domain that owns the DialPolicy" }, "description": { "type": "string", "description": "The description of the Policy Table" } }, "required": [ "dialpolicy", "domain", "description" ] }, "DeviceProfileButton": { "type": "object", "properties": { "profile-button-index": { "type": "integer", "description": "This is the index of the button, starting at 1 and going up. " }, "profile-button-type": { "type": "string", "description": "This is the type of button, they will vary by vendo and each one will link to functions available to the button. linekey is an example. \n" }, "profile-button-position": { "type": "string", "description": "This are x/y cordinates for the button in conjuction with the image provided. String in the format like \"[1561,830.5]\"" }, "profile-button-settings": { "type": "string", "description": "Addtional settings field for the button. " } }, "required": [ "profile-button-index", "profile-button-type", "profile-button-position", "profile-button-settings" ] }, "DeviceProfile": { "type": "object", "properties": { "device-models-brand": { "type": "string", "description": "The brand for the profile" }, "device-models-model": { "type": "string", "description": "The model for the profile" }, "device-models-type": { "type": "string", "description": "The type for the profile, in most cases \"phone\" is set. " }, "profile-page-count": { "type": "integer", "description": "The number of pages (if any) available in the profile" }, "profile-sidecar-support": { "type": "array", "items": { "type": "object", "properties": { "device-models-model": { "type": "string" }, "limit": { "type": "integer" } }, "required": [ "device-models-model", "limit" ] }, "description": "A list (if any) of available sidecar models compatable with the phone" }, "buttons": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceProfileButton" }, "description": "List of Available button and their info" }, "image": { "$ref": "#/components/schemas/DeviceImage" }, "devicemodel": { "properties": { "firmware_options": { "type": "string" }, "description": { "type": "string" }, "button_types": { "type": "array", "items": { "type": "object", "properties": { "features": { "type": "array", "items": { "type": "object", "properties": { "feature_type": { "type": "string" }, "autocomplete": { "type": "string" }, "name": { "type": "string" }, "extra_settings": { "type": "array", "items": { "type": "object", "properties": { "Label": { "type": "string" }, "type": { "type": "string" } }, "required": [ "Label", "type" ] } }, "shared": { "type": "boolean" }, "notarget": { "type": "boolean" } }, "required": [ "feature_type", "autocomplete", "name", "extra_settings", "notarget" ] } }, "name": { "type": "string" }, "profile-button-type": { "type": "string" } }, "required": [ "features", "name", "profile-button-type" ] } }, "device-models-brand": { "type": "string" }, "device-models-model": { "type": "string" }, "device-models-type": { "type": "string" }, "device-models-config-format": { "type": "string" }, "device-models-https-enabled": { "type": "string" }, "device-models-tftp-enabled": { "type": "string" }, "device-models-count-buttons": { "type": "integer" }, "device-models-fxs-support-enabled": { "type": "integer" }, "device-models-fxo-support-enabled": { "type": "integer" }, "device-models-trunk-support-enabled": { "type": "integer" }, "device-models-directory-support-enabled": { "type": "string" }, "device-models-presence-support-enabled": { "type": "string" }, "device-models-shared-line-support-enabled": { "type": "string" }, "device-models-sidecar-support-enabled": { "type": "string" }, "device-models-resync-support-enabled": { "type": "string" }, "device-models-encryption-support-enabled": { "type": "string" }, "device-models-firmware-support-enabled": { "type": "string" }, "device-models-overrides-blob": { "type": "string" }, "device-models-visible-in-portal": { "type": "string" }, "device-models-brand-and-model": { "type": "string" } }, "required": [ "firmware_options", "description", "button_types", "device-models-brand", "device-models-model", "device-models-type", "device-models-config-format", "device-models-https-enabled", "device-models-tftp-enabled", "device-models-count-buttons", "device-models-fxs-support-enabled", "device-models-fxo-support-enabled", "device-models-trunk-support-enabled", "device-models-directory-support-enabled", "device-models-presence-support-enabled", "device-models-shared-line-support-enabled", "device-models-sidecar-support-enabled", "device-models-resync-support-enabled", "device-models-encryption-support-enabled", "device-models-firmware-support-enabled", "device-models-overrides-blob", "device-models-visible-in-portal", "device-models-brand-and-model" ], "$ref": "#/components/schemas/DeviceModel" } }, "required": [ "profile-page-count", "profile-sidecar-support", "image", "devicemodel", "device-models-brand", "device-models-model", "device-models-type", "buttons" ] }, "DeviceImage": { "type": "object", "properties": {} }, "DeviceModelButtonType": { "type": "object", "properties": { "device-models-button-feature-type": { "type": "string" }, "device-models-button-feature-name": { "type": "string" }, "shared": { "type": "boolean" }, "notarget": { "type": "boolean" }, "autocomplete": { "type": "string" }, "extra_settings": { "type": "array", "items": { "type": "object", "properties": { "Label": { "type": "string" }, "type": { "type": "string" } }, "required": [ "Label", "type" ] } } }, "required": [ "device-models-button-feature-name" ] }, "InsightValue": { "type": "object", "properties": { "server": { "type": "string", "description": "Optional Server is aggregated by server" }, "value": { "type": "number", "description": "The value " }, "ts": { "type": "integer", "description": "The timestamp for the value. Modulo the expected interval/step" }, "debug-parameters": { "type": "object", "properties": { "query": { "type": "string", "description": "The is the query that is sent to insight" }, "start": { "type": "integer", "description": "The start timestamp" }, "end": { "type": "integer", "description": "The end timestamp" }, "step": { "type": "string", "description": "The interval for which insight will split the data up. " } }, "required": [ "query", "start", "end", "step" ] } }, "required": [ "value", "ts" ] }, "PhoneConfigBtn": { "type": "object", "properties": { "phoneconfiguration-button-order": { "type": "integer", "description": "This is the button order, It will increment from the first button and will continue through all the sidecar buttons. " }, "phoneconfiguration-button-type": { "type": "string", "description": "Type of button that will link to the NDP server's building of the button. Needs to match oiptions available in vendor/model. \n" }, "phoneconfiguration-button-feature": { "type": "string", "description": "This is the main feature type. Common ones inlcude line, blf, park,speed_dial, queue_status, timeframe_status" }, "phoneconfiguration-button-target": { "type": [ "string", "integer", "boolean", "array", "object", "number", "null" ], "description": "This is the main setting mapping the resouce to the button. example would be the extension or queue name in many cases. " }, "phoneconfiguration-button-label": { "type": "string", "description": "Any lable override will go here if wish to change/force the text to be displayed. \n" }, "phoneconfiguration-button-locked": { "type": [ "integer", "null" ], "description": "If wanting to lock a button from editing by UI, set to 1. " }, "phoneconfiguration-extra": { "type": [ "object", "null" ], "properties": { "timeframe": { "type": "string", "description": "timeframe used in timeframe features" }, "targetUser": { "type": "string", "description": "targetUser in cases where editing another user. \n" }, "dynamic": { "type": "boolean", "description": "Set to true for dynamic BLF" } }, "description": "optional set of extra params. " } }, "required": [ "phoneconfiguration-button-order", "phoneconfiguration-button-type", "phoneconfiguration-button-feature", "phoneconfiguration-button-locked" ] }, "SmsBlock": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID for the SMS block . Will be auto generated on addition" }, "requesting-number": { "type": "string", "description": "This is the number that is requesting the block be added against the blocked-number. ", "format": "e164", "examples": [ "+18585551234" ] }, "blocked-number": { "type": "string", "format": "e164", "examples": [ "+18585551234" ], "description": "This is the number that will be blocked from sending new SMS to the requesting-number" }, "domain": { "type": "string", "description": "Domain owning this block" }, "status": { "type": "string", "description": "active/inactive", "enum": [ "active", "inactive" ], "default": "active" }, "created-datetime": { "type": "string", "format": "date-time" }, "last-modified-datetime": { "type": "string", "format": "date-time" } }, "required": [ "id", "requesting-number", "blocked-number", "domain" ] } }, "securitySchemes": { "bearer": { "type": "http", "scheme": "bearer", "description": "Your Snapcom API key, sent as `Authorization: Bearer nsd_...`." }, "bearerAuth": { "type": "http", "scheme": "bearer", "description": "Your Snapcom API key, sent as `Authorization: Bearer nsd_...`." } } }, "servers": [ { "url": "https://developer.snapcom.com/api/v2", "description": "Snapcom API" } ], "security": [ { "bearerAuth": [] } ] }