{ "opencollection": "1.0.0", "info": { "name": "Infobip OpenAPI Specification", "version": "3.210.0" }, "items": [ { "info": { "name": "customer-engagement", "type": "folder" }, "items": [ { "info": { "name": "Get a single person or a list of people", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/people/2/persons", "params": [ { "name": "identifier", "value": "370329180020364", "type": "query", "description": "Person ID. ID type must match the `type` parameter. Some channels (e,g., Apple Business Chat) use identifiers that contain unsafe characters. Make sure you URL-encode them in your API request" }, { "name": "sender", "value": "2094832040560427", "type": "query", "description": "Sender or application ID. `sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`" }, { "name": "type", "value": "PHONE", "type": "query", "description": "Type of the person ID" }, { "name": "limit", "value": "20", "type": "query", "description": "Number of persons to return per page. Default - 20. Maximum - 1000." }, { "name": "page", "value": "1", "type": "query", "description": "Page of results to return. Default - 1." }, { "name": "includeTotalCount", "value": "false", "type": "query", "description": "Returns total count of persons, if set to `true`." }, { "name": "orderBy", "value": "modifiedAt:desc", "type": "query", "description": "Results ordering. Possible ordering fields are `firstName`, `lastName`, `createdAt` and `modifiedAt`. Ordering direction can be specified with modifiers `asc` for the ascending ordering or `desc` for the descending one." }, { "name": "filter", "value": "{\"#and\":[{\"firstName\":\"Alex\"},{\"#contains\": { \"tags\":\"VIP Client\"}}]}}", "type": "query", "description": "Allows to filter persons using simple queries. Just pass to the parameter [URL encoded](https://www.w3schools.com/tags/ref_urlencode.asp) query.\n##### List of supported logical operators:\n\n\n\n\n\n\n\n\n\n\n\n
Logical OperatorDescription
#andJoins query clauses with a logical AND returns all records that match the conditions of both clauses.
#orJoins query clauses with a logical OR returns all records that match the conditions of either clause.
\n\n##### List of supported comparison operators:\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Comparison OperatorSupported TypeDescription
#eqstring, integer, decimal, dateMatches values that are equal to a specified value.
#nestring, integer, decimal, dateMatches all values that are not equal to a specified value.
#containsstringMatches the records that contain the specified value.
#notContainstringMatches the records that does not contain the specified value.
#startsWithstringMatches the records that start with a specified value.
#endsWithstringMatches the records that end with a specified value.
#gtinteger, decimal, dateMatches values that are greater than a specified value.
#ltinteger, decimal, dateMatches values that are less than a specified value.
#gteinteger, decimal, dateMatches values that are greater than or equal to a specified value.
#lteinteger, decimal, dateMatches values that are less than or equal to a specified value.
\n" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Use this method with a unique person identifier to get a single person. Skip the identifier to return all people or use the `filter` parameter to return a list of people matching your specific conditions." }, { "info": { "name": "Create a new person", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/people/2/persons", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Use this method to create a new person." }, { "info": { "name": "Update a person", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/people/2/persons", "params": [ { "name": "identifier", "value": "370329180020364", "type": "query", "description": "Person ID. ID type must match the `type` parameter. Some channels (e,g., Apple Business Chat) use identifiers that contain unsafe characters. Make sure you URL-encode them in your API request" }, { "name": "sender", "value": "2094832040560427", "type": "query", "description": "Sender or application ID. `sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`" }, { "name": "type", "value": "PHONE", "type": "query", "description": "Type of the person ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Use this method to overwrite a person profile with the data passed in the request body as follows:
1. New values for standard and custom profile attributes replace existing values on the profile. If no value is passed in the request, the attribute is set to empty.
2. Tags in the request replace the existing profile tags. If no tags are passed, the existing profile tag list is cleared.
3. New contact information (email addresses and phone numbers) in the request replaces the current info" }, { "info": { "name": "Partial person update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/people/2/persons", "params": [ { "name": "identifier", "value": "370329180020364", "type": "query", "description": "Person ID. ID type must match the `type` parameter. Some channels (e,g., Apple Business Chat) use identifiers that contain unsafe characters. Make sure you URL-encode them in your API request" }, { "name": "sender", "value": "2094832040560427", "type": "query", "description": "Sender or application ID. `sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`" }, { "name": "type", "value": "PHONE", "type": "query", "description": "Type of the person ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Use this method to update a person profile with the data passed in the request body as follows:
1. New values for standard and custom profile attributes replace existing values on the profile. If no value is passed in the request, the attribute keeps its value.
2. Tags in the request are appended to the profile tag list.
3. New contact information (email addresses and phone numbers) in the request is appended to the contact list of the profile." }, { "info": { "name": "Delete a person", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/people/2/persons", "params": [ { "name": "identifier", "value": "370329180020364", "type": "query", "description": "Person ID. ID type must match the `type` parameter. Some channels (e,g., Apple Business Chat) use identifiers that contain unsafe characters. Make sure you URL-encode them in your API request" }, { "name": "sender", "value": "2094832040560427", "type": "query", "description": "Sender or application ID. `sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`" }, { "name": "type", "value": "PHONE", "type": "query", "description": "Type of the person ID" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Use this method to delete a person." }, { "info": { "name": "Set contact information to person", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/people/2/persons/contactInformation", "params": [ { "name": "identifier", "value": "370329180020364", "type": "query", "description": "Person ID. ID type must match the `type` parameter. Some channels (e,g., Apple Business Chat) use identifiers that contain unsafe characters. Make sure you URL-encode them in your API request" }, { "name": "sender", "value": "2094832040560427", "type": "query", "description": "Sender or application ID. `sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`" }, { "name": "type", "value": "PHONE", "type": "query", "description": "Type of the person ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Use this method to replace contact information for a particular person. This methods will replace all existing emails and mobile phones with new contact information." }, { "info": { "name": "Add contact information to person", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/people/2/persons/contactInformation", "params": [ { "name": "identifier", "value": "370329180020364", "type": "query", "description": "Person ID. ID type must match the `type` parameter. Some channels (e,g., Apple Business Chat) use identifiers that contain unsafe characters. Make sure you URL-encode them in your API request" }, { "name": "sender", "value": "2094832040560427", "type": "query", "description": "Sender or application ID. `sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`" }, { "name": "type", "value": "PHONE", "type": "query", "description": "Type of the person ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Use this method to add emails and mobile phones to a particular person." }, { "info": { "name": "Delete contact information from person", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/people/2/persons/contactInformation", "params": [ { "name": "identifier", "value": "370329180020364", "type": "query", "description": "Person ID. ID type must match the `type` parameter. Some channels (e,g., Apple Business Chat) use identifiers that contain unsafe characters. Make sure you URL-encode them in your API request" }, { "name": "sender", "value": "2094832040560427", "type": "query", "description": "Sender or application ID. `sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`" }, { "name": "type", "value": "PHONE", "type": "query", "description": "Type of the person ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Use this method to delete specified emails and mobile phones from a particular person." }, { "info": { "name": "Batch people create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/people/2/persons/batch", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Use this method to create multiple persons.
**NOTE** Array size of the batch create request is limited to `1000` persons." }, { "info": { "name": "Batch people update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/people/2/persons/batch", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Use this method to update multiple person profiles with the data passed in the request body as follows:
1. New values for standard and custom profile attributes replace existing values on the profile. If no value is passed in the request, the attribute keeps its value.
2. Tags in the request are appended to the profile tag list.
3. New contact information (email addresses and phone numbers) in the request is appended to the contact list of the profile.
**NOTE** Array size of the batc" }, { "info": { "name": "Batch people delete", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/people/2/persons/batch", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Use this method to delete multiple persons.
**NOTE** Array size of the batch delete request is limited to `1000` persons." }, { "info": { "name": "Match profiles", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/people/2/persons/match", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to match a list of identities against existing person profiles in People. For each successfully matched identity the internal ID of the person profile will be returned. Duplicate identities will fetch a single profile reference." }, { "info": { "name": "Batch merge profiles", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/people/3/persons/merge", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to merge multiple person profiles belonging to the same user based on matching identifiers such as external ID, email, phone, and other contact information. The standard merge logic applies: the system selects a primary profile and consolidates fields and events from the secondary profiles into it. More information about the merge logic is available in the [People documentation](https://www.infobip.com/docs/people/synchronize-your-audience#merge-duplicate).
Any data included " }, { "info": { "name": "Batch full people upsert", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/people/3/persons/upsert", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to create or fully replace person profiles by matching on identifiers such as external ID, email, or phone. If a match is identified, the existing profile is entirely replaced with the provided data; any fields excluded from the request will be cleared. If no match is identified, a new profile is created. The operation returns a status for each profile: CREATED, UPDATED, or NOT_MODIFIED.
**Notes:**
1. The batch size limit is 1000 persons.
2. Contact information (emails" }, { "info": { "name": "Batch partial people upsert", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/people/3/persons/upsert", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to create or partially update person profiles by matching on identifiers such as external ID, email, or phone. If a match is identified, the existing profile is updated only with the provided data; any fields excluded from the request remain unchanged. If no match is identified, a new profile is created. The operation returns a status for each profile: CREATED, UPDATED, or NOT_MODIFIED.
**Notes:**
1. The batch size limit is 1000 persons.
2. Contact information (emails" }, { "info": { "name": "Get a single company or a list of companies", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/people/2/companies", "params": [ { "name": "name", "value": "Infobip", "type": "query", "description": "Name of company you want to get." }, { "name": "id", "value": "11351351", "type": "query", "description": "ID of company you want to get." }, { "name": "externalId", "value": "11351351", "type": "query", "description": "External ID of company you want to get." }, { "name": "domain", "value": "www.infobip.com", "type": "query", "description": "Domain of company you want to get." }, { "name": "limit", "value": "20", "type": "query", "description": "Number of companies to return per page. Default - 20. Maximum - 1000." }, { "name": "page", "value": "1", "type": "query", "description": "Page of results to return. Default - 1." }, { "name": "includeTotalCount", "value": "false", "type": "query", "description": "Returns total count of companies, if set to `true`." }, { "name": "orderBy", "value": "modifiedAt:desc", "type": "query", "description": "Results ordering. Possible ordering fields are `name`, `createdAt` and `modifiedAt`. Ordering direction can be specified with modifiers `asc` for the ascending ordering or `desc` for the descending one." }, { "name": "filter", "value": "{\"#or\":[{\"name\":\"infobip\"},{\"#contains\":{\"notes\":\"another\"}}]}", "type": "query", "description": "Allows to filter companies using simple queries. Just pass to the parameter [URL encoded](https://www.w3schools.com/tags/ref_urlencode.asp) query.\n##### List of supported logical operators:\n\n\n\n\n\n\n\n\n\n\n\n
Logical OperatorDescription
#andJoins query clauses with a logical AND returns all records that match the conditions of both clauses.
#orJoins query clauses with a logical OR returns all records that match the conditions of either clause.
\n\n##### List of supported comparison operators:\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Comparison OperatorSupported TypeDescription
#eqstring, integer, decimal, dateMatches values that are equal to a specified value.
#nestring, integer, decimal, dateMatches all values that are not equal to a specified value.
#containsstringMatches the records that contain a specified value.
#startsWithstringMatches the records that start with a specified value.
#endsWithstringMatches the records that end with a specified value.
#gtinteger, decimal, dateMatches values that are greater than a specified value.
#ltinteger, decimal, dateMatches values that are less than a specified value.
#gteinteger, decimal, dateMatches values that are greater than or equal to a specified value.
#lteinteger, decimal, dateMatches values that are less than or equal to a specified value.
\n" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Use this method with a query parameter to get a single company. If the query parameter is not specified, this method will return a list of companies." }, { "info": { "name": "Create a new company", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/people/2/companies", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Use this method to create a new company." }, { "info": { "name": "Partial company update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/people/2/companies", "params": [ { "name": "id", "value": "11351351", "type": "query", "description": "ID of company you want to update." }, { "name": "externalId", "value": "11351351", "type": "query", "description": "External ID of company you want to update." }, { "name": "name", "value": "Infobip", "type": "query", "description": "Name of company you want to update." }, { "name": "domain", "value": "company-domain.com", "type": "query", "description": "Domain of company you want to update." }, { "name": "replaceTags", "value": "false", "type": "query", "description": "Flag which indicates tag replacement operation." }, { "name": "replaceDomains", "value": "false", "type": "query", "description": "Flag which indicates domain replacement operation." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Partial company update method is used for updating a part of the company information. Exactly one of the query parameters must be included in the query." }, { "info": { "name": "Delete a company", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/people/2/companies", "params": [ { "name": "id", "value": "11351351", "type": "query", "description": "ID of company you want to delete." }, { "name": "externalId", "value": "11351351", "type": "query", "description": "External ID of company you want to delete." }, { "name": "name", "value": "Infobip", "type": "query", "description": "Name of company you want to delete." }, { "name": "domain", "value": "company-domain.com", "type": "query", "description": "Domain of company you want to delete." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Use this method with a query parameter to delete a company. Exactly one of the query parameters must be included in the query." }, { "info": { "name": "Batch companies create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/people/2/companies/batch", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Use this method to create multiple companies.
**NOTE** Array size of the batch create request is limited to `1000` companies." }, { "info": { "name": "Batch companies update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/people/2/companies/batch", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Use this method to update multiple companies.
**NOTE** Array size of the batch update request is limited to `1000` companies." }, { "info": { "name": "Batch companies delete", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/people/2/companies/batch", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Use this method to delete multiple companies.
**NOTE** Array size of the batch delete request is limited to `1000` companies." }, { "info": { "name": "Add persons to company batch", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/people/2/companies/persons", "params": [ { "name": "id", "value": "11351351", "type": "query", "description": "ID of company you want to assign persons to." }, { "name": "externalId", "value": "11351351", "type": "query", "description": "External ID of company you want to assign persons to." }, { "name": "name", "value": "Infobip", "type": "query", "description": "Name of company you want to assign persons to." }, { "name": "domain", "value": "www.infobip.com", "type": "query", "description": "Domain of company you want to assign persons to." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Use this method to add persons to a company.
**NOTE** Array size is limited to `1000` persons." }, { "info": { "name": "Remove persons from company batch", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/people/2/companies/persons", "params": [ { "name": "id", "value": "11351351", "type": "query", "description": "ID of company you want to remove persons from." }, { "name": "externalId", "value": "11351351", "type": "query", "description": "External ID of company you want to remove persons from." }, { "name": "name", "value": "Infobip", "type": "query", "description": "Name of company you want to remove persons from." }, { "name": "domain", "value": "www.infobip.com", "type": "query", "description": "Domain of company you want to remove persons from." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Use this method to remove persons from a company.
**NOTE** Array size is limited to `1000` persons." }, { "info": { "name": "Get list of tags", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/people/2/tags", "params": [ { "name": "limit", "value": "100", "type": "query", "description": "Number of tags to return per page. Default - 20. Maximum - 1000." }, { "name": "page", "value": "1", "type": "query", "description": "Page of results to return. Default - 1." }, { "name": "orderBy", "value": "name:asc", "type": "query", "description": "Results ordering. Possible ordering fields are `name`, `createdAt` and `modifiedAt`. Ordering direction can be specified with modifiers `asc` for the ascending ordering or `desc` for the descending one." }, { "name": "includeTotalCount", "value": "false", "type": "query", "description": "Returns total count of tags, if set to `true`." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Use this method to get a list of tags with pagination." }, { "info": { "name": "Create a new tag", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/people/2/tags", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Use this method to create a new tag." }, { "info": { "name": "Get a tag", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/people/2/tags/:name", "params": [ { "name": "name", "value": "Vip", "type": "path", "description": "Name of the tag." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Use this method to get a single tag." }, { "info": { "name": "Delete a tag", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/people/2/tags/:name", "params": [ { "name": "name", "value": "Vip", "type": "path", "description": "Name of the tag." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Use this method to delete the existing tag." }, { "info": { "name": "Add tag to people batch", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/people/2/tags/:name/persons", "params": [ { "name": "name", "value": "Vip", "type": "path", "description": "Name of the tag." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "This method allows you to assign tag to multiple people.
**NOTE** Array size of the batch add request is limited to `1000` people." }, { "info": { "name": "Remove tag from people batch", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/people/2/tags/:name/persons", "params": [ { "name": "name", "value": "Vip", "type": "path", "description": "Name of the tag." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "This method allows you to remove tag from multiple people.
**NOTE** Array size of the batch remove request is limited to `1000` people." }, { "info": { "name": "Get a list of custom attributes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/people/2/customAttributes", "params": [ { "name": "limit", "value": "100", "type": "query", "description": "Number of custom attributes to return per page. Default - 20. Maximum - 1000." }, { "name": "page", "value": "1", "type": "query", "description": "Page of results to return. Default - 1." }, { "name": "includeTotalCount", "value": "false", "type": "query", "description": "Returns total count of custom attributes, if set to `true`." }, { "name": "orderBy", "value": "name:asc", "type": "query", "description": "Results ordering. Possible ordering fields are `name`, `createdAt` and `modifiedAt`. Ordering direction can be specified with modifiers `asc` for the ascending ordering or `desc` for the descending one." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Get a list of custom attributes using this method." }, { "info": { "name": "Create a custom attribute", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/people/2/customAttributes", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create a new custom attribute by using this method." }, { "info": { "name": "Get a single custom attribute", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/people/2/customAttributes/:name", "params": [ { "name": "name", "value": "Contract Expiry Date", "type": "path", "description": "Name of the attribute." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Get a single custom attribute using this method." }, { "info": { "name": "Delete a custom attribute", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/people/2/customAttributes/:name", "params": [ { "name": "name", "value": "Attribute", "type": "path", "description": "Name of the attribute you want to delete." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Use this method to delete the custom attribute" }, { "info": { "name": "Append item to custom attribute", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/people/2/customAttributes/:name/append", "params": [ { "name": "identifier", "value": "370329180020364", "type": "query", "description": "Person ID. ID type must match the `type` parameter. Some channels (e,g., Apple Business Chat) use identifiers that contain unsafe characters. Make sure you URL-encode them in your API request" }, { "name": "sender", "value": "2094832040560427", "type": "query", "description": "Sender or application ID. `sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`" }, { "name": "type", "value": "PHONE", "type": "query", "description": "Type of the person ID" }, { "name": "name", "value": "ShoppingCartList", "type": "path", "description": "Name of the list type custom attribute" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Custom attributes with `LIST_OF_OBJECTS` type contain an array of items as a value. Using this API method, you can add a new item to the specified list type custom attribute of a specific person. The item you want to add should match the defined list schema." }, { "info": { "name": "Get items", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/people/3/lists/:listName/items", "params": [ { "name": "listName", "value": "", "type": "path", "description": "Name of the list attribute." }, { "name": "type", "value": "", "type": "query", "description": "Type of the person ID. Can be one of the above." }, { "name": "identifier", "value": "", "type": "query", "description": "Person ID. ID type must match the `type` parameter." }, { "name": "sender", "value": "", "type": "query", "description": "Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`" }, { "name": "itemIds", "value": "", "type": "query", "description": "UUIDs of list items to return, separated by commas (,)." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get a single item or a list of items of a list attribute." }, { "info": { "name": "Append items", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/people/3/lists/:listName/items", "params": [ { "name": "listName", "value": "", "type": "path", "description": "Name of the list attribute." }, { "name": "type", "value": "", "type": "query", "description": "Type of the person ID. Can be one of the above." }, { "name": "identifier", "value": "", "type": "query", "description": "Person ID. ID type must match the `type` parameter." }, { "name": "sender", "value": "", "type": "query", "description": "Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Adds new items to a list attribute and returns all items of the updated list." }, { "info": { "name": "Delete items", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/people/3/lists/:listName/items", "params": [ { "name": "listName", "value": "", "type": "path", "description": "Name of the list attribute." }, { "name": "type", "value": "", "type": "query", "description": "Type of the person ID. Can be one of the above." }, { "name": "identifier", "value": "", "type": "query", "description": "Person ID. ID type must match the `type` parameter." }, { "name": "sender", "value": "", "type": "query", "description": "Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`" }, { "name": "itemIds", "value": "", "type": "query", "description": "UUIDs of list items to delete, separated by commas (,)." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Deletes items in a list attribute and returns all items of the updated list." }, { "info": { "name": "Replace an item", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/people/3/lists/:listName/items/:itemId", "params": [ { "name": "listName", "value": "", "type": "path", "description": "Name of the list attribute." }, { "name": "itemId", "value": "", "type": "path", "description": "UUID of the list item to replace." }, { "name": "type", "value": "", "type": "query", "description": "Type of the person ID. Can be one of the above." }, { "name": "identifier", "value": "", "type": "query", "description": "Person ID. ID type must match the `type` parameter." }, { "name": "sender", "value": "", "type": "query", "description": "Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Replaces an item of a list attribute and returns all items of the updated list." }, { "info": { "name": "Update an item", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/people/3/lists/:listName/items/:itemId", "params": [ { "name": "listName", "value": "", "type": "path", "description": "Name of the list attribute." }, { "name": "itemId", "value": "", "type": "path", "description": "UUID of the list item to update." }, { "name": "type", "value": "", "type": "query", "description": "Type of the person ID. Can be one of the above." }, { "name": "identifier", "value": "", "type": "query", "description": "Person ID. ID type must match the `type` parameter." }, { "name": "sender", "value": "", "type": "query", "description": "Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Updates the fields of a list item that are passed in the request.\nMissing fields will keep their values.\nReturns all items of the updated list attribute." }, { "info": { "name": "Get lists", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/people/3/lists", "params": [ { "name": "listNames", "value": "", "type": "query", "description": "Names of list attributes to return, separated by commas (,)." }, { "name": "type", "value": "", "type": "query", "description": "Type of the person ID. Can be one of the above." }, { "name": "identifier", "value": "", "type": "query", "description": "Person ID. ID type must match the `type` parameter." }, { "name": "sender", "value": "", "type": "query", "description": "Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Returns all items of a single or multiple list attributes." }, { "info": { "name": "Delete lists", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/people/3/lists", "params": [ { "name": "listNames", "value": "", "type": "query", "description": "Names of list attributes to delete, separated by commas (,)." }, { "name": "type", "value": "", "type": "query", "description": "Type of the person ID. Can be one of the above." }, { "name": "identifier", "value": "", "type": "query", "description": "Person ID. ID type must match the `type` parameter." }, { "name": "sender", "value": "", "type": "query", "description": "Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Deletes a single or multiple list attributes of a profile." }, { "info": { "name": "Replace a list", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/people/3/lists/:listName", "params": [ { "name": "listName", "value": "", "type": "path", "description": "Name of the list attribute." }, { "name": "type", "value": "", "type": "query", "description": "Type of the person ID. Can be one of the above." }, { "name": "identifier", "value": "", "type": "query", "description": "Person ID. ID type must match the `type` parameter." }, { "name": "sender", "value": "", "type": "query", "description": "Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Replaces all items in a list attribute and returns all items of the updated list." }, { "info": { "name": "Update a list", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/people/3/lists/:listName", "params": [ { "name": "listName", "value": "", "type": "path", "description": "Name of the list attribute." }, { "name": "type", "value": "", "type": "query", "description": "Type of the person ID. Can be one of the above." }, { "name": "identifier", "value": "", "type": "query", "description": "Person ID. ID type must match the `type` parameter." }, { "name": "sender", "value": "", "type": "query", "description": "Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Updates the fields of list items passed in the request.\nMissing items and fields will keep their values.\nReturns all items of the updated list." }, { "info": { "name": "Get items", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/people/2/persons/:personId/lists/:listName/items", "params": [ { "name": "personId", "value": "", "type": "path", "description": "Person's internal ID." }, { "name": "listName", "value": "", "type": "path", "description": "Name given to a list." }, { "name": "itemIds", "value": "", "type": "query", "description": "List of identifiers for items. Every identifier should be UUID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Returns a single item or set of items of a list." }, { "info": { "name": "Append items", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/people/2/persons/:personId/lists/:listName/items", "params": [ { "name": "personId", "value": "", "type": "path", "description": "Person's internal ID." }, { "name": "listName", "value": "", "type": "path", "description": "Name given to a list.
If an instance of a list doesn't exist for a person, the list instance will be created." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Adds new items to a list and returns all items of the updated list." }, { "info": { "name": "Delete items", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/people/2/persons/:personId/lists/:listName/items", "params": [ { "name": "personId", "value": "", "type": "path", "description": "Person's internal ID." }, { "name": "listName", "value": "", "type": "path", "description": "Name given to a list." }, { "name": "itemIds", "value": "", "type": "query", "description": "List of identifiers for items. Every identifier should be UUID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Deletes items with given identifiers and returns rest items of the updated list." }, { "info": { "name": "Replace an item", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/people/2/persons/:personId/lists/:listName/items/:itemId", "params": [ { "name": "personId", "value": "", "type": "path", "description": "Person's internal ID." }, { "name": "listName", "value": "", "type": "path", "description": "Name given to a list.
If an instance of a list doesn't exist for a person, the list instance will be created." }, { "name": "itemId", "value": "", "type": "path", "description": "Identifier of an item to replace.
Identifier should be UUID.
Value of __id-field passed in a body will be replaced by the current value.
If an item with a given identifier doesn't exist, it will be created." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Replaces an item of a list and returns all items of the updated list." }, { "info": { "name": "Update an item", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/people/2/persons/:personId/lists/:listName/items/:itemId", "params": [ { "name": "personId", "value": "", "type": "path", "description": "Person's internal ID." }, { "name": "listName", "value": "", "type": "path", "description": "Name given to a list." }, { "name": "itemId", "value": "", "type": "path", "description": "Identifier of an item to update.
Identifier should be UUID.
Value of __id-field passed in a body will be replaced by the current value." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Updates only fields of the item that are presented in a given data.
Missing fields will be preserved.
Returns all items of the updated list." }, { "info": { "name": "Get lists", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/people/2/persons/:personId/lists", "params": [ { "name": "personId", "value": "", "type": "path", "description": "Person's internal ID." }, { "name": "listNames", "value": "", "type": "query", "description": "Names given to lists." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Returns all items of a single list or sets of items of a set of lists." }, { "info": { "name": "Delete lists", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/people/2/persons/:personId/lists", "params": [ { "name": "personId", "value": "", "type": "path", "description": "Person's internal ID." }, { "name": "listNames", "value": "", "type": "query", "description": "Names given to lists." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Deletes a single list instance or set of lists instanses for a person." }, { "info": { "name": "Replace a list", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/people/2/persons/:personId/lists/:listName", "params": [ { "name": "personId", "value": "", "type": "path", "description": "Person's internal ID." }, { "name": "listName", "value": "", "type": "path", "description": "Name given to a list.
If an instance of a list doesn't exist for a person, the list instance will be created." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Replaces a list and returns all items of the updated list." }, { "info": { "name": "Update a list", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/people/2/persons/:personId/lists/:listName", "params": [ { "name": "personId", "value": "", "type": "path", "description": "Person's internal ID." }, { "name": "listName", "value": "", "type": "path", "description": "Name given to a list." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Updates only items and fields for a given data set.
Missing items and fields will be preserved.
Returns all items of the updated list." }, { "info": { "name": "Get push device registration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/people/2/contactInformation/push/:pushRegId", "headers": [ { "name": "AppCode", "value": "" } ], "params": [ { "name": "pushRegId", "value": "", "type": "path", "description": "Registration identifier of a particular push device registration" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to get device data" }, { "info": { "name": "Update push device registration", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/people/2/contactInformation/push/:pushRegId", "headers": [ { "name": "AppCode", "value": "" } ], "params": [ { "name": "pushRegId", "value": "", "type": "path", "description": "Registration identifier of a particular push device registration" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to update device data" }, { "info": { "name": "Depersonalize push instance", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/people/2/contactInformation/push/:pushRegId/depersonalize", "headers": [ { "name": "AppCode", "value": "" } ], "params": [ { "name": "pushRegId", "value": "", "type": "path", "description": "Registration identifier of a particular push device registration" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "You can depersonalize a device to detach it from a current person profile so that the device won’t receive messages when targeted by any of the person attributes" }, { "info": { "name": "Personalize push instance", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/people/2/contactInformation/push/:pushRegId/personalize", "headers": [ { "name": "AppCode", "value": "" } ], "params": [ { "name": "forceDepersonalize", "value": "", "type": "query", "description": "You can set this parameter to true if you want previous personalization to be always reset. Do not use this parameter if you want to know when there’s an attempt to personalize already personalized registration." }, { "name": "keepAsLead", "value": "", "type": "query", "description": "You can set this parameter to true if you want to prevent the promotion from Lead to Customer. Only for specific use cases where the default behaviour wants to be avoided." }, { "name": "returnPush", "value": "", "type": "query", "description": "You can set this parameter to true if you want the response to include \"push\" mobile app contact information for the person." }, { "name": "setDeviceAsPrimary", "value": "", "type": "query", "description": "You can set this parameter to true if you want to set the device associated with the \"pushRegId\" as primary device for the person." }, { "name": "pushRegId", "value": "", "type": "path", "description": "Registration identifier of a particular push device registration" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Each person can have Phone numbers, Emails or External ID. These fields are unique identifiers of a person on Infobip platform and provide a capability to personalize any push device registration with a person profile. The platform provides data grouping functions based on these parameters. For example, if two devices will try to save the same Phone number, then both of them will be collected under a single person. Phone number, Email and External ID are also widely used when targeting users wit" }, { "info": { "name": "Batch Send Events", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/people/3/events", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Use this endpoint to batch import People events, including historical events that occurred up to `30` days ago. Batch items must reference an existing person profile and predefined [event type](https://portal.infobip.com/people/events/definitions). You can send up to `5000` events in a single batch. Each individual item within a batch must not exceed `512,000` bytes. The entire batch, which includes all items combined, must not exceed `15,728,640` bytes.
Each event in the batch must reference" }, { "info": { "name": "Send Event", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/peopleevents/2/persons/:personId/definitions/:definitionId/events", "params": [ { "name": "definitionId", "value": "", "type": "path", "description": "Identifier of the custom event definition. Event properties are passed in the request body." }, { "name": "personId", "value": "", "type": "path", "description": "Identifier of the person who performed the event. The `identifierType` query parameter specifies the type of the ID." }, { "name": "identifierType", "value": "", "type": "query", "description": "Person's identifier type." }, { "name": "createPerson", "value": "", "type": "query", "description": "Set this parameter to `true` to automatically create a person profile with the specified `personId` and `identifierType` if no existing profile matches the provided identifier. The default value is `false`.
**Note**: New profiles can only be created for the following identifier types: `PHONE`, `EMAIL`, or `EXTERNAL_ID`." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Use this endpoint to track events that persons perform. Your request must refer to existing person profile and [event definition](https://portal.infobip.com/people/events/definitions)." }, { "info": { "name": "List Event Definitions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/peopleevents/2/definitions", "params": [ { "name": "offset", "value": "", "type": "query", "description": "A pagination parameter that specifies the number of records to skip before starting to return results." }, { "name": "limit", "value": "", "type": "query", "description": "A pagination parameter that specifies the maximum number of records to return in a single response." }, { "name": "orderType", "value": "", "type": "query", "description": "Defines the sort direction for the results.
**Note**: If `orderField` is not provided, this parameter will not have any effect." }, { "name": "orderField", "value": "", "type": "query", "description": "Specifies the field by which the results should be ordered.
**Note**: If `orderType` is not provided, ordering will not work." }, { "name": "category", "value": "", "type": "query", "description": "Filters results by one or more event definition categories." }, { "name": "searchText", "value": "", "type": "query", "description": "Text used for searching event definitions by definition ID, title, or description." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Retrieve a paginated list of event definitions, including standard, custom, and template definitions. Use query parameters to filter by category (`External`, `Person`, `Channel`, `Product`, `Template`) or search by definition ID, title, or description. Results can be ordered by definition ID or title." }, { "info": { "name": "Create Event Definition", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/peopleevents/2/definitions", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create a new custom event definition either from scratch or from a template. When creating from scratch, specify a unique definition ID (alphanumeric only, max `36` characters), title, description, and up to `120` fields. When using a template, only provide the template ID and optional additional fields—the title, description, and default fields are inherited from the template. Supports various field types including `String`, `Boolean`, `DateTime`, `Numeric`, `Decimal`, and `List` (with nested o" }, { "info": { "name": "Get Event Definition", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/peopleevents/2/definitions/:definitionId", "params": [ { "name": "definitionId", "value": "", "type": "path", "description": "Event definition identifier." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Retrieve complete details of a specific event definition, including its fields, data types, category, and whether it's a standard or custom definition. Useful for understanding the schema before sending events or for validating your event data structure." }, { "info": { "name": "Update Event Definition", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/peopleevents/2/definitions/:definitionId", "params": [ { "name": "definitionId", "value": "", "type": "path", "description": "Event definition identifier." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Update an existing custom event definition by adding new fields or modifying the title and description. Only supports additive changes—you can add new fields but **cannot** remove existing fields or change their types. This ensures backward compatibility with historical events. Standard (internal) definitions and template-inherited properties cannot be modified." }, { "info": { "name": "Submit event export request", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/peopleevents/1/export", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Events export allows you to asynchronously export People Events data to a compressed file or multiple files in your AWS S3 bucket.\n\nRefer to [product documentation](https://www.infobip.com/docs/people/events#events-in-external-systems) for detailed information on configuring AWS S3 for export, export file format and event data schema. \n\n**Throttling**\n\nYou can have maximum of 72 hours worth of export requests in progress at one time.\n\n" }, { "info": { "name": "Check status of event export request", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/peopleevents/1/export/status/:requestId", "params": [ { "name": "requestId", "value": "", "type": "path", "description": "Request ID (unique identifier) of a previously submitted data export request." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Retrieves the status of a previously submitted data export request by the request ID." }, { "info": { "name": "Asynchronous cancellation of an event export request", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/peopleevents/1/export/:requestId", "params": [ { "name": "requestId", "value": "", "type": "path", "description": "Request ID (unique identifier) of a previously submitted data export request." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Requests asynchronous cancellation of a previously submitted data export request by the request ID." }, { "info": { "name": "Get list of event definitions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/peopleevents/1/export/definitions", "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Retrieves a list of all available event definitions, including custom events. \nThe event definitions can be then used as a filter in the \n[Event Export API](https://www.infobip.com/docs/api#customer-engagement/people/create-events-export-request)." }, { "info": { "name": "Get a list of segments", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/people/3/segments", "params": [ { "name": "page", "value": "", "type": "query", "description": "Zero-based page index (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "The size of the page to be returned." }, { "name": "sort", "value": "", "type": "query", "description": "Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to get a list of segments." }, { "info": { "name": "Create a segment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/people/3/segments", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to create a segment." }, { "info": { "name": "Get a segment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/people/3/segments/:segmentId", "params": [ { "name": "segmentId", "value": "42", "type": "path", "description": "A unique segment identifier." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to get a segment by ID." }, { "info": { "name": "Update a segment", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/people/3/segments/:segmentId", "params": [ { "name": "segmentId", "value": "42", "type": "path", "description": "A unique segment identifier." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to update a segment." }, { "info": { "name": "Delete a segment", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/people/3/segments/:segmentId", "params": [ { "name": "segmentId", "value": "42", "type": "path", "description": "A unique segment identifier." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to delete a segment by ID." }, { "info": { "name": "Get persons in a segment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/people/3/segments/:segmentId/persons", "params": [ { "name": "segmentId", "value": "42", "type": "path", "description": "A unique segment identifier." }, { "name": "page", "value": "", "type": "query", "description": "Zero-based page index (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "The size of the page to be returned." }, { "name": "sort", "value": "", "type": "query", "description": "Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to get persons in a segment by ID." }, { "info": { "name": "Add participants to flow", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/moments/1/flows/:campaignId/participants", "params": [ { "name": "campaignId", "value": "200000000000001", "type": "path", "description": "Unique identifier of the flow that participant will be added to." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this endpoint to add participants to a flow, accommodating anywhere from 1 to 1000 persons.\n When participants are added, their profiles in People are automatically created, updated or merged based on the identifiers provided.
\n If identifiers are unique, a new profile is created.
\n If identifiers match an existing profile, then that profile is updated.
\n If identifiers refer to multiple existing profiles or are not unique " }, { "info": { "name": "Get a report on participants added to flow", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/moments/1/flows/:campaignId/participants/report", "params": [ { "name": "campaignId", "value": "200000000000001", "type": "path", "description": "Unique identifier of the flow that participant will be added to." }, { "name": "operationId", "value": "03f2d474-0508-46bf-9f3d-d8e2c28adaea", "type": "query", "description": "Unique identifier of the operation." }, { "name": "applicationId", "value": "", "type": "query" }, { "name": "entityId", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this API endpoint to fetch a report to confirm that all persons have been successfully added to the flow.\n Please note that report is stored for 30 days." }, { "info": { "name": "Add Person to Flow", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/communication/1/flows/:campaignId/participants", "params": [ { "name": "campaignId", "value": "10159347", "type": "path", "description": "Unique identifier of the flow that person will be added to" }, { "name": "phone", "value": "19123456789", "type": "query", "description": "Person's phone number" }, { "name": "email", "value": "janewilliams@example.com", "type": "query", "description": "Person's email address" }, { "name": "externalId", "value": "8edb24b5-0319-48cd-a1d9-1e8bc5d577ab", "type": "query", "description": "Unique ID for the person from an external system" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Creates or updates a person and adds it to Flow" }, { "info": { "name": "Remove person from flow", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/communication/1/flows/:campaignId/participants", "params": [ { "name": "campaignId", "value": "10159347", "type": "path", "description": "Unique identifier of the flow that person will be removed from." }, { "name": "phone", "value": "19123456789", "type": "query", "description": "Person's phone number." }, { "name": "email", "value": "janewilliams@example.com", "type": "query", "description": "Person's email address." }, { "name": "externalId", "value": "8edb24b5-0319-48cd-a1d9-1e8bc5d577ab", "type": "query", "description": "Unique ID for the person from an external system." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Removes a participant with given identifier from the flow." }, { "info": { "name": "Get forms", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/forms/1/forms", "params": [ { "name": "offset", "value": "60", "type": "query", "description": "Skip first {offset} forms of the list." }, { "name": "limit", "value": "30", "type": "query", "description": "The maximum number of returned forms. Maximum value is `100`." }, { "name": "formType", "value": "APPLE", "type": "query", "description": "The type of returned forms." }, { "name": "formStatus", "value": "ACTIVE", "type": "query", "description": "The status of returned forms." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to get a list of forms." }, { "info": { "name": "Get form", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/forms/1/forms/:id", "params": [ { "name": "id", "value": "f7cf1606-e155-40eb-9721-78183d268d24", "type": "path", "description": "ID of a form" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to get a form by its ID." }, { "info": { "name": "Increment form view count", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/forms/1/forms/:id/views", "params": [ { "name": "id", "value": "cec5dfd2-4238-48e0-933b-9acbdb2e6f5f", "type": "path", "description": "ID of a form" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to increase the view counter of a specific form. It's used for proper statistics calculation. Statistics are available on the form performance page on the Portal." }, { "info": { "name": "Submit form data", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/forms/1/forms/:id/data", "headers": [ { "name": "ib-submission-source", "value": "" }, { "name": "ib-submission-form-campaign", "value": "" } ], "params": [ { "name": "id", "value": "f7cf1606-e155-40eb-9721-78183d268d24", "type": "path", "description": "ID of a form" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to submit form data." }, { "info": { "name": "Get conversations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ccaas/1/conversations", "params": [ { "name": "conversationIds", "value": "", "type": "query", "description": "Optional. List of conversation Ids." }, { "name": "queueIds", "value": "", "type": "query", "description": "Optional. List of queue Ids." }, { "name": "tagNames", "value": "", "type": "query", "description": "Optional. List of tag names." }, { "name": "agentId", "value": "", "type": "query", "description": "Optional. Id of an agent assigned to conversations." }, { "name": "status", "value": "", "type": "query", "description": "Optional. Conversation status." }, { "name": "priority", "value": "", "type": "query", "description": "Optional. Conversation priority." }, { "name": "createdAfter", "value": "", "type": "query", "description": "Optional. Filter results created after specific date and time. Format: yyyy-MM-dd'T'HH:mm:ss.SSS+0000" }, { "name": "createdBefore", "value": "", "type": "query", "description": "Optional. Filter results created before specific date and time. Format: yyyy-MM-dd'T'HH:mm:ss.SSS+0000" }, { "name": "updatedAfter", "value": "", "type": "query", "description": "Optional. Filter results updated after specific date and time. Format: yyyy-MM-dd'T'HH:mm:ss.SSS+0000" }, { "name": "updatedBefore", "value": "", "type": "query", "description": "Optional. Filter results updated before specific date and time. Format: yyyy-MM-dd'T'HH:mm:ss.SSS+0000" }, { "name": "closedAfter", "value": "", "type": "query", "description": "Optional. Filter results closed after specific date and time. Format: yyyy-MM-dd'T'HH:mm:ss.SSS+0000" }, { "name": "closedBefore", "value": "", "type": "query", "description": "Optional. Filter results closed before specific date and time. Format: yyyy-MM-dd'T'HH:mm:ss.SSS+0000" }, { "name": "limit", "value": "", "type": "query", "description": "Size of the result page." }, { "name": "page", "value": "", "type": "query", "description": "Number of the current page." }, { "name": "orderBy", "value": "", "type": "query", "description": "This parameter is used to order your results.\nIf an order is not given, the default order id:asc will be applied.\nPossible ordering fields are properties.\nOrdering direction can be specified with modifiers asc for the ascending ordering or desc for the descending one." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to get a list of conversations with pagination and filtering option. Using the filter is optional. The result can be filtered by one or many optional filters described in parameters. More info" }, { "info": { "name": "Create conversation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/ccaas/1/conversations", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to create a new conversation. All conversation parameters are optional. More info" }, { "info": { "name": "Get conversation", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ccaas/1/conversations/:conversationId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "Id of the conversation to get." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to get a single conversation. More info" }, { "info": { "name": "Update conversation", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/ccaas/1/conversations/:conversationId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "Id of the conversation being updated." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to update a conversation. Closed conversations cannot be changed. To change an assignment to another agent or a bot, use [Change conversation assignment](https://www.infobip.com/docs/api/customer-engagement/conversations/change-conversation-assignment).More info" }, { "info": { "name": "Patch conversation", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/ccaas/1/conversations/:conversationId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "Id of the conversation being patched." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to patch a conversation. Closed conversations cannot be changed. To change an assignment to another agent or a bot, use [Change conversation assignment](https://www.infobip.com/docs/api/customer-engagement/conversations/change-conversation-assignment).More info" }, { "info": { "name": "Add tag to conversation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/ccaas/1/conversations/:conversationId/tags", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "Id of the conversation the tag is added to." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to add a tag to the conversation. With tag(s) you can categorize conversations for assignment and/or reporting purposes. More info" }, { "info": { "name": "Change conversation assignment", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/ccaas/1/conversations/:conversationId/assignee", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "Id of the conversation for which the assignment is to be updated." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to update a conversation assignee. Assignee cannot be updated in closed conversations. For Agent Takeovers (bot replaced by an agent), the Infobip platform will additionally update [Answers](https://www.infobip.com/docs/answers) that a bot is no longer in control of the conversation. More info" }, { "info": { "name": "Unassign conversation agent", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/ccaas/1/conversations/:conversationId/assignee", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "Id of the conversation to unassign agent from." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to remove an assigned agent from conversation. More info" }, { "info": { "name": "Remove tag from conversation", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/ccaas/1/conversations/:conversationId/tags/:tagName", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "Id of the conversation to remove/unlink the tag from." }, { "name": "tagName", "value": "", "type": "path", "description": "Name of the tag to remove/unlink from conversation. This value must be URL-encoded." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to remove the tag from the conversation. Operation only deletes the link between a tag and the conversation. More info" }, { "info": { "name": "Route conversation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/ccaas/1/conversations/:conversationId/route", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "Id of the conversation being routed." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to route the existing conversation.\nThis method will remove the assigned agent from a conversation (if one exists), and send the conversation to the [routing process](../#customer-engagement/conversations/update-routing).\nClosed Conversations cannot be routed." }, { "info": { "name": "Simulate routing result for conversation", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ccaas/1/conversations/:conversationId/simulate-routing", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "Id of the conversation on which routing is simulated." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to simulate routing for an existing conversation.\nThis method will resolve the routing rule applicable to the current conversation state and return the queue ID and priority\nthat would be applied if the conversation was actually routed at this moment.\nClosed conversations cannot be routed.\n" }, { "info": { "name": "Get related comments", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ccaas/1/conversations/:conversationId/related-comments", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "ID of the conversation to get." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to return social comments related to a specified inbound comment within a conversation.\nIt returns up to 50 older and 50 newer comments that are on the same hierarchy level as the inbound comment.\n" }, { "info": { "name": "Get linked conversations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ccaas/1/conversations/:conversationId/links", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "ID of the conversation to get links for." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to get a list of conversations linked to the specified conversation. More info" }, { "info": { "name": "Get tags", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ccaas/1/tags", "params": [ { "name": "conversationId", "value": "", "type": "query", "description": "Optional. Conversation Ids linked to tags." }, { "name": "name", "value": "", "type": "query", "description": "Optional. Tag name." }, { "name": "limit", "value": "", "type": "query", "description": "Size of the result page." }, { "name": "page", "value": "", "type": "query", "description": "Number of the current page." }, { "name": "orderBy", "value": "", "type": "query", "description": "This parameter is used to order your results.\nIf an order is not given, the default order id:asc will be applied.\nPossible ordering fields are properties.\nOrdering direction can be specified with modifiers asc for the ascending ordering or desc for the descending one." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to get a list of tags with pagination and filtering options. Using a filter is optional. The result can be filtered only by conversation Id so the result list will be tagged for a specific conversation. More info" }, { "info": { "name": "Create tag", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/ccaas/1/tags", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to create a new tag. Tags can be assigned to the conversations to categorize them into topics or customer intents. Tags can be created ad hoc over the create tag method or automatically within the journey automation flow when a conversation is transferred to Agents. More info" }, { "info": { "name": "Delete tag", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/ccaas/1/tags/:tagName", "params": [ { "name": "tagName", "value": "", "type": "path", "description": "Name of the Tag being deleted. This value must be URL-encoded." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to delete the tag.\nDeleting tag will remove the tag from all associated conversations. This operation cannot be reverted! More info" }, { "info": { "name": "Get messages", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ccaas/1/conversations/:conversationId/messages", "params": [ { "name": "messageIds", "value": "", "type": "query", "description": "Optional. List of messages Ids." }, { "name": "channel", "value": "", "type": "query", "description": "Optional. Message chanel." }, { "name": "direction", "value": "", "type": "query", "description": "Optional. Message direction." }, { "name": "createdAfter", "value": "", "type": "query", "description": "Optional. Filter results created after specific date and time. Format: yyyy-MM-dd'T'HH:mm:ss.SSS+0000" }, { "name": "createdBefore", "value": "", "type": "query", "description": "Optional. Filter results created before specific date and time. Format: yyyy-MM-dd'T'HH:mm:ss.SSS+0000" }, { "name": "limit", "value": "", "type": "query", "description": "Size of the result page." }, { "name": "page", "value": "", "type": "query", "description": "Number of the current page." }, { "name": "orderBy", "value": "", "type": "query", "description": "This parameter is used to order your results.\nIf an order is not given, the default order id:asc will be applied.\nPossible ordering fields are properties.\nOrdering direction can be specified with modifiers asc for the ascending ordering or desc for the descending one." }, { "name": "conversationId", "value": "", "type": "path", "description": "Id of the conversation to get messages from." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to get a list of messages from a conversation with pagination and filtering option. Using a filter is optional. The result can be filtered by one or many optional filters described in the parameters." }, { "info": { "name": "Create message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/ccaas/1/conversations/:conversationId/messages", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "Id of the conversation to set message for." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Inbound messages are automatically threaded in conversations if the channels and senders are configured for using Conversations.\nTo send an outbound message use this method with the following parameters, adding it to an existing conversation.\nPlease note that the response from sending a TEMPLATE content type is a message of the TEXT content type, containing the\ntemplate content filled with parameters. \n\nAlso, HTTP header should contain parameter \"x-agent-id\" as agent identifier,\nbut only in case" }, { "info": { "name": "Send a conversation event", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/ccaas/1/conversations/:conversationId/events", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "Id of the conversation to set event for." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this endpoint to send an event to a conversation. E.g. indication when typing started or ended.More info" }, { "info": { "name": "Get notes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ccaas/1/conversations/:conversationId/notes", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Size of the result page." }, { "name": "page", "value": "", "type": "query", "description": "Number of the current page." }, { "name": "orderBy", "value": "", "type": "query", "description": "This parameter is used to order your results.\nIf an order is not given, the default order id:asc will be applied.\nPossible ordering fields are properties.\nOrdering direction can be specified with modifiers asc for the ascending ordering or desc for the descending one." }, { "name": "conversationId", "value": "", "type": "path", "description": "Id of the conversation to get notes from." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to get a list of notes from conversation with pagination. More info" }, { "info": { "name": "Create note", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/ccaas/1/conversations/:conversationId/notes", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "Id of the conversation to set note to." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to create a new note. Use notes to notify your team on important matters regarding a conversation with a customer. More info" }, { "info": { "name": "Get note", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ccaas/1/conversations/:conversationId/notes/:noteId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "Id of the conversation to get a note from." }, { "name": "noteId", "value": "", "type": "path", "description": "Note Id." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to retrieve a note. More info" }, { "info": { "name": "Get agents", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ccaas/1/agents", "params": [ { "name": "agentIds", "value": "", "type": "query", "description": "Optional filter. List of agents Id to match result." }, { "name": "queueIds", "value": "", "type": "query", "description": "Optional filter. List of queues Id to match result." }, { "name": "displayName", "value": "", "type": "query", "description": "Optional. Agent display name. This is case insensitive and will search for substring anywhere within string, 255 characters max." }, { "name": "email", "value": "", "type": "query", "description": "Optional. Agent email." }, { "name": "status", "value": "", "type": "query", "description": "Optional. Indicates a status set by the agent reflecting their availability preferences." }, { "name": "availability", "value": "", "type": "query", "description": "Optional. Indicates the agent status set by the system reflecting the actual availability." }, { "name": "role", "value": "", "type": "query", "description": "Optional. Agent role." }, { "name": "enabled", "value": "", "type": "query", "description": "Optional. Agent enable/disable toggle." }, { "name": "createdAfter", "value": "", "type": "query", "description": "Optional. Filter results created after specific date and time. Format: yyyy-MM-dd'T'HH:mm:ss.SSSZ" }, { "name": "createdBefore", "value": "", "type": "query", "description": "Optional. Filter results created before specific date and time. Format: yyyy-MM-dd'T'HH:mm:ss.SSSZ" }, { "name": "updatedAfter", "value": "", "type": "query", "description": "Optional. Filter results updated after specific date and time. Format: yyyy-MM-dd'T'HH:mm:ss.SSSZ" }, { "name": "updatedBefore", "value": "", "type": "query", "description": "Optional. Filter results updated before specific date and time. Format: yyyy-MM-dd'T'HH:mm:ss.SSSZ" }, { "name": "limit", "value": "", "type": "query", "description": "Size of the result page." }, { "name": "page", "value": "", "type": "query", "description": "Number of the current page." }, { "name": "orderBy", "value": "", "type": "query", "description": "This parameter is used to order your results.\nIf an order is not given, the default order id:asc will be applied.\nPossible ordering fields are properties.\nOrdering direction can be specified with modifiers asc for the ascending ordering or desc for the descending one." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to get a list of agents with pagination and filtering options. Using a filter is optional. The result can be filtered by one or many optional filters described in parameters. More info" }, { "info": { "name": "Create agent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/ccaas/1/agents", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to add a new agent. More info" }, { "info": { "name": "Get agent", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ccaas/1/agents/:agentId", "params": [ { "name": "agentId", "value": "", "type": "path", "description": "Id of the agent we want to retrieve." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to get a single agent. More info" }, { "info": { "name": "Update agent", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/ccaas/1/agents/:agentId", "params": [ { "name": "agentId", "value": "", "type": "path", "description": "Id of the Agent we want to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to update an agent. More info" }, { "info": { "name": "Get agent conversations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ccaas/1/agents/:agentId/conversations", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Size of the result page." }, { "name": "page", "value": "", "type": "query", "description": "Number of the current page." }, { "name": "orderBy", "value": "", "type": "query", "description": "This parameter is used to order your results.\nIf an order is not given, the default order id:asc will be applied.\nPossible ordering fields are properties.\nOrdering direction can be specified with modifiers asc for the ascending ordering or desc for the descending one." }, { "name": "agentId", "value": "", "type": "path", "description": "Agent id to get conversations." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to get a list of conversations, an agent is assigned on, with pagination." }, { "info": { "name": "Change agents status", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/ccaas/1/agents/:agentId/status", "params": [ { "name": "agentId", "value": "", "type": "path", "description": "Id of the Agent we want to change status." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to change agents status. More info" }, { "info": { "name": "Add agent to queue", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/ccaas/1/agents/:agentId/queues", "params": [ { "name": "agentId", "value": "", "type": "path", "description": "Id of the Agent which should be assign to Queue." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to add an agent to a queue." }, { "info": { "name": "Remove agent from queue", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/ccaas/1/agents/:agentId/queues/:queueId", "params": [ { "name": "agentId", "value": "", "type": "path", "description": "Id of the Agent which should be unlinked from queue." }, { "name": "queueId", "value": "", "type": "path", "description": "Id of the Queue which should be unlinked from agent." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to remove an agent from a queue.\nOperation only deletes the link between a queue and the agent." }, { "info": { "name": "Set agents heartbeat", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/ccaas/1/agents/:agentId/heartbeat", "params": [ { "name": "agentId", "value": "", "type": "path", "description": "Id of the Agent we want to set heartbeat." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to set agents heartbeat. More info" }, { "info": { "name": "Get queues", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ccaas/1/queues", "params": [ { "name": "queueIds", "value": "", "type": "query", "description": "Optional filter. List of queue Ids." }, { "name": "agentId", "value": "", "type": "query", "description": "Optional filter. Agent Id." }, { "name": "workingHoursId", "value": "", "type": "query", "description": "Optional filter. Working Hours Id." }, { "name": "limit", "value": "", "type": "query", "description": "Size of the result page." }, { "name": "page", "value": "", "type": "query", "description": "Number of the current page." }, { "name": "orderBy", "value": "", "type": "query", "description": "This parameter is used to order your results.\nIf an order is not given, the default order id:asc will be applied.\nPossible ordering fields are properties.\nOrdering direction can be specified with modifiers asc for the ascending ordering or desc for the descending one." }, { "name": "name", "value": "", "type": "query", "description": "Optional. Queue name." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to get a list of queues with pagination and filtering options. Using a filter is optional.\nThe result can be filtered by one or many optional filters described in the parameters.\nMore info" }, { "info": { "name": "Create queue", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/ccaas/1/queues", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to create a queue.\nQueues help manage conversations in a timely manner by organizing the team based on workload and knowledge.\nMore info" }, { "info": { "name": "Update queue", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/ccaas/1/queues/:queueId", "params": [ { "name": "queueId", "value": "", "type": "path", "description": "Id of the queue being updated." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to update the queue. More info" }, { "info": { "name": "Delete queue", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/ccaas/1/queues/:queueId", "params": [ { "name": "queueId", "value": "", "type": "path", "description": "Id of the queue to be deleted." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to delete a queue. More info" }, { "info": { "name": "Get routing", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ccaas/1/routing", "params": [ { "name": "ruleIds", "value": "", "type": "query", "description": "Optional. List of rule Ids." }, { "name": "enabled", "value": "", "type": "query", "description": "Optional. Rule enable/disable toggle." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to get a list of rules within the routing. Pagination is set to single page result with a maximum of 999 items ordered by \"order\". As rules inside routing are stored, executed and retrieved in provided order with the SET method, that order can't be changed. More info" }, { "info": { "name": "Create routing", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/ccaas/1/routing", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create routing method creates a new routing setup if it does not exist or replaces the existing setup. As rules inside routing are stored, executed, and retrieved in the provided order with this method, that order cannot be changed. Every expression within routing can be constructed with at least one or more available operators. The result of the expression will be a success (TRUE) only if all results of operations are TRUE. The query will be executed, one expression after another, in the order " }, { "info": { "name": "Delete routing", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/ccaas/1/routing", "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to delete routing. No parameters are required for this action.\n\nThis operation will delete routing with all rules inside, so all new inbound messages destined to routing will be routed to the default queue.\nMore info" }, { "info": { "name": "Get Bots", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ccaas/1/bots", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Size of the result page." }, { "name": "page", "value": "", "type": "query", "description": "Number of the current page." }, { "name": "orderBy", "value": "", "type": "query", "description": "This parameter is used to order your results.\nIf an order is not given, the default order id:asc will be applied.\nPossible ordering fields are properties.\nOrdering direction can be specified with modifiers asc for the ascending ordering or desc for the descending one." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to get bots with pagination. More info" }, { "info": { "name": "Create bot", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/ccaas/1/bots", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to create a bot. More info" }, { "info": { "name": "Get bot", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ccaas/1/bots/:botId", "params": [ { "name": "botId", "value": "", "type": "path", "description": "Id of the Bot to get." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to get a bot. More info" }, { "info": { "name": "Update bot", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/ccaas/1/bots/:botId", "params": [ { "name": "botId", "value": "", "type": "path", "description": "Id of the Bot being updated." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to update a bot. More info" }, { "info": { "name": "Delete bot", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/ccaas/1/bots/:botId", "params": [ { "name": "botId", "value": "", "type": "path", "description": "Id of the Bot being deleted." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to delete a bot.\nAll open conversations assigned to a bot will be rerouted. More info" }, { "info": { "name": "Get metadata", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ccaas/1/conversations/:conversationId/metadata", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "Id of the conversation to retrieve metadata for." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to retrieve conversation metadata. More info" }, { "info": { "name": "Put metadata", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/ccaas/1/conversations/:conversationId/metadata", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "Id of the conversation for which we are upserting metadata." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to create or update conversation metadata. Method overwrites old metadata. More info" }, { "info": { "name": "Patch metadata", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/ccaas/1/conversations/:conversationId/metadata", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "Id of the conversation to update metadata for." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method for metadata partial updating. If there is no present metadata, one will be created from request. More info" }, { "info": { "name": "Delete metadata", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/ccaas/1/conversations/:conversationId/metadata", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "Id of the conversation to delete metadata for." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to delete conversation metadata. More info" }, { "info": { "name": "Get templates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ccaas/1/templates", "params": [ { "name": "channel", "value": "", "type": "query", "description": "Optional. Template channel." }, { "name": "language", "value": "", "type": "query", "description": "Optional. Template language." }, { "name": "createdAfter", "value": "", "type": "query", "description": "Optional. Filter results created after specific date and time. Format: yyyy-MM-dd'T'HH:mm:ss.SSS+0000" }, { "name": "createdBefore", "value": "", "type": "query", "description": "Optional. Filter results created before specific date and time. Format: yyyy-MM-dd'T'HH:mm:ss.SSS+0000" }, { "name": "updatedAfter", "value": "", "type": "query", "description": "Optional. Filter results updated after specific date and time. Format: yyyy-MM-dd'T'HH:mm:ss.SSS+0000" }, { "name": "updatedBefore", "value": "", "type": "query", "description": "Optional. Filter results updated before specific date and time. Format: yyyy-MM-dd'T'HH:mm:ss.SSS+0000" }, { "name": "contentType", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to get a list of templates with pagination and filtering options. Using the filter is optional.\nThe result can be filtered by one or many optional filters described in the parameters.\nResults are ordered by creation in descending order by default, meaning the newest template will be returned first.\nMore info" }, { "info": { "name": "Get template", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ccaas/1/templates/:templateId", "params": [ { "name": "templateId", "value": "", "type": "path", "description": "Id of the template to get." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to get a single template. More info" }, { "info": { "name": "Get conversation forms", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ccaas/2/conversation-forms/forms", "params": [ { "name": "title", "value": "", "type": "query", "description": "Optional filter. Form title." }, { "name": "isEnabled", "value": "", "type": "query", "description": "Optional filter. Enabled status." }, { "name": "isDefault", "value": "", "type": "query", "description": "Optional filter. Default status." }, { "name": "limit", "value": "", "type": "query", "description": "Size of the result page." }, { "name": "page", "value": "", "type": "query", "description": "Number of the current page." }, { "name": "orderBy", "value": "", "type": "query", "description": "This parameter is used to order your results. If an order is not given, the default order id:asc will be applied. Possible ordering fields are properties. Ordering direction can be specified with modifiers asc for the ascending ordering or desc for the descending one." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to get a list of forms with pagination and filtering options. Using a filter is optional. The result can be filtered by one or many optional filters described in the parameters." }, { "info": { "name": "Create conversation form", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/ccaas/2/conversation-forms/forms", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to create a form." }, { "info": { "name": "Get conversation form", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ccaas/2/conversation-forms/forms/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to get a single form. " }, { "info": { "name": "Update conversation form", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/ccaas/2/conversation-forms/forms/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the form to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to update a form." }, { "info": { "name": "Delete conversation form", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/ccaas/2/conversation-forms/forms/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the form to delete." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to delete the form." }, { "info": { "name": "Get fields", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ccaas/2/conversation-forms/fields", "params": [ { "name": "title", "value": "", "type": "query", "description": "Optional filter. Field title." }, { "name": "limit", "value": "", "type": "query", "description": "Size of the result page." }, { "name": "page", "value": "", "type": "query", "description": "Number of the current page." }, { "name": "orderBy", "value": "", "type": "query", "description": "This parameter is used to order your results. If an order is not given, the default order id:asc will be applied. Possible ordering fields are properties. Ordering direction can be specified with modifiers asc for the ascending ordering or desc for the descending one." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to get a list of fields with pagination and filtering options. Using a filter is optional. The result can be filtered by one or many optional filters described in the parameters." }, { "info": { "name": "Create field", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/ccaas/2/conversation-forms/fields", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to create a field." }, { "info": { "name": "Get field", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ccaas/2/conversation-forms/fields/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to get a single field. " }, { "info": { "name": "Update field", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/ccaas/2/conversation-forms/fields/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the field being updated." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to update a field." }, { "info": { "name": "Delete field", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/ccaas/2/conversation-forms/fields/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the field being deleted." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to delete the field. \nDeleting a field will remove associated agent inputs in all non-closed conversations. This operation cannot be reverted!" }, { "info": { "name": "Get triggers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ccaas/2/conversation-forms/triggers", "params": [ { "name": "title", "value": "", "type": "query", "description": "Optional filter. Trigger title." }, { "name": "limit", "value": "", "type": "query", "description": "Size of the result page." }, { "name": "page", "value": "", "type": "query", "description": "Number of the current page." }, { "name": "orderBy", "value": "", "type": "query", "description": "This parameter is used to order your results. If an order is not given, the default order id:asc will be applied. Possible ordering fields are properties. Ordering direction can be specified with modifiers asc for the ascending ordering or desc for the descending one." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to get a list of triggers with pagination and filtering options. Using a filter is optional. The result can be filtered by one or many optional filter described in the parameters." }, { "info": { "name": "Create trigger", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/ccaas/2/conversation-forms/triggers", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "The create trigger method creates a new trigger at the first order position in the existing setup. Triggers are used to assign proper form to a conversation, based on an expression. Every expression can be constructed with at least one or more available operators. The result of the expression will be a success (TRUE) only if all results of operations are TRUE. Order of triggers is essential in the form assignment process, as triggers are match the provided order. First trigger matching the conve" }, { "info": { "name": "Get trigger", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ccaas/2/conversation-forms/triggers/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the trigger." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to get a single trigger. " }, { "info": { "name": "Update trigger", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/ccaas/2/conversation-forms/triggers/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the trigger to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to update a trigger. Triggers between 'old' and 'new' position will be set automatically ± one position. More info" }, { "info": { "name": "Patch trigger", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/ccaas/2/conversation-forms/triggers/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the trigger to patch." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to patch a trigger. Triggers between 'old' and 'new' position will be set automatically ± one position.\n More info" }, { "info": { "name": "Delete trigger", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/ccaas/2/conversation-forms/triggers/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the trigger to delete." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to delete a trigger." }, { "info": { "name": "Get dispositions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ccaas/2/conversations/:conversationId/form", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "Id of the conversation." }, { "name": "formId", "value": "", "type": "query", "description": "Id of the form. If none provided, the one currently assigned to a conversation is used." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to get a conversation form with attached fields and values. " }, { "info": { "name": "Update or insert dispositions", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/ccaas/2/conversations/:conversationId/form", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "Id of the conversation." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to create or update field value for a conversation. Method overwrites old dispositions." }, { "info": { "name": "Delete disposition", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/ccaas/2/conversations/:conversationId/form/:id", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "Id of the conversation." }, { "name": "id", "value": "", "type": "path", "description": "Id of the disposition being deleted." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to delete an agent input to a field from a conversation." }, { "info": { "name": "Assign form to conversation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/ccaas/2/conversations/:conversationId/form/assign", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "Id of the conversation." }, { "name": "formId", "value": "", "type": "query", "description": "Id of the form to assign." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to assign form to a conversation. " }, { "info": { "name": "Un-assign form from conversation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/ccaas/2/conversations/:conversationId/form/unassign", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "Id of the conversation." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to remove a form from a given conversation. Un-assign is implemented by setting the formId property of the Conversation to null." }, { "info": { "name": "Update account configuration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/ccaas/1/account/configuration", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint is deprecated as of March 12, 2025, meaning no fixes or updates will be provided. It will be completely removed on December 31, 2026. Configure the webhooks through the Subscription management section in your Infobip account or the existing Subscriptions management API." }, { "info": { "name": "Get agent configuration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ccca/1/agent-configs/:agentId", "params": [ { "name": "agentId", "value": "", "type": "path", "description": "Agent ID used to retrieve the configuration." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to retrieve the current agent-specific configuration." }, { "info": { "name": "Create outbound call conversation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/ccaas/voice/2/outbound-call-conversation", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to create a conversation associated with an outbound call. Expected usage is to trigger this endpoint and then start a call using the RTC SDK callConversations method. The created conversation ID is required when using the callConversations method to trigger an outbound call. Another option is to use the ID of a previously created call conversation. More info." }, { "info": { "name": "Get all waiting strategies", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ccaas/voice/2/waiting-strategies", "params": [ { "name": "queueId", "value": "", "type": "query", "description": "Optional filter. Queue id." }, { "name": "pageNumber", "value": "", "type": "query", "description": "Optional filter. Page number." }, { "name": "pageSize", "value": "", "type": "query", "description": "Optional filter. Page size." }, { "name": "sortDirection", "value": "", "type": "query", "description": "Optional filter. This parameter is used to order your results. If an order is not given, the default order DESC will be applied. Supported values are ASC and DESC." }, { "name": "sortBy", "value": "", "type": "query", "description": "Optional filter. This parameter is used to specify sort criteria. If a criteria is not given, the default criteria CREATED_AT will be applied. Supported values are NAME and CREATED_AT." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to retrieve all waiting strategies. More info." }, { "info": { "name": "Create waiting strategy", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/ccaas/voice/2/waiting-strategies", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to add a new waiting strategy. To upload an audio file and get value for fileDescriptor field, use Upload audio files endpoint. More info." }, { "info": { "name": "Get waiting strategy", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ccaas/voice/2/waiting-strategies/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the Waiting Strategy to get." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to retrieve a waiting strategy by its Id. More info." }, { "info": { "name": "Update waiting strategy", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/ccaas/voice/2/waiting-strategies/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the Waiting Strategy being updated." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to update a waiting strategy. To upload an audio file and get value for fileDescriptor field, use Upload audio files endpoint. More info." }, { "info": { "name": "Delete waiting strategy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/ccaas/voice/2/waiting-strategies/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the Waiting Strategy being deleted." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to delete a waiting strategy by its Id. More info." }, { "info": { "name": "Get account recording configuration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ccaas/voice/2/account-recording-config", "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to retrieve the account recording configuration. More info." }, { "info": { "name": "Create account recording configuration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/ccaas/voice/2/account-recording-config", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to create an account recording configuration. More info." }, { "info": { "name": "Update account recording configuration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/ccaas/voice/2/account-recording-config", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to create or update an account recording configuration. More info." }, { "info": { "name": "Get agent recording configurations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ccaas/voice/2/agent-recording-configs", "params": [ { "name": "agentIds", "value": "", "type": "query", "description": "Agent ids of agent recording configs to get." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to retrieve agent recording configurations. More info." }, { "info": { "name": "Get agent recording configuration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ccaas/voice/2/agent-recording-configs/:agentId", "params": [ { "name": "agentId", "value": "", "type": "path", "description": "Agent id of agent recording config to get." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to retrieve the agent recording configuration. More info." }, { "info": { "name": "Create agent recording configuration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/ccaas/voice/2/agent-recording-configs/:agentId", "params": [ { "name": "agentId", "value": "", "type": "path", "description": "Agent id of agent recording config to create." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to create an agent recording configuration. More info." }, { "info": { "name": "Update agent recording configuration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/ccaas/voice/2/agent-recording-configs/:agentId", "params": [ { "name": "agentId", "value": "", "type": "path", "description": "Agent id of agent recording config to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to create or update an agent recording configuration. More info." }, { "info": { "name": "Get recording metadata", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ccaas/voice/2/recording/metadata", "params": [ { "name": "recordingId", "value": "", "type": "query", "description": "Unique id of the recorded file." }, { "name": "conversationId", "value": "", "type": "query", "description": "Unique id of the conversation." }, { "name": "conferenceId", "value": "", "type": "query", "description": "Unique id of the conference." }, { "name": "callId", "value": "", "type": "query", "description": "Unique id of the call." }, { "name": "direction", "value": "", "type": "query", "description": "Call direction of recorded file." }, { "name": "filename", "value": "", "type": "query", "description": "Filename of recorded file." }, { "name": "participantId", "value": "", "type": "query", "description": "Participant id associated with the recorded file." }, { "name": "participantIdentity", "value": "", "type": "query", "description": "Participant identity associated with the recorded file." }, { "name": "participantName", "value": "", "type": "query", "description": "Participant name associated with the recorded file." }, { "name": "participantType", "value": "", "type": "query", "description": "Participant type associated with the recorded file." }, { "name": "mediaType", "value": "", "type": "query", "description": "Media type of recorded file." }, { "name": "deletedBy", "value": "", "type": "query", "description": "Identity of the user who deleted the recorded file." }, { "name": "transferredFrom", "value": "", "type": "query", "description": "Identity of the user who has transferred the call." }, { "name": "transferredTo", "value": "", "type": "query", "description": "Identity of the user to whom the call has been transferred." }, { "name": "transferredFromQueue", "value": "", "type": "query", "description": "Queue id from which the call has been transferred." }, { "name": "transferredToQueue", "value": "", "type": "query", "description": "Queue id to which the call has been transferred." }, { "name": "durationFrom", "value": "", "type": "query", "description": "Minimum duration to filter recorded files." }, { "name": "durationTo", "value": "", "type": "query", "description": "Maximum duration to filter recorded files." }, { "name": "startedAtFrom", "value": "", "type": "query", "description": "Lower bound for filtering by recording start time." }, { "name": "startedAtTo", "value": "", "type": "query", "description": "Upper bound for filtering by recording start time." }, { "name": "deletedAtFrom", "value": "", "type": "query", "description": "Lower bound for filtering by deleted at time." }, { "name": "deletedAtTo", "value": "", "type": "query", "description": "Upper bound for filtering by deleted at time." }, { "name": "page", "value": "", "type": "query", "description": "Page number." }, { "name": "size", "value": "", "type": "query", "description": "Page size." }, { "name": "sortBy", "value": "", "type": "query", "description": "Field by which the sorting will be done." }, { "name": "sortDirection", "value": "", "type": "query", "description": "Type of sorting." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to retrieve a pageable list of recording metadata based on parameters." }, { "info": { "name": "Download call recording", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ccaas/voice/2/recording/download/:recordingId", "headers": [ { "name": "Range", "value": "" } ], "params": [ { "name": "recordingId", "value": "", "type": "path", "description": "Id of the recording to download." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this endpoint to download a call recording using recordingId." }, { "info": { "name": "Get account wrap up configuration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ccaas/voice/2/account-wrap-up-config", "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to retrieve the current account wrap up configuration. Wrap up is the time after a call during which an agent's status is still BUSY. Default wrap up time is 30 seconds. More info." }, { "info": { "name": "Update account wrap up configuration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/ccaas/voice/2/account-wrap-up-config", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to update account wrap up configuration. Wrap up is the time after a call during which an agent's status is still BUSY. Default wrap up time is 30 seconds. More info." }, { "info": { "name": "Update agent wrap up configuration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/ccca/1/agent-configs/:agentId/wrap-up", "params": [ { "name": "agentId", "value": "", "type": "path", "description": "Agent ID used to update the configuration." }, { "name": "wrapUpSeconds", "value": "", "type": "query", "description": "Wrap up duration in seconds for agent. Setting null will default to account wrap up duration. Send this parameter in request body instead.More info." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to create or update agent wrap up configuration." }, { "info": { "name": "Add agent wrap up time", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/ccaas/voice/2/agent/:agentId/wrap-up-time/add/:seconds", "params": [ { "name": "agentId", "value": "", "type": "path", "description": "Agent id of agent wrap up to add." }, { "name": "seconds", "value": "", "type": "path", "description": "Number of seconds to extend wrap up time." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to extend the agent wrap up time after a call, by specified number of seconds. Number of seconds should be a positive number. Agent should be in Wrapping status. Wrap up is the time after a call during which an agent's status is still BUSY. More info." }, { "info": { "name": "Clear agent wrap up time", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/ccaas/voice/2/agent/:agentId/wrap-up-time/clear", "params": [ { "name": "agentId", "value": "", "type": "path", "description": "Agent id of agent wrap up to clear." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to clear the agent wrap up time after a call. After that, the agent will no longer have Wrapping status. Wrap up is the time after a call during which an agent's status is still BUSY. More info." }, { "info": { "name": "Transfer call to another agent", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/ccaas/voice/2/conversation/:conversationId/transfer/agent", "params": [ { "name": "conversationId", "value": "82f57414-b989-4856-ac9f-32a54e9ee86b", "type": "path", "description": "Conversation ID whose call is being transferred." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to transfer a call to another agent. Please note that the targeted agent must be available for the transfer to succeed. The conversation will be assigned to the targeted agent once they answer the call. More info." }, { "info": { "name": "Fetch queues eligible as transfer destination", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ccaas/voice/2/transfer/queues", "params": [ { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method retrieves a list of all queues and returns them along with their current activity status. The activity status indicates whether or not a queue is currently inside of working hours. The list of queues and their activity can be used to determine which queues are currently able to receive incoming transfer requests. More info." }, { "info": { "name": "Transfer call to another queue", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/ccaas/voice/2/conversation/:conversationId/transfer/queue", "params": [ { "name": "conversationId", "value": "82f57414-b989-4856-ac9f-32a54e9ee86b", "type": "path", "description": "Conversation ID whose call is being transferred." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to transfer a call to another queue. Please note that the targeted queue must be within working hours and have auto-assignment enabled for the transfer to succeed. The agent selection process will be run, and the conversation will be assigned to the agent who answers the call. More info." }, { "info": { "name": "Transfer call to external number", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/ccaas/voice/2/conversation/:conversationId/transfer/external-number", "params": [ { "name": "conversationId", "value": "82f57414-b989-4856-ac9f-32a54e9ee86b", "type": "path", "description": "Conversation ID whose call is being transferred." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to transfer the call to an external phone number. Depending on the Transfer to External Number configuration, the Agent can transfer the call to any valid phone number or only to the numbers in the People with the external_number tag. More info." }, { "info": { "name": "Get transfer to external number configuration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ccaas/voice/2/transfer-configs/external-number", "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this endpoint to get a Transfer to external number configuration. More info." }, { "info": { "name": "Update transfer to external number configuration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/ccaas/voice/2/transfer-configs/external-number", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this endpoint to update an already existing transfer to external number configuration. More info." }, { "info": { "name": "Get transfer strategy", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ccaas/voice/2/transfer-configs/transfer-strategy", "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this endpoint to get a Transfer Strategy. More info." }, { "info": { "name": "Update transfer strategy", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/ccaas/voice/2/transfer-configs/transfer-strategy", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this endpoint to update an already existing Transfer Strategy. More info." }, { "info": { "name": "Put client on hold", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/ccaas/voice/2/:conversationId/hold", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "Conversation id of the conversation which you want to put on hold." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to put your client on hold. More info." }, { "info": { "name": "Put client off hold", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/ccaas/voice/2/:conversationId/unhold", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "Conversation id of the conversation which you want to put off hold." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to release your client from hold. More info." }, { "info": { "name": "Get hold configurations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ccaas/voice/2/hold-configs-per-queue", "params": [ { "name": "pageNumber", "value": "", "type": "query", "description": "Number of the page to show." }, { "name": "pageSize", "value": "", "type": "query", "description": "Size of a single page." }, { "name": "sortDirection", "value": "", "type": "query", "description": "Type of sorting (ASC or DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "Field by which the sorting will be done." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this endpoint to retrieve multiple hold configurations based on the page number and page size parameters. More info." }, { "info": { "name": "Create hold configuration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/ccaas/voice/2/hold-configs-per-queue", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this endpoint to create a new hold configuration, together with queues it is applied to. More info." }, { "info": { "name": "Get hold configuration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ccaas/voice/2/hold-configs-per-queue/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the Hold Configuration to get." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this endpoint to get a single hold configuration by its id. More info." }, { "info": { "name": "Update hold configuration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/ccaas/voice/2/hold-configs-per-queue/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the Hold Configuration being updated." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this endpoint to update an already existing hold configuration. More info." }, { "info": { "name": "Delete hold configuration", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/ccaas/voice/2/hold-configs-per-queue/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the Hold Configuration to be deleted." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this endpoint to delete a single, already existing hold configuration by its id. More info." }, { "info": { "name": "Get call timeout", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ccaas/voice/2/call-timeouts", "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to retrieve call timeout configuration." }, { "info": { "name": "Update call timeout", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/ccaas/voice/2/call-timeouts", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to update call timeout configuration. Null field will resolve to default value." }, { "info": { "name": "Remove custom call timeout", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/ccaas/voice/2/call-timeouts", "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to remove the custom inbound call timeout configuration." }, { "info": { "name": "Get filtered working hours", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ccaas/1/working-hours", "params": [ { "name": "name", "value": "", "type": "query", "description": "Optional. Working hours that contain a name case-insensitive." }, { "name": "enabled", "value": "", "type": "query", "description": "Optional. Working hours enable/disable toggle." }, { "name": "isDefault", "value": "", "type": "query", "description": "Optional. Default working hours." }, { "name": "createdAfter", "value": "", "type": "query", "description": "Optional. Filter results created after specific date and time.\nFormat: yyyy-MM-dd'T'HH:mm:ss.SSSZ" }, { "name": "createdBefore", "value": "", "type": "query", "description": "Optional. Filter results created before specific date and time.\nFormat: yyyy-MM-dd'T'HH:mm:ss.SSSZ" }, { "name": "updatedAfter", "value": "", "type": "query", "description": "Optional. Filter results updated after specific date and time.\nFormat: yyyy-MM-dd'T'HH:mm:ss.SSSZ" }, { "name": "updatedBefore", "value": "", "type": "query", "description": "Optional. Filter results updated before specific date and time.\nFormat: yyyy-MM-dd'T'HH:mm:ss.SSSZ" }, { "name": "limit", "value": "", "type": "query", "description": "Size of the result page." }, { "name": "page", "value": "", "type": "query", "description": "Number of the current page." }, { "name": "orderBy", "value": "", "type": "query", "description": "This parameter is used to order your results.\nIf an order is not given, the default order id:asc will be applied.\nPossible ordering fields are properties.\nOrdering direction can be specified with modifiers asc for the ascending ordering or desc for the descending one." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to get a list of working hours with pagination and filtering options. Using filter is optional.\nThe result can be filtered by one or many optional filters described in the parameters." }, { "info": { "name": "Create working hours", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/ccaas/1/working-hours", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to create new working hours.\nAn auto-reply message will be sent to the customer when working hours are set and enabled and a new conversation is created outside of working hours,\nor a holiday is set for the enabled working hours and a new conversation is created during the holiday." }, { "info": { "name": "Get working hours", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ccaas/1/working-hours/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Working hours Id to get." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to get single working hours." }, { "info": { "name": "Update working hours", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/ccaas/1/working-hours/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Working hours Id." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to update working hours." }, { "info": { "name": "Patch working hours", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/ccaas/1/working-hours/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Working hours Id." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method for working hours partial updating." }, { "info": { "name": "Delete working hours", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/ccaas/1/working-hours/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Working hours id." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to delete working hours." }, { "info": { "name": "Get working hours status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ccaas/1/working-hours/:id/status", "params": [ { "name": "id", "value": "", "type": "path", "description": "Working hours Id." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to get current status of working hours." }, { "info": { "name": "Create working hours holiday", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/ccaas/1/working-hours/:workingHoursId/holiday", "params": [ { "name": "workingHoursId", "value": "", "type": "path", "description": "Working hours id." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to create a holiday on working hours.\nAn auto-reply message will be sent to the customer when working hours are set and enabled and a new conversation is created outside of working hours,\nor a holiday is set for the enabled working hours and a new conversation is created during the holiday.\nThis method will return a full working hours object with a created holiday in it." }, { "info": { "name": "Remove working hours holiday", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/ccaas/1/working-hours/:workingHoursId/holiday/:id", "params": [ { "name": "workingHoursId", "value": "", "type": "path", "description": "Id of the working hours to delete holiday from." }, { "name": "id", "value": "", "type": "path", "description": "Holiday Id to delete." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to remove a holiday from working hours." }, { "info": { "name": "Get supported TTS placeholders for purpose", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ccaas/voice/2/tts/options/placeholders/:ttsPurpose", "params": [ { "name": "ttsPurpose", "value": "", "type": "path", "description": "Purpose for which placeholders will be used in text-to-speech." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to retrieve supported TTS placeholders for specified purpose." }, { "info": { "name": "Get away audio message", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ccaas/voice/2/away-audio-message/:workingHoursConfigId", "params": [ { "name": "workingHoursConfigId", "value": "", "type": "path", "description": "Id of the working hours configuration whose away audio message needs to be retrieved." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to retrieve an away audio message by its working hours configuration id." }, { "info": { "name": "Delete away audio message", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/ccaas/voice/2/away-audio-message/:workingHoursConfigId", "params": [ { "name": "workingHoursConfigId", "value": "", "type": "path", "description": "Id of the working hours configuration whose away audio message needs to be deleted." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to delete an away audio message by its working hours configuration id." }, { "info": { "name": "Submit web form data", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/ccaas/1/web-forms/:id/submissions", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the Web Form which will be used to create a conversation." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to submit a new set of data of the given web form. This will create a new conversation with the channel specified in the web form." }, { "info": { "name": "Get web form", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ccaas/1/web-forms/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Web Form Id." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to get an existing web form." }, { "info": { "name": "Update web form", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/ccaas/1/web-forms/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Web Form Id." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to update an existing web form." }, { "info": { "name": "Patch web form", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/ccaas/1/web-forms/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Web Form Id." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to patch an existing web form." }, { "info": { "name": "Delete web form", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/ccaas/1/web-forms/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Web Form Id." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to delete an existing web form." }, { "info": { "name": "Create web form", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/ccaas/1/web-forms", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to create a new web form." }, { "info": { "name": "Start test", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/bots/1/testing/start", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Start the bot simulation to begin test scenario." }, { "info": { "name": "Stop test", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/bots/1/testing/:testId/stop", "params": [ { "name": "testId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Stop the bot simulation to finish test scenario." }, { "info": { "name": "Send message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/bots/1/testing/:testId/send-message", "params": [ { "name": "testId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send inbound message to active test scenario." }, { "info": { "name": "Export SaaS resource", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/saas/1/:resourceType/:resourceId/export", "params": [ { "name": "resourceType", "value": "", "type": "path", "description": "Type of SaaS resource." }, { "name": "resourceId", "value": "", "type": "path", "description": "SaaS resource identifier." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Choose a Saas resource to export and receive the file in the API response." }, { "info": { "name": "Import SaaS resource", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/saas/1/:resourceType/import", "params": [ { "name": "resourceType", "value": "", "type": "path", "description": "Type of SaaS resource." } ], "body": { "type": "multipart-form", "data": [ { "name": "file", "type": "text", "value": "" } ] }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Import a SaaS resource to your account." }, { "info": { "name": "Share SaaS resource", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/saas/1/:resourceType/:resourceId/share", "params": [ { "name": "resourceType", "value": "", "type": "path", "description": "Type of SaaS resource." }, { "name": "resourceId", "value": "", "type": "path", "description": "SaaS resource identifier." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this endpoint to share a SaaS resource with other accounts. You can check the status of your share request [here](https://www.infobip.com/docs/api/customer-engagement/common-assets/saas-request-status)." }, { "info": { "name": "Get SaaS request status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/saas/1/request/:requestId/status", "params": [ { "name": "requestId", "value": "", "type": "path", "description": "Identifier of user request on SaaS." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get the status of your share request." }, { "info": { "name": "Get my campaigns", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/vocalize/2/campaigns/me", "params": [ { "name": "activeOnly", "value": "", "type": "query", "description": "If true, only return active campaigns. Defaults to false." }, { "name": "hasScores", "value": "", "type": "query", "description": "If true, only return campaigns that have scores associated with them. Defaults to false." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get all campaigns for the authenticated user." }, { "info": { "name": "Create campaign", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/vocalize/2/campaigns", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create a new campaign with the specified parameters." }, { "info": { "name": "Get campaign", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/vocalize/2/campaigns/:campaignId", "params": [ { "name": "campaignId", "value": "", "type": "path", "description": "The UUID of the campaign to retrieve." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get a campaign by its ID." }, { "info": { "name": "Delete campaign", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/vocalize/2/campaigns/:campaignId", "params": [ { "name": "campaignId", "value": "", "type": "path", "description": "The UUID of the campaign to delete." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete a campaign with the specified ID." }, { "info": { "name": "Update campaign settings", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/vocalize/2/campaigns/:campaignId/settings", "params": [ { "name": "campaignId", "value": "", "type": "path", "description": "The UUID of the campaign to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update the settings of a campaign with the specified ID." }, { "info": { "name": "Get campaign leaderboard", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/vocalize/2/campaigns/:campaignId/leaderboard", "params": [ { "name": "campaignId", "value": "", "type": "path", "description": "The UUID of the campaign to retrieve the leaderboard for." }, { "name": "page", "value": "", "type": "query", "description": "Page number." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." }, { "name": "fromTime", "value": "", "type": "query", "description": "Start time for filtering scores (datetime, ISO string, or Unix timestamp). Example value: 2023-10-01T00:00:00Z." }, { "name": "toTime", "value": "", "type": "query", "description": "End time for filtering scores (datetime, ISO string, or Unix timestamp). Example value: 2023-10-31T23:59:59Z." }, { "name": "day", "value": "", "type": "query", "description": "Retrieves scores for a specific day. Can't be used with fromTime/toTime. Days count starts at 0, which means that the API will return scores for the first day of the campaign." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get leaderboard for a campaign, sorted by score. Additional query parameters can be used to filter and paginate the results. Filter by fromTime and toTime to get scores within a specific time range. Filter by day to get scores for a specific day of the campaign. You cannot use both fromTime/toTime and day together. If no filters are provided, the leaderboard will show all scores for the campaign, paginated. Users who have not provided their name will not be included in the leaderboard." }, { "info": { "name": "Get campaign statistics", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/vocalize/2/campaigns/:campaignId/stats", "params": [ { "name": "campaignId", "value": "", "type": "path", "description": "The UUID of the campaign to retrieve statistics for." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get statistics for a campaign, including total scores, attempts, and more." }, { "info": { "name": "Delete campaign scores", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/vocalize/2/campaigns/:campaignId/reset", "params": [ { "name": "campaignId", "value": "", "type": "path", "description": "The UUID of the campaign to reset." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete all scores and attempts for a campaign with the specified ID. This action cannot be undone." }, { "info": { "name": "Update score", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/vocalize/2/scores", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint allows users to create or update their score for a specific campaign. If it is the first attempt of the user, the name parameter can be omited." }, { "info": { "name": "Get user score statistics", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/vocalize/2/scores/stats", "params": [ { "name": "campaignId", "value": "", "type": "query", "description": "ID of the campaign to get score stats for." }, { "name": "userId", "value": "", "type": "query", "description": "User ID, a unique identifier for the user." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint retrieves score statistics for a specific user in a campaign." }, { "info": { "name": "Search knowledge base", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/knowledge-base/1/search", "params": [ { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Performs a full-text search across all knowledge base content using filter criteria provided in the request body. Results are paginated." }, { "info": { "name": "Get articles", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/knowledge-base/1/articles", "params": [ { "name": "searchExp", "value": "SMS API", "type": "query", "description": "Search expression to filter articles by name or content." }, { "name": "tag", "value": "sms", "type": "query", "description": "Filter articles by tag name." }, { "name": "status", "value": "PUBLISHED", "type": "query", "description": "Filter by workflow status." }, { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." }, { "name": "sort", "value": "lastUpdatedAt,desc", "type": "query", "description": "Sort criteria in format 'field,direction'. Sortable fields: name, createdAt, lastUpdatedAt, workflowStatus, lastPublishedAt." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Returns a paginated list of articles. Optionally filter by search expression, tag, or workflow status. Results are sorted by last updated date in descending order by default." }, { "info": { "name": "Create article", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/knowledge-base/1/articles", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Creates a new knowledge base article with the provided content, tags, and category assignment." }, { "info": { "name": "Get article", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/knowledge-base/1/articles/:articleId", "params": [ { "name": "articleId", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "path", "description": "Unique identifier of the article." }, { "name": "recordView", "value": "true", "type": "query", "description": "Whether to record a page view for analytics." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Returns the full details of a specific article including its content, metadata, and tags. Optionally records a view for analytics." }, { "info": { "name": "Update article", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/knowledge-base/1/articles/:articleId", "params": [ { "name": "articleId", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "path", "description": "Unique identifier of the article." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Updates an existing knowledge base article with the provided content, tags, and category assignment." }, { "info": { "name": "Delete article", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/knowledge-base/1/articles/:articleId", "params": [ { "name": "articleId", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "path", "description": "Unique identifier of the article." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Soft-deletes a knowledge base article by its identifier." }, { "info": { "name": "Update article status", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/knowledge-base/1/articles/:articleId/status", "params": [ { "name": "articleId", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "path", "description": "Unique identifier of the article." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Changes the workflow status of an article to PUBLISHED or DRAFT." }, { "info": { "name": "Get article versions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/knowledge-base/1/articles/:articleId/history", "params": [ { "name": "articleId", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "path", "description": "Unique identifier of the article." }, { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." }, { "name": "sort", "value": "catalogRecordVersionId,desc", "type": "query", "description": "Sort criteria in format 'field,direction'." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Returns a paginated list of historical versions for a specific article, sorted by version ID in descending order by default." }, { "info": { "name": "Get article comments", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/knowledge-base/1/articles/:articleId/comments", "params": [ { "name": "articleId", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "path", "description": "Unique identifier of the article." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Returns all comments for a specific article." }, { "info": { "name": "Create comment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/knowledge-base/1/articles/:articleId/comments", "params": [ { "name": "articleId", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "path", "description": "Unique identifier of the article." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Adds a new comment to a specific article." }, { "info": { "name": "Update comment", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/knowledge-base/1/articles/:articleId/comments/:commentId", "params": [ { "name": "articleId", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "path", "description": "Unique identifier of the article." }, { "name": "commentId", "value": "1fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "path", "description": "Unique identifier of the comment." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Updates the content of a specific comment on an article." }, { "info": { "name": "Delete comment", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/knowledge-base/1/articles/:articleId/comments/:commentId", "params": [ { "name": "articleId", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "path", "description": "Unique identifier of the article." }, { "name": "commentId", "value": "1fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "path", "description": "Unique identifier of the comment." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Deletes a specific comment from an article. Only the comment author or users with manage permissions can delete." }, { "info": { "name": "Get categories", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/knowledge-base/1/categories", "params": [ { "name": "name", "value": "API Guides", "type": "query", "description": "Filter categories by name." }, { "name": "scope", "value": "INTERNAL", "type": "query", "description": "Filter categories by content scope." }, { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." }, { "name": "sort", "value": "name,asc", "type": "query", "description": "Sort criteria in format 'field,direction'." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Returns a paginated list of categories. Optionally filter by category name or content scope. Results are sorted by name in ascending order by default." }, { "info": { "name": "Get folders", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/knowledge-base/1/folders", "params": [ { "name": "name", "value": "Getting Started", "type": "query", "description": "Filter folders by name." }, { "name": "categoryId", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "query", "description": "Filter folders by category identifier." }, { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." }, { "name": "sort", "value": "name,asc", "type": "query", "description": "Sort criteria in format 'field,direction'." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Returns a paginated list of folders. Optionally filter by folder name or category. Results are sorted by name in ascending order by default." }, { "info": { "name": "Get content tree categories", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/knowledge-base/1/content-tree/nodes/categories", "params": [ { "name": "expandedToNodeId", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "query", "description": "Expand the tree to include the path to this node." }, { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." }, { "name": "sort", "value": "position,asc", "type": "query", "description": "Sort criteria in format 'field,direction'." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Returns a paginated list of top-level category nodes in the content tree. Optionally expand the tree to a specific node. Results are sorted by position in ascending order by default." }, { "info": { "name": "Create content tree node", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/knowledge-base/1/content-tree/nodes", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Creates a new node in the content tree." }, { "info": { "name": "Move content tree node", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/knowledge-base/1/content-tree/nodes/:nodeId/move", "params": [ { "name": "nodeId", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "path", "description": "Unique identifier of the node to move." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Moves a content tree node to a new position relative to a target node." }, { "info": { "name": "Get content tree node", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/knowledge-base/1/content-tree/nodes/:nodeId", "params": [ { "name": "nodeId", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "path", "description": "Unique identifier of the tree node." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Returns the direct children of a specific content tree node." }, { "info": { "name": "Update content tree node", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/knowledge-base/1/content-tree/nodes/:nodeId", "params": [ { "name": "nodeId", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "path", "description": "Unique identifier of the tree node." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Updates an existing content tree node." }, { "info": { "name": "Delete content tree node", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/knowledge-base/1/content-tree/nodes/:nodeId", "params": [ { "name": "nodeId", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "path", "description": "Unique identifier of the tree node." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Deletes a content tree node and its children." }, { "info": { "name": "Get tags", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/knowledge-base/1/tags", "params": [ { "name": "name", "value": "sms", "type": "query", "description": "Filter tags by name." }, { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." }, { "name": "sort", "value": "lastUpdatedAt,desc", "type": "query", "description": "Sort criteria in format 'field,direction'. Sortable fields: name, createdAt, lastUpdatedAt, referencesCount." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Returns a paginated list of tags. Optionally filter by tag name. Results are sorted by last updated date in descending order by default." }, { "info": { "name": "Create tag", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/knowledge-base/1/tags", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Creates a new tag with the given name. Tag name must not contain comma characters." }, { "info": { "name": "Get tag", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/knowledge-base/1/tags/:tagId", "params": [ { "name": "tagId", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "path", "description": "Unique identifier of the tag." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Returns the details of a specific tag by its identifier." }, { "info": { "name": "Update tag", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/knowledge-base/1/tags/:tagId", "params": [ { "name": "tagId", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "path", "description": "Unique identifier of the tag." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Renames an existing tag." }, { "info": { "name": "Get attachment details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/knowledge-base/1/attachments/:attachmentId", "params": [ { "name": "attachmentId", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "path", "description": "Unique identifier of the attachment." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Returns the details of a specific attachment including its metadata and download URL." }, { "info": { "name": "Delete attachment", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/knowledge-base/1/attachments/:attachmentId", "params": [ { "name": "attachmentId", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "path", "description": "Unique identifier of the attachment." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Deletes an attachment by its identifier." }, { "info": { "name": "Get attachment linked article", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/knowledge-base/1/attachments/:attachmentId/linked-article", "params": [ { "name": "attachmentId", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "path", "description": "Unique identifier of the attachment." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Returns the article that is linked to a specific attachment." }, { "info": { "name": "Upload attachment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/knowledge-base/1/attachments", "body": { "type": "multipart-form", "data": [ { "name": "file", "type": "text", "value": "" } ] }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Uploads a file as a new knowledge base attachment. The file is validated and stored." } ] }, { "info": { "name": "ai-hub", "type": "folder" }, "items": [ { "info": { "name": "Query AI Assistant by ID", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/ai/1/aiassistants/:assistantId/query", "params": [ { "name": "assistantId", "value": "1ad5a87f-a6cd-3cc0-58c5-317db01440fd", "type": "path", "description": "Unique identifier of the AI assistant to query." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Forwards a message from a user to a specific AI assistant identified by its unique ID and returns the assistant's response.

This endpoint performs a semantic search over an AI assistant's indexed documents based on configured guidelines. It then generates a response using the LLM connected to the assistant.

The \"use shared history\" feature allowing an AI assistant to utilize the agent's conversation history, is only available if used together with [Infobip AI agents](https://ww" }, { "info": { "name": "Retrieve Context from AI Assistant", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/ai/1/aiassistants/:assistantId/retrieve-context", "params": [ { "name": "assistantId", "value": "1ad5a87f-a6cd-3cc0-58c5-317db01440fd", "type": "path", "description": "Unique identifier of the AI assistant from which to retrieve context." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Retrieves the most relevant context chunks from an AI assistant's knowledge base for a given message.

This endpoint performs a semantic search over the assistant's indexed documents and returns the most relevant text segments (top k chunks). You can specify how many chunks to return and optionally enable re-ranking for more accurate results.

The \"use shared history\" feature allowing an AI assistant to utilize the agent's conversation history, is only available if used together " } ] }, { "info": { "name": "channels", "type": "folder" }, "items": [ { "info": { "name": "Send SMS message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/sms/3/messages", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "With this API method, you can do anything from sending a basic message to one person, all the way to sending customized messages to thousands of recipients in one go. It comes with a range of useful features like transliteration, scheduling, and tracking in a unified way.\\\nIf utilizing Message Delivery Reports webhook, please consult the documentation provided at [Receive outbound SMS message reports](#channels/sms/receive-outbound-sms-message-report-v3).\\\nThis endpoint is the successor of [Send" }, { "info": { "name": "Send SMS message over query parameters", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/sms/3/text/query", "params": [ { "name": "bulkId", "value": "", "type": "query", "description": "Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request." }, { "name": "from", "value": "InfoSMS", "type": "query", "description": "The sender ID which can be alphanumeric or numeric (e.g., `CompanyName`)." }, { "name": "to", "value": "41793026727,41793026834", "type": "query", "description": "List of message recipients." }, { "name": "text", "value": "Message text", "type": "query", "description": "Content of the message being sent." }, { "name": "flash", "value": "true", "type": "query", "description": "Sends a [flash SMS](https://www.infobip.com/docs/sms/message-types#flash-sms) if set to true." }, { "name": "transliteration", "value": "TURKISH", "type": "query", "description": "Conversion of a message text from one script to another." }, { "name": "languageCode", "value": "TR", "type": "query", "description": "Code for language character set of a message content." }, { "name": "intermediateReport", "value": "true", "type": "query", "description": "Use a [real-time intermediate delivery report](#channels/sms/receive-outbound-sms-message-report-v3) that will be sent on your callback server." }, { "name": "notifyUrl", "value": "https://www.example.com", "type": "query", "description": "The URL on your call back server on to which a delivery report will be sent." }, { "name": "notifyContentType", "value": "application/json", "type": "query", "description": "Preferred delivery report content type, `application/json` or `application/xml`." }, { "name": "callbackData", "value": "callbackData", "type": "query", "description": "Additional data that can be used for identifying, managing, or monitoring a message. Data included here will also be automatically included in the message [Delivery Report](#channels/sms/get-outbound-sms-message-delivery-reports-v3). The maximum value is 4000 characters." }, { "name": "validityPeriod", "value": "720", "type": "query", "description": "The message validity period in minutes. When the period expires, it will not be allowed for the message to be sent. Validity period longer than 48h is not supported. Any bigger value will automatically default back to `2880`." }, { "name": "sendAt", "value": "", "type": "query", "description": "Date and time when the message is to be sent. Used for [scheduled SMS](#channels/sms/get-scheduled-sms-messages). Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`. Must be sooner than 180 days from now." }, { "name": "includeSmsCountInResponse", "value": "", "type": "query", "description": "Set to true to return smsCount in the response. Default is false. smsCount is the total count of SMS submitted in the request. SMS messages have a character limit and messages longer than that limit will be split into multiple SMS and reflected in the total count of SMS submitted. " }, { "name": "trackingUrl", "value": "", "type": "query", "description": "The URL of your callback server on to which the Click report will be sent." }, { "name": "trackingType", "value": "Custom tracking type", "type": "query", "description": "Sets a custom conversion type naming convention, e.g. ONE_TIME_PIN, SOCIAL_INVITES, etc." }, { "name": "indiaDltContentTemplateId", "value": "1111111111111111111", "type": "query", "description": "The ID of your registered DLT (Distributed Ledger Technology) content template." }, { "name": "indiaDltPrincipalEntityId", "value": "1111111111111111112", "type": "query", "description": "Your DLT (Distributed Ledger Technology) entity id." }, { "name": "indiaDltTelemarketerId", "value": "111111111111", "type": "query", "description": "Your assigned Telemarketer ID. (required for Aggregators)" }, { "name": "turkeyIysBrandCode", "value": "", "type": "query", "description": "Brand code is an ID of the company based on a company VAT number. If not provided in request, default value is used from your Infobip account." }, { "name": "turkeyIysRecipientType", "value": "", "type": "query", "description": "Recipient Type must be TACIR or BIREYSEL" }, { "name": "southKoreaResellerCode", "value": "", "type": "query", "description": "Reseller identification code: 9-digit registration number in the business registration certificate for South Korea. Resellers should submit this when sending." }, { "name": "southKoreaTitle", "value": "", "type": "query", "description": "Title of the message." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "All message parameters of the message can be defined in the query string. Use this method only if [Send SMS message](#channels/sms/send-sms-messages) is not an option for your use case!
**Note:** Make sure that special characters are properly encoded. Use a [URL encoding reference](https://www.w3schools.com/tags/ref_urlencode.asp) as a guide. This endpoint is the successor of [Send SMS message over query parameters](#channels/sms/send-sms-message-over-query-parameters)." }, { "info": { "name": "Send SMS message over query parameters", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/sms/1/text/query", "params": [ { "name": "username", "value": "", "type": "query", "description": "Username for authentication." }, { "name": "password", "value": "", "type": "query", "description": "Password for authentication." }, { "name": "bulkId", "value": "", "type": "query", "description": "Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. Anything above 100 characters passed in the request will be clipped during processing and returned in response, reports and logs." }, { "name": "from", "value": "InfoSMS", "type": "query", "description": "The sender ID which can be alphanumeric or numeric (e.g., `CompanyName`)." }, { "name": "to", "value": "41793026727,41793026834", "type": "query", "description": "List of message recipients." }, { "name": "text", "value": "Message text", "type": "query", "description": "Content of the message being sent." }, { "name": "flash", "value": "true", "type": "query", "description": "Sends a [flash SMS](https://www.infobip.com/docs/sms/message-types#flash-sms) if set to true." }, { "name": "transliteration", "value": "TURKISH", "type": "query", "description": "Conversion of a message text from one script to another." }, { "name": "languageCode", "value": "TR", "type": "query", "description": "Code for language character set of a message content." }, { "name": "intermediateReport", "value": "true", "type": "query", "description": "Use a [real-time intermediate delivery report](#channels/sms/receive-outbound-sms-message-report) that will be sent on your callback server." }, { "name": "notifyUrl", "value": "https://www.example.com", "type": "query", "description": "The URL on your call back server on to which a delivery report will be sent." }, { "name": "notifyContentType", "value": "application/json", "type": "query", "description": "Preferred delivery report content type, `application/json` or `application/xml`." }, { "name": "callbackData", "value": "callbackData", "type": "query", "description": "Additional data that can be used for identifying, managing, or monitoring a message. Data included here will also be automatically included in the message [Delivery Report](#channels/sms/get-outbound-sms-message-delivery-reports). The maximum value is 4000 characters." }, { "name": "validityPeriod", "value": "720", "type": "query", "description": "The message validity period in minutes. When the period expires, it will not be allowed for the message to be sent. Validity period longer than 48h is not supported. Any bigger value will automatically default back to `2880`." }, { "name": "sendAt", "value": "", "type": "query", "description": "Date and time when the message is to be sent. Used for [scheduled SMS](#channels/sms/get-scheduled-sms-messages). Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`. Must be sooner than 180 days from now." }, { "name": "track", "value": "URL", "type": "query", "description": "Sets the conversion element to be tracked. Possible values: `SMS` and `URL`. For more details on SMS Conversion, see: [Track Conversion](https://www.infobip.com/docs/sms/api#track-conversion)." }, { "name": "processKey", "value": "", "type": "query", "description": "The process key which uniquely identifies conversion tracking." }, { "name": "trackingType", "value": "Custom tracking type", "type": "query", "description": "Sets a custom conversion type naming convention, e.g. ONE_TIME_PIN, SOCIAL_INVITES, etc." }, { "name": "indiaDltContentTemplateId", "value": "1111111111111111111", "type": "query", "description": "The ID of your registered DLT (Distributed Ledger Technology) content template." }, { "name": "indiaDltPrincipalEntityId", "value": "1111111111111111112", "type": "query", "description": "Your DLT (Distributed Ledger Technology) entity id." }, { "name": "indiaDltTelemarketerId", "value": "111111111111", "type": "query", "description": "Your assigned Telemarketer ID. (required for Aggregators)" }, { "name": "turkeyIysBrandCode", "value": "", "type": "query", "description": "Brand code is an ID of the company based on a company VAT number. If not provided in request, default value is used from your Infobip account." }, { "name": "turkeyIysRecipientType", "value": "", "type": "query", "description": "Recipient Type must be TACIR or BIREYSEL" }, { "name": "southKoreaResellerCode", "value": "", "type": "query", "description": "Reseller identification code: 9-digit registration number in the business registration certificate for South Korea. Resellers should submit this when sending." } ] }, "docs": "All message parameters of the message can be defined in the query string. Use this method only if [Send SMS message](#channels/sms/send-sms-message) is not an option for your use case!
**Note:** Make sure that special characters and user credentials are properly encoded. Use a [URL encoding reference](https://www.w3schools.com/tags/ref_urlencode.asp) as a guide." }, { "info": { "name": "Preview SMS message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/sms/1/preview", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Avoid unpleasant surprises and check how different message configurations will affect your message text, number of characters and message parts." }, { "info": { "name": "Send SMS message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/sms/2/text/advanced", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this endpoint to send an SMS and set up a rich set of features, such as batch sending with a single API request, scheduling, URL tracking, language and transliteration configuration, etc. The API response will not contain the final delivery status, use [Delivery Reports](https://www.infobip.com/docs/api/channels/sms/sms-messaging/logs-and-status-reports/receive-outbound-sms-message-report) instead.\\\nIn light of improved features, this endpoint has been superseded. Please visit [Send SMS mess" }, { "info": { "name": "Send binary SMS message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/sms/2/binary/advanced", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send single or multiple binary messages to one or more destination address. The API response will not contain the final delivery status, use [Delivery Reports](https://www.infobip.com/docs/api/channels/sms/sms-messaging/logs-and-status-reports/receive-outbound-sms-message-report) instead.\\\nIn light of improved features, this endpoint has been superseded. Please visit [Send SMS message](#channels/sms/send-sms-messages) for the next version." }, { "info": { "name": "Get scheduled SMS messages", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/sms/1/bulks", "params": [ { "name": "bulkId", "value": "BULK-ID-123-xyz", "type": "query", "description": "Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "See all [scheduled messages](https://www.infobip.com/docs/sms/sms-over-api#schedule-sms) and their scheduled date and time. To schedule a message, use the `sendAt` field when [sending a message](#channels/sms/sms-messaging/outbound-sms/send-sms-messages)." }, { "info": { "name": "Reschedule SMS messages", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/sms/1/bulks", "params": [ { "name": "bulkId", "value": "BULK-ID-123-xyz", "type": "query", "description": "Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Change the date and time of already [scheduled messages](https://www.infobip.com/docs/sms/sms-over-api#schedule-sms). To schedule a message, use the `sendAt` field when [sending a message](#channels/sms/sms-messaging/outbound-sms/send-sms-messages)." }, { "info": { "name": "Get scheduled SMS messages status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/sms/1/bulks/status", "params": [ { "name": "bulkId", "value": "BULK-ID-123-xyz", "type": "query", "description": "Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "See the status of [scheduled messages](https://www.infobip.com/docs/sms/sms-over-api#schedule-sms). To schedule a message, use the `sendAt` field when [sending a message](#channels/sms/sms-messaging/outbound-sms/send-sms-messages)." }, { "info": { "name": "Update scheduled SMS messages status", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/sms/1/bulks/status", "params": [ { "name": "bulkId", "value": "BULK-ID-123-xyz", "type": "query", "description": "Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Change the status or completely cancel sending of [scheduled messages](https://www.infobip.com/docs/sms/sms-over-api#schedule-sms). To schedule a message, use the `sendAt` field when [sending a message](#channels/sms/sms-messaging/outbound-sms/send-sms-messages)." }, { "info": { "name": "Confirm conversion", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/ct/1/log/end/:messageId", "params": [ { "name": "messageId", "value": "", "type": "path", "description": "ID of a converted message." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Use this endpoint to inform the Infobip platform about the successful conversion on your side. Infobip will use this information to monitor SMS performance and provide you with better service. To enable Conversion Tracking, set up the “tracking” object to “SMS” when [sending a message](https://www.infobip.com/docs/api/channels/sms/sms-messaging/outbound-sms) over HTTP API.\nFor more information, see: [Tracking Conversion](https://www.infobip.com/docs/sms/api#track-conversion)." }, { "info": { "name": "Get inbound SMS messages", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/sms/1/inbox/reports", "params": [ { "name": "limit", "value": "2", "type": "query", "description": "Maximum number of messages to be returned in a response. If not set, the latest 50 records are returned. Maximum limit value is `1000` and you can only access messages for the last 48h." }, { "name": "applicationId", "value": "marketing-automation-application", "type": "query", "description": "Application id that the message is linked to. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "entityId", "value": "promotional-traffic-entity", "type": "query", "description": "Entity id that the message is linked to. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "campaignReferenceId", "value": "summersale", "type": "query", "description": "ID of a campaign that was sent in the message." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "If you are unable to receive incoming SMS to the endpoint of your choice in real-time, you can use this API call to fetch messages. Each request will return a batch of received messages, only once. The API request will only return new messages that arrived since the last API request. To use this method, you’d need to:
  1. Buy a number capable of receiving SMS traffic.
  2. Specify a forwarding end" }, { "info": { "name": "Get outbound SMS message delivery reports", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/sms/3/reports", "params": [ { "name": "bulkId", "value": "", "type": "query", "description": "The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address." }, { "name": "messageId", "value": "", "type": "query", "description": "The ID that uniquely identifies the message sent." }, { "name": "limit", "value": "1", "type": "query", "description": "Maximum number of delivery reports to be returned. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access reports for the last 48h." }, { "name": "entityId", "value": "promotional-traffic-entity", "type": "query", "description": "Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "applicationId", "value": "marketing-automation-application", "type": "query", "description": "Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "campaignReferenceId", "value": "summersale", "type": "query", "description": "ID of a campaign that was sent in the message." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "If you are unable to receive real-time message delivery reports towards your endpoint for various reasons, we offer you an API method to fetch batches of message reports to confirm whether specific messages have been delivered. Each request towards this endpoint returns batches of the latest message reports. The API returns each report only once. If the message status changes again after retrieval, the endpoint returns a new report for the updated status on the next request." }, { "info": { "name": "Get outbound SMS message logs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/sms/3/logs", "params": [ { "name": "mcc", "value": "", "type": "query", "description": "Mobile Country Code." }, { "name": "mnc", "value": "", "type": "query", "description": "Mobile Network Code. Mobile Country Code is required if this property is used." }, { "name": "sender", "value": "", "type": "query", "description": "The sender ID which can be alphanumeric or numeric." }, { "name": "destination", "value": "", "type": "query", "description": "Message destination address." }, { "name": "bulkId", "value": "BULK-ID-123-xyz", "type": "query", "description": "Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. May contain multiple comma-separated values. Maximum length 2048 characters." }, { "name": "messageId", "value": "MESSAGE-ID-123-xyz,MESSAGE-ID-124-xyz", "type": "query", "description": "Unique message ID for which a log is requested. May contain multiple comma-separated values. Maximum length 2048 characters." }, { "name": "generalStatus", "value": "", "type": "query" }, { "name": "sentSince", "value": "2020-02-22T17:42:05.390+01:00", "type": "query", "description": "The logs will only include messages sent after this date. Use it alongside sentUntil to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ." }, { "name": "sentUntil", "value": "2020-02-23T17:42:05.390+01:00", "type": "query", "description": "The logs will only include messages sent before this date. Use it alongside sentSince to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of messages to include in logs. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access logs for the last 48h." }, { "name": "entityId", "value": "promotional-traffic-entity", "type": "query", "description": "Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "applicationId", "value": "marketing-automation-application", "type": "query", "description": "Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "campaignReferenceId", "value": "summersale", "type": "query", "description": "ID of a campaign that was sent in the message. May contain multiple comma-separated values." }, { "name": "useCursor", "value": "", "type": "query", "description": "Flag used to enable cursor-based pagination. When set to true, the system will use the cursor to fetch the next set of logs." }, { "name": "cursor", "value": "", "type": "query", "description": "Value which represents the current position in the data set. For the first request, this field shouldn't be defined. In subsequent requests, use the `nextCursor` value returned from the previous response to continue fetching data." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to obtain the logs associated with outbound messages. The available logs are limited to those generated in the last 48 hours, and you can retrieve a maximum of only 1000 logs per call. See [message delivery reports](#channels/sms/get-outbound-sms-message-delivery-reports-v3) if your use case is to verify message delivery." }, { "info": { "name": "Get outbound SMS message delivery reports", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/sms/1/reports", "params": [ { "name": "bulkId", "value": "", "type": "query", "description": "Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request." }, { "name": "messageId", "value": "", "type": "query", "description": "Unique message ID for which a report is requested." }, { "name": "limit", "value": "2", "type": "query", "description": "Maximum number of delivery reports to be returned. If not set, the latest 50 records are returned. Maximum limit value is `1000` and you can only access reports for the last 48h." }, { "name": "applicationId", "value": "marketing-automation-application", "type": "query", "description": "Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "entityId", "value": "promotional-traffic-entity", "type": "query", "description": "Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "campaignReferenceId", "value": "summersale", "type": "query", "description": "ID of a campaign that was sent in the message." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "If you are for any reason unable to receive real-time delivery reports on your endpoint, you can use this API method to learn if and when the message has been delivered to the recipient. Each request will return a batch of delivery reports - only once. The following API request will return only new reports that arrived since the last API request in the last 48 hours." }, { "info": { "name": "Get outbound SMS message logs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/sms/1/logs", "params": [ { "name": "from", "value": "", "type": "query", "description": "The sender ID which can be alphanumeric or numeric." }, { "name": "to", "value": "", "type": "query", "description": "Message destination address." }, { "name": "bulkId", "value": "BULK-ID-123-xyz", "type": "query", "description": "Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. May contain multiple comma-separated values. Maximum length 2048 characters." }, { "name": "messageId", "value": "MESSAGE-ID-123-xyz,MESSAGE-ID-124-xyz", "type": "query", "description": "Unique message ID for which a log is requested. May contain multiple comma-separated values. Maximum length 2048 characters." }, { "name": "generalStatus", "value": "", "type": "query", "description": "Sent [message status](https://www.infobip.com/docs/essentials/response-status-and-error-codes#api-status-codes)." }, { "name": "sentSince", "value": "2015-02-22T17:42:05.390+0100", "type": "query", "description": "The logs will only include messages sent after this date. Use it alongside `sentUntil` to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`." }, { "name": "sentUntil", "value": "2015-02-22T19:42:05.390+0100", "type": "query", "description": "The logs will only include messages sent before this date. Use it alongside `sentSince` to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of messages to include in logs. If not set, the latest 50 records are returned. Maximum limit value is `1000` and you can only access logs for the last 48h." }, { "name": "mcc", "value": "", "type": "query", "description": "Mobile Country Code." }, { "name": "mnc", "value": "", "type": "query", "description": "Mobile Network Code. Mobile Country Code is required if this property is used. " }, { "name": "applicationId", "value": "marketing-automation-application", "type": "query", "description": "Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "entityId", "value": "promotional-traffic-entity", "type": "query", "description": "Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "campaignReferenceId", "value": "summersale", "type": "query", "description": "ID of a campaign that was sent in the message. May contain multiple comma-separated values." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method for displaying logs for example in the user interface. Available are the logs for the last 48 hours and you can only retrieve maximum of 1000 logs per call. See [message delivery reports](#channels/sms/get-outbound-sms-message-delivery-reports) if your use case is to verify message delivery." }, { "info": { "name": "Send MMS messages", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/mms/2/messages", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to send MMS messages to a recipient or multiple recipients in one request." }, { "info": { "name": "Send MMS message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/mms/1/advanced", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to send one MMS or bulk MMS to a recipient or multiple recipients in one request." }, { "info": { "name": "Upload binary content", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/mms/1/content", "headers": [ { "name": "X-Content-Id", "value": "image_1_jpg" }, { "name": "X-Media-Type", "value": "image/jpeg" }, { "name": "X-Validity-Period-Minutes", "value": "70000" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to upload binary content that you can reference when sending MMS messages." }, { "info": { "name": "Get inbound MMS messages", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/mms/1/inbox/reports", "params": [ { "name": "limit", "value": "2", "type": "query", "description": "Maximum number of delivery reports that will be returned." }, { "name": "applicationId", "value": "ApplicationExample", "type": "query", "description": "[Application](https://www.infobip.com/docs/cpaas-x/application-and-entity-management#application) identifier used for filtering." }, { "name": "entityId", "value": "EntityExample", "type": "query", "description": "[Entity](https://www.infobip.com/docs/cpaas-x/application-and-entity-management#entity) identifier used for filtering." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "If for some reason you are unable to receive incoming MMS at the endpoint of your choice in real time, you can use this API call to fetch messages. Each request will return a batch of received messages - only once. The following API request will return only new messages that arrived since the last API request." }, { "info": { "name": "Get MMS delivery reports", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/mms/2/reports", "params": [ { "name": "bulkId", "value": "", "type": "query", "description": "The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address." }, { "name": "messageId", "value": "", "type": "query", "description": "The ID that uniquely identifies the message sent." }, { "name": "limit", "value": "1", "type": "query", "description": "Maximum number of delivery reports to be returned. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access reports for the last 48h." }, { "name": "entityId", "value": "promotional-traffic-entity", "type": "query", "description": "Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "applicationId", "value": "marketing-automation-application", "type": "query", "description": "Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "campaignReferenceId", "value": "summersale", "type": "query", "description": "ID of a campaign that was sent in the message." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "If you are unable to receive real-time delivery reports towards your endpoint for various reasons, we offer you an API method to fetch batches of delivery reports to confirm whether specific messages have been delivered. Each request towards this endpoint will return batches of the latest delivery reports. Please note they will be returned only once." }, { "info": { "name": "Get outbound MMS message delivery reports", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/mms/1/reports", "params": [ { "name": "bulkId", "value": "BULK-ID-123-xyz", "type": "query", "description": "ID of bulk for which a delivery report is requested." }, { "name": "messageId", "value": "MESSAGE-ID-123-xyz", "type": "query", "description": "ID of MMS for which a delivery report is requested." }, { "name": "limit", "value": "2", "type": "query", "description": "Maximum number of delivery reports that will be returned." }, { "name": "applicationId", "value": "ApplicationExample", "type": "query", "description": "[Application](https://www.infobip.com/docs/cpaas-x/application-and-entity-management#application) identifier used for filtering." }, { "name": "entityId", "value": "EntityExample", "type": "query", "description": "[Entity](https://www.infobip.com/docs/cpaas-x/application-and-entity-management#entity) identifier used for filtering." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "If you are unable to receive real-time delivery reports towards your endpoint for various reasons, we offer you an API method to fetch batches of delivery reports to confirm whether specific messages have been delivered. Each request towards this endpoint will return batches of the latest delivery reports. Please note they will be returned only once." }, { "info": { "name": "Get MMS message logs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/mms/2/logs", "params": [ { "name": "mcc", "value": "", "type": "query", "description": "Filter logs by mobile country code." }, { "name": "mnc", "value": "", "type": "query", "description": "Filter logs by mobile network code." }, { "name": "sender", "value": "", "type": "query", "description": "The sender ID which can be alphanumeric or numeric." }, { "name": "destination", "value": "", "type": "query", "description": "Message destination address." }, { "name": "bulkId", "value": "BULK-ID-123-xyz", "type": "query", "description": "Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. May contain multiple comma-separated values. Maximum length 2048 characters." }, { "name": "messageId", "value": "MESSAGE-ID-123-xyz,MESSAGE-ID-124-xyz", "type": "query", "description": "Unique message ID for which a log is requested. May contain multiple comma-separated values. Maximum length 2048 characters." }, { "name": "generalStatus", "value": "", "type": "query" }, { "name": "sentSince", "value": "2020-02-22T17:42:05.390+01:00", "type": "query", "description": "The logs will only include messages sent after this date. Use it alongside sentUntil to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ." }, { "name": "sentUntil", "value": "2020-02-23T17:42:05.390+01:00", "type": "query", "description": "The logs will only include messages sent before this date. Use it alongside sentSince to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of messages to include in logs. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access logs for the last 48h." }, { "name": "entityId", "value": "promotional-traffic-entity", "type": "query", "description": "Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "applicationId", "value": "marketing-automation-application", "type": "query", "description": "Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "campaignReferenceId", "value": "summersale", "type": "query", "description": "ID of a campaign that was sent in the message. May contain multiple comma-separated values." }, { "name": "useCursor", "value": "", "type": "query", "description": "Flag used to enable cursor-based pagination. When set to true, the system will use the cursor to fetch the next set of logs." }, { "name": "cursor", "value": "", "type": "query", "description": "Value which represents the current position in the data set. For the first request, this field shouldn't be defined. In subsequent requests, use the `nextCursor` value returned from the previous response to continue fetching data." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method for displaying logs for example in the user interface. Available are the logs for the last 48 hours." }, { "info": { "name": "Get outbound MMS message logs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/mms/1/logs", "params": [ { "name": "from", "value": "10950", "type": "query", "description": "The sender ID which can be alphanumeric or numeric." }, { "name": "to", "value": "41793026727", "type": "query", "description": "Message destination address." }, { "name": "bulkId", "value": "3746923784", "type": "query", "description": "Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request." }, { "name": "messageId", "value": "43u2ih-6453jbh-897kfs90u2nj", "type": "query", "description": "Unique message ID for which a log is requested." }, { "name": "generalStatus", "value": "ACCEPTED", "type": "query", "description": "Sent [message status](https://www.infobip.com/docs/essentials/response-status-and-error-codes#api-status-codes)." }, { "name": "sentSince", "value": "2023-04-16T12:00:00.390Z", "type": "query", "description": "The logs will only include messages sent after this date. Use it together with sentUntil to return a time range or if you want to fetch more than 1000 logs allowed per call. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`." }, { "name": "sentUntil", "value": "2023-04-17T12:00:00.390Z", "type": "query", "description": "The logs will only include messages sent before this date. Use it together with sentBefore to return a time range or if you want to fetch more than 1000 logs allowed per call. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`." }, { "name": "limit", "value": "100", "type": "query", "description": "Maximum number of messages to include in logs. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access logs for the last 48h. If you have more than 1000 logs in that period, you can retrieve remaining logs by using sentBefore and sentUntil." }, { "name": "mcc", "value": "22801", "type": "query", "description": "Mobile Country Code." }, { "name": "mnc", "value": "22823", "type": "query", "description": "Mobile Network Code." }, { "name": "applicationId", "value": "test-application", "type": "query", "description": "The application used when sending the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "entityId", "value": "test-entity", "type": "query", "description": "The entity used when sending the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method for displaying logs for example in the user interface. Available are the logs for the last 48 hours and you can only retrieve maximum of 1000 logs per call. See [message delivery reports](#channels/mms/get-outbound-mms-message-delivery-reports) if your use case is to verify message delivery." }, { "info": { "name": "Get calls configurations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/configurations", "params": [ { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get calls configurations." }, { "info": { "name": "Create calls configuration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/configurations", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create calls configuration." }, { "info": { "name": "Get calls configuration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/configurations/:callsConfigurationId", "params": [ { "name": "callsConfigurationId", "value": "", "type": "path", "description": "Calls configuration ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get a single calls configuration." }, { "info": { "name": "Update calls configuration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/calls/1/configurations/:callsConfigurationId", "params": [ { "name": "callsConfigurationId", "value": "", "type": "path", "description": "Calls configuration ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update calls configuration." }, { "info": { "name": "Delete calls configuration", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/calls/1/configurations/:callsConfigurationId", "params": [ { "name": "callsConfigurationId", "value": "", "type": "path", "description": "Calls configuration ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete calls configuration." }, { "info": { "name": "Get calls", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/calls", "params": [ { "name": "type", "value": "PHONE", "type": "query", "description": "Call endpoint type." }, { "name": "callsConfigurationId", "value": "dc5942707c704551a00cd2ea", "type": "query", "description": "Calls Configuration ID." }, { "name": "applicationId", "value": "61c060db2675060027d8c7a6", "type": "query", "description": "Application ID." }, { "name": "from", "value": "44790123456", "type": "query", "description": "Caller identifier." }, { "name": "to", "value": "44790987654", "type": "query", "description": "Callee identifier." }, { "name": "direction", "value": "OUTBOUND", "type": "query", "description": "Call direction." }, { "name": "status", "value": "FINISHED", "type": "query", "description": "Call state." }, { "name": "startTimeAfter", "value": "2022-05-01T14:25:45.125+0000", "type": "query", "description": "Date and time for when the call has been created. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ`." }, { "name": "conferenceId", "value": "066675c6-0db6-0db9-b032-031964d09af4", "type": "query", "description": "Conference ID." }, { "name": "dialogId", "value": "6c73cbdc-c956-4bf5-a026-318236559167", "type": "query", "description": "Dialog ID." }, { "name": "bulkId", "value": "bde6deaa-23af-4340-aac7-f3fa063c4215", "type": "query", "description": "Bulk ID." }, { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get calls with pagination." }, { "info": { "name": "Create call", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/calls", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create an outbound call to a given endpoint." }, { "info": { "name": "Get call", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/calls/:callId", "params": [ { "name": "callId", "value": "", "type": "path", "description": "Call ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get a single call." }, { "info": { "name": "Get calls history", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/calls/history", "params": [ { "name": "type", "value": "PHONE", "type": "query", "description": "Call endpoint type." }, { "name": "callsConfigurationId", "value": "dc5942707c704551a00cd2ea", "type": "query", "description": "Calls Configuration ID." }, { "name": "applicationId", "value": "61c060db2675060027d8c7a6", "type": "query", "description": "Application ID." }, { "name": "from", "value": "44790123456", "type": "query", "description": "Caller identifier." }, { "name": "to", "value": "44790987654", "type": "query", "description": "Callee identifier." }, { "name": "direction", "value": "OUTBOUND", "type": "query", "description": "Call direction." }, { "name": "status", "value": "FINISHED", "type": "query", "description": "Call state." }, { "name": "startTimeAfter", "value": "2022-05-01T14:25:45.125+0000", "type": "query", "description": "Date and time for when the call has been created. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ`." }, { "name": "conferenceId", "value": "066675c6-0db6-0db9-b032-031964d09af4", "type": "query", "description": "Conference ID." }, { "name": "dialogId", "value": "6c73cbdc-c956-4bf5-a026-318236559167", "type": "query", "description": "Dialog ID." }, { "name": "bulkId", "value": "bde6deaa-23af-4340-aac7-f3fa063c4215", "type": "query", "description": "Bulk ID." }, { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get calls history with pagination. Calls history retention period is 5 days." }, { "info": { "name": "Get call history", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/calls/:callId/history", "params": [ { "name": "callId", "value": "", "type": "path", "description": "Call ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get a single call history. Call history retention period is 5 days." }, { "info": { "name": "Connect calls", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/connect", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Connect calls in a conference." }, { "info": { "name": "Connect with new call", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/calls/:callId/connect", "params": [ { "name": "callId", "value": "", "type": "path", "description": "Call ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Connect an existing call with a new call in a conference." }, { "info": { "name": "Send ringing", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/calls/:callId/send-ringing", "params": [ { "name": "callId", "value": "", "type": "path", "description": "Call ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send SIP ringtone to an unanswered inbound call." }, { "info": { "name": "Pre-answer", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/calls/:callId/pre-answer", "params": [ { "name": "callId", "value": "", "type": "path", "description": "Call ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Pre-answer a call to handle early media." }, { "info": { "name": "Answer", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/calls/:callId/answer", "params": [ { "name": "callId", "value": "", "type": "path", "description": "Call ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Answer a call." }, { "info": { "name": "Hangup", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/calls/:callId/hangup", "params": [ { "name": "callId", "value": "", "type": "path", "description": "Call ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Hang up a call." }, { "info": { "name": "Play file", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/calls/:callId/play", "params": [ { "name": "callId", "value": "", "type": "path", "description": "Call ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Play an audio file on a call." }, { "info": { "name": "Stop playing file", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/calls/:callId/stop-play", "params": [ { "name": "callId", "value": "", "type": "path", "description": "Call ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Stop playing an audio file on a call." }, { "info": { "name": "Say text", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/calls/:callId/say", "params": [ { "name": "callId", "value": "", "type": "path", "description": "Call ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Say text on a call." }, { "info": { "name": "Send DTMF", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/calls/:callId/send-dtmf", "params": [ { "name": "callId", "value": "", "type": "path", "description": "Call ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send a DTMF on a call." }, { "info": { "name": "Capture DTMF", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/calls/:callId/capture/dtmf", "params": [ { "name": "callId", "value": "", "type": "path", "description": "Call ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Capture a DTMF on a call." }, { "info": { "name": "Capture Speech", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/calls/:callId/capture/speech", "params": [ { "name": "callId", "value": "", "type": "path", "description": "Call ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Capture speech on a call." }, { "info": { "name": "Start transcription", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/calls/:callId/start-transcription", "params": [ { "name": "callId", "value": "", "type": "path", "description": "Call ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Start call transcription." }, { "info": { "name": "Stop transcription", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/calls/:callId/stop-transcription", "params": [ { "name": "callId", "value": "", "type": "path", "description": "Call ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Stop call transcription." }, { "info": { "name": "Start recording", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/calls/:callId/start-recording", "params": [ { "name": "callId", "value": "", "type": "path", "description": "Call ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Start a recording on a call." }, { "info": { "name": "Stop recording", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/calls/:callId/stop-recording", "params": [ { "name": "callId", "value": "", "type": "path", "description": "Call ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Stop a recording on a call." }, { "info": { "name": "Start streaming media", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/calls/:callId/start-media-stream", "params": [ { "name": "callId", "value": "", "type": "path", "description": "Call ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Start streaming media." }, { "info": { "name": "Stop streaming media", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/calls/:callId/stop-media-stream", "params": [ { "name": "callId", "value": "", "type": "path", "description": "Call ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Stop streaming media." }, { "info": { "name": "Send message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/calls/:callId/send-message", "params": [ { "name": "callId", "value": "", "type": "path", "description": "Call ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send a message to a specific WebRTC call leg." }, { "info": { "name": "Request application transfer", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/calls/:callId/application-transfer", "params": [ { "name": "callId", "value": "", "type": "path", "description": "Call ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Request application transfer." }, { "info": { "name": "Accept application transfer", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/calls/:callId/application-transfer/:transferId/accept", "params": [ { "name": "callId", "value": "", "type": "path", "description": "Call ID." }, { "name": "transferId", "value": "", "type": "path", "description": "The unique identifier of a transfer, sent to the receiving application in an `ApplicationTransferRequestedEvent`." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Accept application transfer." }, { "info": { "name": "Reject application transfer", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/calls/:callId/application-transfer/:transferId/reject", "params": [ { "name": "callId", "value": "", "type": "path", "description": "Call ID." }, { "name": "transferId", "value": "", "type": "path", "description": "The unique identifier of a transfer, sent to the receiving application in an `ApplicationTransferRequestedEvent`." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Reject application transfer." }, { "info": { "name": "Get conferences", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/conferences", "params": [ { "name": "name", "value": "Conference", "type": "query", "description": "Conference name." }, { "name": "callId", "value": "066675c6-0db6-0db9-b032-031964d09af4", "type": "query", "description": "Call ID." }, { "name": "callsConfigurationId", "value": "dc5942707c704551a00cd2ea", "type": "query", "description": "Calls Configuration ID." }, { "name": "applicationId", "value": "61c060db2675060027d8c7a6", "type": "query", "description": "Application ID." }, { "name": "startTimeAfter", "value": "2022-05-01T14:25:45.125+0000", "type": "query", "description": "Date and time for when the conference has been created. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ`." }, { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get conferences with pagination." }, { "info": { "name": "Create conference", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/conferences", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create a conference." }, { "info": { "name": "Get conference", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/conferences/:conferenceId", "params": [ { "name": "conferenceId", "value": "", "type": "path", "description": "Conference ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get a single conference." }, { "info": { "name": "Update all calls", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/calls/1/conferences/:conferenceId", "params": [ { "name": "conferenceId", "value": "", "type": "path", "description": "Conference ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update all calls in a conference." }, { "info": { "name": "Get conferences history", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/conferences/history", "params": [ { "name": "name", "value": "Conference", "type": "query", "description": "Conference name." }, { "name": "callId", "value": "066675c6-0db6-0db9-b032-031964d09af4", "type": "query", "description": "Call ID." }, { "name": "callsConfigurationId", "value": "dc5942707c704551a00cd2ea", "type": "query", "description": "Calls Configuration ID." }, { "name": "applicationId", "value": "61c060db2675060027d8c7a6", "type": "query", "description": "Application ID." }, { "name": "startTimeAfter", "value": "2022-05-01T14:25:45.125+0000", "type": "query", "description": "Date and time for when the conference has been created. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ`." }, { "name": "endTimeBefore", "value": "2022-05-01T14:26:45.125+0000", "type": "query", "description": "Date and time for when the conference has been finished. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ`." }, { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get conferences history with pagination. Conferences history retention period is 5 days." }, { "info": { "name": "Get conference history", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/conferences/:conferenceId/history", "params": [ { "name": "conferenceId", "value": "", "type": "path", "description": "Conference ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get a single conference history. Conference history retention period is 5 days." }, { "info": { "name": "Add new call", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/conferences/:conferenceId/call", "params": [ { "name": "conferenceId", "value": "", "type": "path", "description": "Conference ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create a new outbound call and add it to a conference." }, { "info": { "name": "Add existing call", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/calls/1/conferences/:conferenceId/call/:callId", "params": [ { "name": "conferenceId", "value": "", "type": "path", "description": "Conference ID." }, { "name": "callId", "value": "", "type": "path", "description": "Call ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Add an existing call to a conference." }, { "info": { "name": "Update call", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/calls/1/conferences/:conferenceId/call/:callId", "params": [ { "name": "conferenceId", "value": "", "type": "path", "description": "Conference ID." }, { "name": "callId", "value": "", "type": "path", "description": "Call ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update a call in a conference." }, { "info": { "name": "Remove call", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/calls/1/conferences/:conferenceId/call/:callId", "params": [ { "name": "conferenceId", "value": "", "type": "path", "description": "Conference ID." }, { "name": "callId", "value": "", "type": "path", "description": "Call ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Remove a call from a conference. The call stays active after this action." }, { "info": { "name": "Hangup conference", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/conferences/:conferenceId/hangup", "params": [ { "name": "conferenceId", "value": "", "type": "path", "description": "Conference ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Hang up a conference. This action also hangs up all calls in the conference." }, { "info": { "name": "Play file", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/conferences/:conferenceId/play", "params": [ { "name": "conferenceId", "value": "", "type": "path", "description": "Conference ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Play an audio file on a conference." }, { "info": { "name": "Stop playing file", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/conferences/:conferenceId/stop-play", "params": [ { "name": "conferenceId", "value": "", "type": "path", "description": "Conference ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Stop playing an audio file on a conference." }, { "info": { "name": "Say text", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/conferences/:conferenceId/say", "params": [ { "name": "conferenceId", "value": "", "type": "path", "description": "Conference ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Say text on a conference." }, { "info": { "name": "Start recording", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/conferences/:conferenceId/start-recording", "params": [ { "name": "conferenceId", "value": "", "type": "path", "description": "Conference ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Start recording a conference." }, { "info": { "name": "Stop recording", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/conferences/:conferenceId/stop-recording", "params": [ { "name": "conferenceId", "value": "", "type": "path", "description": "Conference ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Stop recording a conference." }, { "info": { "name": "Broadcast text", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/conferences/:conferenceId/broadcast-webrtc-text", "params": [ { "name": "conferenceId", "value": "", "type": "path", "description": "Conference ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Broadcasts a text message to conference WebRTC participants with open data channel." }, { "info": { "name": "Send message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/conferences/:conferenceId/send-message", "params": [ { "name": "conferenceId", "value": "", "type": "path", "description": "Conference ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send a message to all WebRTC participants in a conference." }, { "info": { "name": "Get dialogs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/dialogs", "params": [ { "name": "callsConfigurationId", "value": "dc5942707c704551a00cd2ea", "type": "query", "description": "Calls Configuration ID." }, { "name": "applicationId", "value": "61c060db2675060027d8c7a6", "type": "query", "description": "Application ID." }, { "name": "state", "value": "ESTABLISHED", "type": "query", "description": "Dialog state." }, { "name": "parentCallId", "value": "066675c6-0db6-0db9-b032-031964d09af4", "type": "query", "description": "Parent call ID." }, { "name": "childCallId", "value": "072675c6-3db6-0fb9-b632-031264d09ck2", "type": "query", "description": "Child call ID." }, { "name": "startTimeAfter", "value": "2022-05-01T14:25:45.125+0000", "type": "query", "description": "Date and time for when the dialog has been created. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ`." }, { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get dialogs with pagination." }, { "info": { "name": "Create dialog", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/dialogs", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create a dialog." }, { "info": { "name": "Create dialog with existing calls", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/dialogs/parent-call/:parentCallId/child-call/:childCallId", "params": [ { "name": "parentCallId", "value": "126f327b-dd4e-456d-8a10-1cb78a23bc8a", "type": "path", "description": "Call ID of the parent call to be connected in a dialog." }, { "name": "childCallId", "value": "034e622a-cc7e-456d-8a10-0ba43b11aa5e", "type": "path", "description": "Call ID of the child call to be connected in a dialog. Needs to have been created using [create method](#create-call) with `parentCallId` parameter equal to the parent call ID above." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create a dialog with existing calls." }, { "info": { "name": "Get dialog", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/dialogs/:dialogId", "params": [ { "name": "dialogId", "value": "034e622a-cc7e-456d-8a10-0ba43b11aa5e", "type": "path", "description": "Dialog ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get a single dialog." }, { "info": { "name": "Get dialogs history", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/dialogs/history", "params": [ { "name": "callsConfigurationId", "value": "dc5942707c704551a00cd2ea", "type": "query", "description": "Calls Configuration ID." }, { "name": "applicationId", "value": "61c060db2675060027d8c7a6", "type": "query", "description": "Application ID." }, { "name": "state", "value": "ESTABLISHED", "type": "query", "description": "Dialog state." }, { "name": "parentCallId", "value": "066675c6-0db6-0db9-b032-031964d09af4", "type": "query", "description": "Parent call ID." }, { "name": "childCallId", "value": "072675c6-3db6-0fb9-b632-031264d09ck2", "type": "query", "description": "Child call ID." }, { "name": "startTimeAfter", "value": "2022-05-01T14:25:45.125+0000", "type": "query", "description": "Date and time for when the dialog has been created. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ`." }, { "name": "endTimeBefore", "value": "2022-05-01T14:26:45.125+0000", "type": "query", "description": "Date and time for when the dialog has been finished. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ`." }, { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get dialogs history with pagination. Dialogs history retention period is 5 days." }, { "info": { "name": "Get dialog history", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/dialogs/:dialogId/history", "params": [ { "name": "dialogId", "value": "034e622a-cc7e-456d-8a10-0ba43b11aa5e", "type": "path", "description": "Dialog ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get a single dialog history. Dialog history retention period is 5 days." }, { "info": { "name": "Hangup dialog", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/dialogs/:dialogId/hangup", "params": [ { "name": "dialogId", "value": "", "type": "path", "description": "Dialog ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Hang up a dialog. This action also hangs up all calls in the dialog." }, { "info": { "name": "Play file", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/dialogs/:dialogId/play", "params": [ { "name": "dialogId", "value": "", "type": "path", "description": "Dialog ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Play an audio file on a dialog." }, { "info": { "name": "Say text", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/dialogs/:dialogId/say", "params": [ { "name": "dialogId", "value": "", "type": "path", "description": "Dialog ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Say text on a dialog." }, { "info": { "name": "Stop playing file", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/dialogs/:dialogId/stop-play", "params": [ { "name": "dialogId", "value": "", "type": "path", "description": "Dialog ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Stop playing an audio file on a dialog." }, { "info": { "name": "Start recording", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/dialogs/:dialogId/start-recording", "params": [ { "name": "dialogId", "value": "", "type": "path", "description": "Dialog ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Start recording a dialog." }, { "info": { "name": "Stop recording", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/dialogs/:dialogId/stop-recording", "params": [ { "name": "dialogId", "value": "", "type": "path", "description": "Dialog ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Stop recording a dialog." }, { "info": { "name": "Broadcast text", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/dialogs/:dialogId/broadcast-webrtc-text", "params": [ { "name": "dialogId", "value": "", "type": "path", "description": "Dialog ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Broadcasts a text message to dialog WebRTC call legs with open data channel." }, { "info": { "name": "Send message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/dialogs/:dialogId/send-message", "params": [ { "name": "dialogId", "value": "", "type": "path", "description": "Dialog ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send a message to all WebRTC call legs in a dialog." }, { "info": { "name": "Dialog transfer accept", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/dialogs/:dialogId/transfer/accept", "params": [ { "name": "dialogId", "value": "", "type": "path", "description": "Dialog ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Accepts a dialog transfer request." }, { "info": { "name": "Dialog transfer reject", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/dialogs/:dialogId/transfer/reject", "params": [ { "name": "dialogId", "value": "", "type": "path", "description": "Dialog ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Rejects a dialog transfer request." }, { "info": { "name": "Get SIP trunks", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/sip-trunks", "params": [ { "name": "name", "value": "My SIP trunk", "type": "query", "description": "SIP trunk name." }, { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get SIP trunks with pagination." }, { "info": { "name": "Create SIP trunk", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/sip-trunks", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create a SIP trunk. Fields not sent in request body will take default values. This operation is asynchronous. The SIP trunk will be created in the background." }, { "info": { "name": "Get SIP trunk", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/sip-trunks/:sipTrunkId", "params": [ { "name": "sipTrunkId", "value": "", "type": "path", "description": "SIP trunk ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get a single SIP trunk." }, { "info": { "name": "Update SIP trunk", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/calls/1/sip-trunks/:sipTrunkId", "params": [ { "name": "sipTrunkId", "value": "", "type": "path", "description": "Sip Trunk ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update a SIP trunk. Fields not sent in request body will take default values and overwrite the existing ones. This operation is asynchronous. The SIP trunk will be updated in the background." }, { "info": { "name": "Delete SIP trunk", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/calls/1/sip-trunks/:sipTrunkId", "params": [ { "name": "sipTrunkId", "value": "", "type": "path", "description": "SIP trunk ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete a SIP trunk. This operation is asynchronous. The SIP trunk will be deleted in the background." }, { "info": { "name": "Reset SIP trunk credentials", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/sip-trunks/:sipTrunkId/reset-password", "params": [ { "name": "sipTrunkId", "value": "", "type": "path", "description": "SIP trunk ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Reset credentials. For `REGISTERED` SIP trunks, resets the registration password. For `AUTHENTICATED` SIP trunks, resets the authentication secrets (header value and digest credentials)." }, { "info": { "name": "Get SIP trunk status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/sip-trunks/:sipTrunkId/status", "params": [ { "name": "sipTrunkId", "value": "", "type": "path", "description": "Sip Trunk ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get a SIP trunk status. Successfully deleted SIP trunk does not have status." }, { "info": { "name": "Set SIP trunk status", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/sip-trunks/:sipTrunkId/status", "params": [ { "name": "sipTrunkId", "value": "", "type": "path", "description": "Sip Trunk ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Set a SIP trunk's status." }, { "info": { "name": "Get SIP trunk service addresses", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/sip-trunks/service-addresses", "params": [ { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get SIP trunk service addresses." }, { "info": { "name": "Create SIP trunk service address", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/sip-trunks/service-addresses", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create a SIP trunk service address." }, { "info": { "name": "Get SIP trunk service address", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/sip-trunks/service-addresses/:sipTrunkServiceAddressId", "params": [ { "name": "sipTrunkServiceAddressId", "value": "", "type": "path", "description": "SIP trunk service address ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get SIP trunk service address." }, { "info": { "name": "Update SIP trunk service address", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/calls/1/sip-trunks/service-addresses/:sipTrunkServiceAddressId", "params": [ { "name": "sipTrunkServiceAddressId", "value": "", "type": "path", "description": "SIP trunk service address ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update SIP trunk service address." }, { "info": { "name": "Delete SIP trunk service address", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/calls/1/sip-trunks/service-addresses/:sipTrunkServiceAddressId", "params": [ { "name": "sipTrunkServiceAddressId", "value": "", "type": "path", "description": "SIP trunk service address ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete SIP trunk service address." }, { "info": { "name": "Get countries", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/sip-trunks/service-addresses/countries", "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get countries with shortcodes you'd need for a SIP trunk address." }, { "info": { "name": "Get regions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/sip-trunks/service-addresses/countries/regions", "params": [ { "name": "countryCode", "value": "HRV", "type": "query", "description": "Country code." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get regions with shortcodes you'd need for a SIP trunk address." }, { "info": { "name": "Get files", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/files", "params": [ { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get files with pagination. Maximum number of pages is 100." }, { "info": { "name": "Upload audio file", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/files", "body": { "type": "multipart-form", "data": [ { "name": "file", "type": "text", "value": "" } ] }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Upload an audio file. Uploaded files can be played on calls, dialogs or conferences. The file will be removed if it is not used for 90 days." }, { "info": { "name": "Get file", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/files/:fileId", "params": [ { "name": "fileId", "value": "", "type": "path", "description": "File ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get a single file." }, { "info": { "name": "Delete file", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/calls/1/files/:fileId", "params": [ { "name": "fileId", "value": "", "type": "path", "description": "File ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete a file." }, { "info": { "name": "Get calls recordings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/recordings/calls", "params": [ { "name": "callId", "value": "64d214c5-70b7-4ea6-b2a6-8334d1f34fb4", "type": "query", "description": "Call ID." }, { "name": "callsConfigurationId", "value": "dc5942707c704551a00cd2ea", "type": "query", "description": "Calls Configuration ID." }, { "name": "applicationId", "value": "61c060db2675060027d8c7a6", "type": "query", "description": "Application ID." }, { "name": "entityId", "value": "64d214c5-70b7-4ea6-b2a6-8334d1f34fb4", "type": "query", "description": "Entity ID." }, { "name": "endpointIdentifier", "value": "44790123456", "type": "query", "description": "Endpoint identifier." }, { "name": "startTimeAfter", "value": "2022-05-01T14:25:45.134+0000", "type": "query", "description": "Date and time when the (first) call recording started." }, { "name": "endTimeBefore", "value": "2022-05-01T14:35:45.154+0000", "type": "query", "description": "Date and time when the (last) call recording ended." }, { "name": "direction", "value": "OUTBOUND", "type": "query", "description": "Call direction." }, { "name": "endpointType", "value": "WEBRTC", "type": "query", "description": "Endpoint type." }, { "name": "location", "value": "FRANKFURT", "type": "query", "description": "Recording location." }, { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get the recordings of calls with pagination." }, { "info": { "name": "Get call recordings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/recordings/calls/:callId", "params": [ { "name": "callId", "value": "", "type": "path", "description": "Call ID." }, { "name": "location", "value": "FRANKFURT", "type": "query", "description": "Recording location." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get the recordings for a single call." }, { "info": { "name": "Delete call recordings", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/calls/1/recordings/calls/:callId", "params": [ { "name": "callId", "value": "", "type": "path", "description": "Call ID." }, { "name": "location", "value": "FRANKFURT", "type": "query", "description": "Recording location." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete the recordings for a single call." }, { "info": { "name": "Get conferences recordings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/recordings/conferences", "params": [ { "name": "conferenceId", "value": "64d214c5-70b7-4ea6-b2a6-8334d1f34fb4", "type": "query", "description": "Conference ID." }, { "name": "callsConfigurationId", "value": "dc5942707c704551a00cd2ea", "type": "query", "description": "Calls Configuration ID." }, { "name": "applicationId", "value": "61c060db2675060027d8c7a6", "type": "query", "description": "Application ID." }, { "name": "entityId", "value": "64d214c5-70b7-4ea6-b2a6-8334d1f34fb4", "type": "query", "description": "Entity ID." }, { "name": "conferenceName", "value": "Conference", "type": "query", "description": "Conference name." }, { "name": "callId", "value": "64d214c5-70b7-4ea6-b2a6-8334d1f34fb4", "type": "query", "description": "Filter all conference recordings where call ID was included in the recording." }, { "name": "callEndpointType", "value": "WEBRTC", "type": "query", "description": "Filter all conference recordings where calls with endpoint type were included in the recording." }, { "name": "callEndpointIdentifier", "value": "44790123456", "type": "query", "description": "Filter all conference recordings where calls with endpoint identifier were included in the recording." }, { "name": "startTimeAfter", "value": "2022-05-01T14:25:45.134+0000", "type": "query", "description": "Date and time when the (first) conference recording started." }, { "name": "endTimeBefore", "value": "2022-05-01T14:35:45.154+0000", "type": "query", "description": "Date and time when the (last) conference recording ended." }, { "name": "composition", "value": "true", "type": "query", "description": "Flag indicating whether auto-compose feature was turned on for the recording." }, { "name": "location", "value": "FRANKFURT", "type": "query", "description": "Recording location." }, { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get the recordings of conferences with pagination." }, { "info": { "name": "Get conference recordings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/recordings/conferences/:conferenceId", "params": [ { "name": "conferenceId", "value": "", "type": "path", "description": "Conference ID." }, { "name": "location", "value": "FRANKFURT", "type": "query", "description": "Recording location." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get the recordings for a single conference." }, { "info": { "name": "Delete conference recordings", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/calls/1/recordings/conferences/:conferenceId", "params": [ { "name": "conferenceId", "value": "", "type": "path", "description": "Conference ID." }, { "name": "location", "value": "FRANKFURT", "type": "query", "description": "Recording location." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete the recordings for a single conference." }, { "info": { "name": "Compose conference recording on calls", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/recordings/conferences/:conferenceId/compose", "params": [ { "name": "conferenceId", "value": "", "type": "path", "description": "Conference ID." }, { "name": "location", "value": "FRANKFURT", "type": "query", "description": "Recording location." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Compose conference recording on calls. All calls will be merged into a single audio or video file." }, { "info": { "name": "Get dialogs recordings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/recordings/dialogs", "params": [ { "name": "dialogId", "value": "64d214c5-70b7-4ea6-b2a6-8334d1f34fb4", "type": "query", "description": "Dialog ID." }, { "name": "callsConfigurationId", "value": "dc5942707c704551a00cd2ea", "type": "query", "description": "Calls Configuration ID." }, { "name": "applicationId", "value": "61c060db2675060027d8c7a6", "type": "query", "description": "Application ID." }, { "name": "entityId", "value": "64d214c5-70b7-4ea6-b2a6-8334d1f34fb4", "type": "query", "description": "Entity ID." }, { "name": "callId", "value": "64d214c5-70b7-4ea6-b2a6-8334d1f34fb4", "type": "query", "description": "Filter all dialog recordings where call ID was included in the recording." }, { "name": "callEndpointType", "value": "WEBRTC", "type": "query", "description": "Filter all dialog recordings where calls with endpoint type were included in the recording." }, { "name": "callEndpointIdentifier", "value": "44790123456", "type": "query", "description": "Filter all dialog recordings where calls with endpoint identifier were included in the recording." }, { "name": "startTimeAfter", "value": "2022-05-01T14:25:45.134+0000", "type": "query", "description": "Date and time when the (first) dialog recording started." }, { "name": "endTimeBefore", "value": "2022-05-01T14:35:45.154+0000", "type": "query", "description": "Date and time when the (last) dialog recording ended." }, { "name": "composition", "value": "true", "type": "query", "description": "Flag indicating whether auto-compose feature was turned on for the recording." }, { "name": "location", "value": "FRANKFURT", "type": "query", "description": "Recording location." }, { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get the recordings of dialogs with pagination." }, { "info": { "name": "Get dialog recordings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/recordings/dialogs/:dialogId", "params": [ { "name": "dialogId", "value": "", "type": "path", "description": "Dialog ID." }, { "name": "location", "value": "FRANKFURT", "type": "query", "description": "Recording location." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get the recordings for a single dialog." }, { "info": { "name": "Delete dialog recordings", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/calls/1/recordings/dialogs/:dialogId", "params": [ { "name": "dialogId", "value": "", "type": "path", "description": "Dialog ID." }, { "name": "location", "value": "FRANKFURT", "type": "query", "description": "Recording location." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete the recordings for a single dialog." }, { "info": { "name": "Compose dialog recording on calls", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/recordings/dialogs/:dialogId/compose", "params": [ { "name": "dialogId", "value": "", "type": "path", "description": "Dialog ID." }, { "name": "location", "value": "FRANKFURT", "type": "query", "description": "Recording location." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Compose dialog recording on calls. Both calls will be merged into a single audio or video file." }, { "info": { "name": "Download recording file", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/recordings/files/:fileId", "headers": [ { "name": "Range", "value": "bytes=0-1023" } ], "params": [ { "name": "fileId", "value": "", "type": "path", "description": "File ID." }, { "name": "location", "value": "FRANKFURT", "type": "query", "description": "Recording location." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Download a recording file." }, { "info": { "name": "Delete recording file", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/calls/1/recordings/files/:fileId", "params": [ { "name": "fileId", "value": "", "type": "path", "description": "File ID." }, { "name": "location", "value": "FRANKFURT", "type": "query", "description": "Recording location." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete a single file from a call or conference recording. The call or conference recording metadata will still exist after deleting the file, but the file will not show up anymore in the file list of that call or conference recording." }, { "info": { "name": "Get media-stream configs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/media-stream-configs", "params": [ { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get media-stream configs." }, { "info": { "name": "Create a media-stream configuration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/media-stream-configs", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create a media-stream configuration. For more details, see [documentation](https://www.infobip.com/docs/voice-and-video/calls#media-streaming-understanding-calls-api)." }, { "info": { "name": "Get media-stream configuration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/media-stream-configs/:mediaStreamConfigId", "params": [ { "name": "mediaStreamConfigId", "value": "", "type": "path", "description": "Media-stream configuration ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get a single media-stream configuration." }, { "info": { "name": "Update a media-stream configuration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/calls/1/media-stream-configs/:mediaStreamConfigId", "params": [ { "name": "mediaStreamConfigId", "value": "", "type": "path", "description": "Media-stream configuration ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update a media-stream configuration." }, { "info": { "name": "Delete a media-stream configuration", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/calls/1/media-stream-configs/:mediaStreamConfigId", "params": [ { "name": "mediaStreamConfigId", "value": "", "type": "path", "description": "Media-stream configuration ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete a media-stream configuration." }, { "info": { "name": "Create bulk of calls", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/bulks", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create a bulk of outbound calls. Currently, only `PHONE` endpoints are supported.\nWhen retry options are specified, bulk calls are retried if they meet internal or client retry criteria.\nClient retry criteria are met when call reaches the end device and fails. Internal retry criteria are met when call fails before reaching the end device." }, { "info": { "name": "Get bulk status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/1/bulks/:bulkId", "params": [ { "name": "bulkId", "value": "", "type": "path", "description": "Bulk ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get a single bulk status. Bulk has a status if it was created with scheduling options." }, { "info": { "name": "Reschedule", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/bulks/:bulkId/reschedule", "params": [ { "name": "bulkId", "value": "", "type": "path", "description": "Bulk ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Reschedule a bulk. Rescheduling is possible only if the bulk was created with scheduling options and has not started yet." }, { "info": { "name": "Pause", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/bulks/:bulkId/pause", "params": [ { "name": "bulkId", "value": "", "type": "path", "description": "Bulk ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Pause a bulk. Bulk can be paused if it is in progress and was created with scheduling options." }, { "info": { "name": "Resume", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/bulks/:bulkId/resume", "params": [ { "name": "bulkId", "value": "", "type": "path", "description": "Bulk ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Resume a bulk. Bulk can be resumed if it is paused and was created with scheduling options." }, { "info": { "name": "Cancel", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls/1/bulks/:bulkId/cancel", "params": [ { "name": "bulkId", "value": "", "type": "path", "description": "Bulk ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Cancel a bulk. Bulk can be cancelled if it was created with scheduling options and has not finished yet." }, { "info": { "name": "Create markup language call.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/markuplanguage/1/create", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create a new markup language call which will be processed according to provided markup instructions." }, { "info": { "name": "Get markup language configurations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/markuplanguage/1/config", "params": [ { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get existing markup language configurations with pagination." }, { "info": { "name": "Create a markup language configuration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/markuplanguage/1/config", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create a new markup language configuration." }, { "info": { "name": "Get a markup language configuration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/markuplanguage/1/config/:configId", "params": [ { "name": "configId", "value": "123", "type": "path", "description": "Configuration identifier" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get an existing markup language configuration." }, { "info": { "name": "Update a markup language configuration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/markuplanguage/1/config/:configId", "params": [ { "name": "configId", "value": "123", "type": "path", "description": "Configuration identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update an already existing markup language configuration. Fields that are not sent in the request body will take default values and overwrite existing ones." }, { "info": { "name": "Delete a markup language configuration", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/markuplanguage/1/config/:configId", "params": [ { "name": "configId", "value": "123", "type": "path", "description": "Configuration identifier" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete an existing markup language configuration." }, { "info": { "name": "Send single voice message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/tts/3/single", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to send single voice message to one or more destination addresses." }, { "info": { "name": "Send multiple voice messages", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/tts/3/multi", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to send multiple voice messages to one or more destination addresses." }, { "info": { "name": "Send advanced voice message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/tts/3/advanced", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to send advanced voice messages to one or more destination addresses." }, { "info": { "name": "Get Voices", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/tts/3/voices/:language", "params": [ { "name": "language", "value": "", "type": "path", "description": "Represents the language abbreviation. (e.g. `en`). You can find the list of supported languages in corresponding section for sending voice message." }, { "name": "includeNeural", "value": "", "type": "query", "description": "Indicates whether neural voices should be included in the response.\nIf set to `false` or omitted, only standard voices will be included in the response.\nIf set to `true`, both standard and neural voices will be included in the response.\n" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to retrieve all voices for the given language" }, { "info": { "name": "Get sent bulks", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/tts/3/bulks", "params": [ { "name": "bulkId", "value": "", "type": "query", "description": "Unique ID of the bulk." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method will return information about the scheduled time for a unique bulk message. Canceling and rescheduling are supported only when the voice message request contains at least one message and the message bulkId is unique." }, { "info": { "name": "Reschedule sent bulk", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/tts/3/bulks", "params": [ { "name": "bulkId", "value": "", "type": "query", "description": "Unique ID of the bulk." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to reschedule scheduled TTS bulk. Messages scheduled with the sendAt or Sending speed parameter can be paused, resumed or canceled by changing the message status, or rescheduled using the bulkId parameter as an identifier. Rescheduling is only possible if the bulk status is PAUSED." }, { "info": { "name": "Get sent bulk's status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/tts/3/bulks/status", "params": [ { "name": "bulkId", "value": "", "type": "query", "description": "Unique ID of the bulk." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to get status of scheduled TTS bulk." }, { "info": { "name": "Manage sent bulk's status", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/tts/3/bulks/status", "params": [ { "name": "bulkId", "value": "", "type": "query", "description": "Unique ID of the bulk." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to manage statuses of scheduled TTS bulk. Messages scheduled with the sendAt or sending speed parameter can be paused, resumed or canceled by changing the message status, or rescheduled using the bulkId parameter as an identifier. Only voice messages that were not already sent can be canceled." }, { "info": { "name": "Search Voice IVR Scenarios", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/voice/ivr/1/scenarios", "params": [ { "name": "page", "value": "", "type": "query", "description": "Page number you want to see. Default is 1." }, { "name": "pageSize", "value": "", "type": "query", "description": "Size of the page you want to see. Default is 50." }, { "name": "name", "value": "", "type": "query", "description": "The name to search by." }, { "name": "label", "value": "", "type": "query", "description": "The label of scenario to search by." }, { "name": "lastUsageDateSince", "value": "", "type": "query", "description": "Lower limit of last usage date in `yyyy-MM-dd` format. Note: For scenarios where `lastUsageDate` is `null`, filtering matches `createTime`." }, { "name": "lastUsageDateUntil", "value": "", "type": "query", "description": "Upper limit of last usage date in `yyyy-MM-dd` format. Note: For scenarios where `lastUsageDate` is `null`, filtering matches `createTime`." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to search Voice IVR Scenarios by name. To get a list of all IVR Scenarios, make a request without any parameters." }, { "info": { "name": "Create Voice IVR Scenarios", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/voice/ivr/1/scenarios", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to create a Voice IVR Scenario. The IVR scenario will be removed if not used for more than 1 year." }, { "info": { "name": "Get a Voice IVR Scenario", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/voice/ivr/1/scenarios/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Scenario identifier." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to get a Voice IVR Scenario." }, { "info": { "name": "Update Voice IVR Scenarios", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/voice/ivr/1/scenarios/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Scenario identifier." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to update a Voice IVR Scenario. Changes may take up to 10 minutes to apply." }, { "info": { "name": "Delete Voice IVR Scenarios", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/voice/ivr/1/scenarios/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Scenario identifier (for example E83E787CF2613450157ADA3476171E3F)." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to delete a Voice IVR Scenario." }, { "info": { "name": "Launch IVR Scenario", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/voice/ivr/1/messages", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to start an outbound IVR toward a multiple destinations." }, { "info": { "name": "Search Voice IVR Recorded Files", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/voice/ivr/1/files", "params": [ { "name": "page", "value": "", "type": "query", "description": "Page number you want to see." }, { "name": "pageSize", "value": "", "type": "query", "description": "Size of the page you want to see." }, { "name": "messageId", "value": "", "type": "query", "description": "The message ID to search by." }, { "name": "number", "value": "", "type": "query", "description": "The called phone number to search by." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to search Voice IVR Recorded Audio Files." }, { "info": { "name": "Download Voice IVR Recorded File.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/voice/ivr/1/files/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "File ID to download." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to download Voice IVR Recorded Audio File. The returned audio data is encoded as PCM 16bit 8kHz WAVE audio. The files are available on Infobip servers for 2 months." }, { "info": { "name": "Get files", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/voice/ivr/1/uploads", "params": [ { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get files with pagination. Maximum number of pages is 100." }, { "info": { "name": "Upload file", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/voice/ivr/1/uploads", "body": { "type": "multipart-form", "data": [ { "name": "file", "type": "text", "value": "" } ] }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Upload an audio file to be played in IVR calls. The file will be removed if it is not used for 90 days. Supported formats: `.wav` and `.mp3`." }, { "info": { "name": "Send click-to-call message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/voice/ctc/1/send", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to send click-to-call voice messages." }, { "info": { "name": "Get Voice Delivery Reports", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/voice/1/reports", "params": [ { "name": "bulkId", "value": "", "type": "query", "description": "The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination addresses." }, { "name": "messageId", "value": "", "type": "query", "description": "The ID that uniquely identifies the message sent." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of returned delivery reports. Default value is 50." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to get delivery reports for sent Voice messages, outbound IVR or Click-to-call (without notifyUrl request parameter). Delivery reports are returned only once. Additional delivery report request will return an empty collection." }, { "info": { "name": "Get Voice Delivery Reports", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/tts/3/reports", "params": [ { "name": "bulkId", "value": "", "type": "query", "description": "The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination addresses." }, { "name": "messageId", "value": "", "type": "query", "description": "The ID that uniquely identifies the message sent." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of returned delivery reports. Default value is 50." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This version is deprecated as of July 1st 2020, meaning no fixes/updates will be provided and no new parameters will be added.\n\n\n\"We strongly advise you to update to new [delivery report method](https://www.infobip.com/docs/api/channels/voice/voice-reports-and-logs/get-voice-delivery-reports).\n" }, { "info": { "name": "Get sent Voice logs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/tts/3/logs", "params": [ { "name": "from", "value": "", "type": "query", "description": "The sender ID which can be alphanumeric or numeric." }, { "name": "to", "value": "", "type": "query", "description": "Destination address of the voice message." }, { "name": "bulkId", "value": "", "type": "query", "description": "The ID which uniquely identifies the request." }, { "name": "messageId", "value": "", "type": "query", "description": "The ID that uniquely identifies the message sent." }, { "name": "generalStatus", "value": "", "type": "query", "description": "Sent voice message status group. Indicates whether the message has been successfully sent, not sent, delivered, not delivered, waiting for delivery or any other possible status." }, { "name": "sentSince", "value": "", "type": "query", "description": "Lower limit on date and time of sending a Voice message. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX." }, { "name": "sentUntil", "value": "", "type": "query", "description": "Upper limit on date and time of sending a Voice message. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX." }, { "name": "limit", "value": "", "type": "query", "description": "Maximal number of messages in the returned logs. Default value is 50." }, { "name": "mcc", "value": "", "type": "query", "description": "Mobile country code." }, { "name": "mnc", "value": "", "type": "query", "description": "Mobile network code." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to get logs of sent Voice messages. Voice logs are available for the last 48 hours!" }, { "info": { "name": "Get number masking configurations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/voice/masking/2/config", "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to get all voice number masking configurations." }, { "info": { "name": "Create number masking configuration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/voice/masking/2/config", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to create masking configuration." }, { "info": { "name": "Get number masking configuration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/voice/masking/2/config/:key", "params": [ { "name": "key", "value": "", "type": "path", "description": "Masking configuration identifier." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to get a Voice number masking configuration." }, { "info": { "name": "Update number masking configuration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/voice/masking/2/config/:key", "params": [ { "name": "key", "value": "", "type": "path", "description": "Masking configuration identifier." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to update a Voice number masking configuration." }, { "info": { "name": "Delete number masking configuration", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/voice/masking/2/config/:key", "params": [ { "name": "key", "value": "", "type": "path", "description": "Masking configuration identifier." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to delete a Voice number masking configuration." }, { "info": { "name": "Upload audio files", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/voice/masking/1/upload", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows uploading audio files that can be used on Infobip Voice platform. The method accepts either a URL or an uploaded audio file in the request body. Using both or neither will cause the request to be rejected." }, { "info": { "name": "Get number masking credentials", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/voice/masking/2/credentials", "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to get Voice number masking credentials." }, { "info": { "name": "Create number masking credentials", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/voice/masking/2/credentials", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to create Voice number masking credentials." }, { "info": { "name": "Update number masking credentials", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/voice/masking/2/credentials", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to update Voice number masking credentials." }, { "info": { "name": "Delete number masking credentials", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/voice/masking/2/credentials", "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to delete Voice number masking credentials." }, { "info": { "name": "Get call routes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/callrouting/1/routes", "params": [ { "name": "nameContains", "value": "", "type": "query", "description": "String contained in the name of the route, case-insensitive." }, { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get existing call routes with pagination." }, { "info": { "name": "Create a call route", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/callrouting/1/routes", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create a new call route." }, { "info": { "name": "Get a call route", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/callrouting/1/routes/:routeId", "params": [ { "name": "routeId", "value": "56b3e3ea-e91f-44ed-9d57-c7f05cd358ba", "type": "path", "description": "Route identifier" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get an existing call route." }, { "info": { "name": "Update a call route", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/callrouting/1/routes/:routeId", "params": [ { "name": "routeId", "value": "56b3e3ea-e91f-44ed-9d57-c7f05cd358ba", "type": "path", "description": "Route identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update an already existing call route. Fields that are not sent in the request body will take default values and overwrite existing ones." }, { "info": { "name": "Set order on call route", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/callrouting/1/routes/:routeId", "params": [ { "name": "routeId", "value": "56b3e3ea-e91f-44ed-9d57-c7f05cd358ba", "type": "path", "description": "Route identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Set order on existing call route." }, { "info": { "name": "Delete a call route", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/callrouting/1/routes/:routeId", "params": [ { "name": "routeId", "value": "56b3e3ea-e91f-44ed-9d57-c7f05cd358ba", "type": "path", "description": "Route identifier" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete an existing call route." }, { "info": { "name": "Get recordings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/callrouting/1/recordings", "params": [ { "name": "sortBy", "value": "START_TIME", "type": "query", "description": "Field that will be used for sorting." }, { "name": "sortDirection", "value": "DESC", "type": "query", "description": "Order in which files will be sorted based on sortBy field." }, { "name": "endpointType", "value": "PHONE", "type": "query", "description": "Endpoint type of at least one participant in the recorded call." }, { "name": "phoneNumber", "value": "41792036727", "type": "query", "description": "Phone number that was participant of the recorded call." }, { "name": "sipTrunkId", "value": "60d345fd3a799ec", "type": "query", "description": "SIP Trunk ID that was participant of the recorded call." }, { "name": "sipUsername", "value": "41793026834", "type": "query", "description": "Username on the SIP trunk that was participant of the recorded call." }, { "name": "webrtcIdentity", "value": "WebRTC_user", "type": "query", "description": "WebRTC Identity that was participant of the recorded call." }, { "name": "routeId", "value": "f8fc8aca-786d-4943-9af2-e7ec01b5e80d", "type": "query", "description": "Route ID that was used to establish the recorded call." }, { "name": "routeName", "value": "Sample Route Name", "type": "query", "description": "Route name to be used to match recordings. Name will be matched comparing it to all route names." }, { "name": "correlationId", "value": "d8d84155-3831-43fb-91c9-bb897149a79d", "type": "query", "description": "Correlation ID to match." }, { "name": "startTimeAfter", "value": "2024-05-01T14:25:45.125+0000", "type": "query", "description": "Date and time when the (first) call recording started." }, { "name": "startTimeBefore", "value": "2024-05-01T14:26:45.125+0000", "type": "query", "description": "Date and time when the (last) call recording started." }, { "name": "location", "value": "FRANKFURT", "type": "query", "description": "Recording location." }, { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows searching and filtering based on various recording data properties." }, { "info": { "name": "Delete by correlation ID", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/callrouting/1/recordings", "params": [ { "name": "correlationId", "value": "d8d84155-3831-43fb-91c9-bb897149a79d", "type": "query", "description": "Correlation ID to match." }, { "name": "location", "value": "FRANKFURT", "type": "query", "description": "Recording location." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows deleting call recordings based on correlation ID." }, { "info": { "name": "Download recording file", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/callrouting/1/recordings/files/:fileId", "headers": [ { "name": "Range", "value": "bytes=0-1023" } ], "params": [ { "name": "fileId", "value": "", "type": "path", "description": "File ID to match." }, { "name": "location", "value": "FRANKFURT", "type": "query", "description": "Recording location." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Download a recording file." }, { "info": { "name": "Update route status", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/callrouting/1/routes/:routeId/status", "params": [ { "name": "routeId", "value": "56b3e3ea-e91f-44ed-9d57-c7f05cd358ba", "type": "path", "description": "Route identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update status of existing call route. " }, { "info": { "name": "Simulate route selection", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/callrouting/1/routes/simulate", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Simulates which route will be selected upon predefined request." }, { "info": { "name": "Generate WebRTC Token", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/webrtc/1/token", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint allows you to generate token for WebRTC channel." }, { "info": { "name": "Get WebRTC push configurations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/webrtc/1/webrtc-push-config", "params": [ { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get a page of WebRTC push configurations matching the query criteria." }, { "info": { "name": "Create WebRTC push configuration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/webrtc/1/webrtc-push-config", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create and configure a new WebRTC push configuration." }, { "info": { "name": "Get WebRTC push configuration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/webrtc/1/webrtc-push-config/:id", "params": [ { "name": "id", "value": "454d142b-a1ad-239a-d231-227fa335aadc3", "type": "path", "description": "Id of the WebRTC push configuration to get." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get a single WebRTC push configuration and its details." }, { "info": { "name": "Update WebRTC push configuration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/webrtc/1/webrtc-push-config/:id", "params": [ { "name": "id", "value": "454d142b-a1ad-239a-d231-227fa335aadc3", "type": "path", "description": "Id of the WebRTC push configuration to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Change details of an existing WebRTC push configuration." }, { "info": { "name": "Patch WebRTC push configuration", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/webrtc/1/webrtc-push-config/:id", "params": [ { "name": "id", "value": "454d142b-a1ad-239a-d231-227fa335aadc3", "type": "path", "description": "Id of the WebRTC push configuration to patch." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Change only specific fields of the WebRTC push configuration. Fields left out of the request will remain unchanged." }, { "info": { "name": "Delete WebRTC push configuration", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/webrtc/1/webrtc-push-config/:id", "params": [ { "name": "id", "value": "454d142b-a1ad-239a-d231-227fa335aadc3", "type": "path", "description": "Id of the WebRTC push configuration to delete." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete WebRTC push configuration for the given id." }, { "info": { "name": "Get files", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/webrtc/1/files", "params": [ { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of files per page. Maximum page size is 100." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to get files with pagination." }, { "info": { "name": "Get file", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/webrtc/1/files/:id", "params": [ { "name": "id", "value": "5f4e8861-8ed7-4521-b8c8-f26346726716", "type": "path", "description": "Id of the file." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to get a single file." }, { "info": { "name": "Delete file", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/webrtc/1/files/:id", "params": [ { "name": "id", "value": "5f4e8861-8ed7-4521-b8c8-f26346726716", "type": "path", "description": "Id of the file to be deleted." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to delete a file." }, { "info": { "name": "Download file", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/webrtc/1/files/:id/download", "params": [ { "name": "id", "value": "5f4e8861-8ed7-4521-b8c8-f26346726716", "type": "path", "description": "Id of the file to be downloaded." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to download a file." }, { "info": { "name": "Get WebRTC user activity", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/webrtc/1/user-activity", "params": [ { "name": "identity", "value": "Alice", "type": "query", "description": "The identity of the user on Infobip WebRTC platform." }, { "name": "startTime", "value": "2024-09-10T15:30:45.125+0000", "type": "query", "description": "Start date and time for filtering of the user activity. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ`." }, { "name": "endTime", "value": "2024-09-13T15:30:45.125+0000", "type": "query", "description": "End date and time for filtering of the user activity. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ`." }, { "name": "sessionId", "value": "3f6957f0-79b3-11ef-a56e-ed504659cd80", "type": "query", "description": "An identifier that links different occurrences of `activityType` within the same activity session for a user identity on the Infobip WebRTC platform. When two activity events, distinguished by their `activityType`, happen during the same user activity session, they will share the same `sessionId`." }, { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get a page of a WebRTC user activity matching query criteria." }, { "info": { "name": "Get WebRTC recordings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/webrtc/1/recordings", "params": [ { "name": "sortBy", "value": "START_TIME", "type": "query", "description": "Field that will be used for sorting." }, { "name": "sortDirection", "value": "DESC", "type": "query", "description": "Order in which files will be sorted based on sortBy field." }, { "name": "callType", "value": "WEBRTC_CALL", "type": "query", "description": "Call type of the recorded call." }, { "name": "phoneNumber", "value": "41792036727", "type": "query", "description": "Phone number that was participant of the recorded call." }, { "name": "identity", "value": "Alice", "type": "query", "description": "WebRTC Identity that was participant of the recorded call." }, { "name": "roomName", "value": "conference_room", "type": "query", "description": "Name of the recorded room for ROOM_CALL call type." }, { "name": "roomId", "value": "f8fc8aca-786d-4943-9af2-e7ec01b5e80d", "type": "query", "description": "Id of the recorded room for ROOM_CALL call type. Equivalent to conferenceId." }, { "name": "startTimeAfter", "value": "2024-05-01T14:25:45.125+0000", "type": "query", "description": "Date and time when the (first) call recording started." }, { "name": "startTimeBefore", "value": "2024-05-01T14:26:45.125+0000", "type": "query", "description": "Date and time when the (last) call recording started." }, { "name": "location", "value": "FRANKFURT", "type": "query", "description": "Recording location." }, { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows searching and filtering based on various recording data properties." }, { "info": { "name": "Delete WebRTC recording by ID", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/webrtc/1/recordings/:id", "params": [ { "name": "id", "value": "d8d84155-3831-43fb-91c9-bb897149a79d", "type": "path", "description": "ID of the recording to delete." }, { "name": "location", "value": "FRANKFURT", "type": "query", "description": "Recording location." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows deleting call recordings based on their ID." }, { "info": { "name": "Download WebRTC recording file", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/webrtc/1/recordings/:id/download", "headers": [ { "name": "Range", "value": "bytes=0-1023" } ], "params": [ { "name": "id", "value": "d8d84155-3831-43fb-91c9-bb897149a79d", "type": "path", "description": "ID of the recording to download." }, { "name": "location", "value": "FRANKFURT", "type": "query", "description": "Recording location." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows downloading a WebRTC recording file based on its ID." }, { "info": { "name": "Get call links", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/call-link/1/links", "params": [ { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to retrieve all call links." }, { "info": { "name": "Create call link", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/call-link/1/links", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create a link to send to someone who will then initiate a call." }, { "info": { "name": "Get call link", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/call-link/1/links/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of a call link." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to get a call link by its ID." }, { "info": { "name": "Delete call link", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/call-link/1/links/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of a call link to delete." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to delete a call link by its ID." }, { "info": { "name": "Get configurations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/call-link/1/configs", "params": [ { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to retrieve all call link configurations." }, { "info": { "name": "Create configuration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/call-link/1/configs", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to add a new call link configuration." }, { "info": { "name": "Get configuration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/call-link/1/configs/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of a call link configuration to load." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to retrieve a call link configuration by its ID." }, { "info": { "name": "Update a configuration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/call-link/1/configs/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of a call link configuration to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to overwrite a call link configuration.\nNew values for configuration attributes replace the existing ones. If no value is passed,\nthe attribute is set to empty or to default, if available." }, { "info": { "name": "Partial configuration update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/call-link/1/configs/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of a call link configuration to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to update a call link configuration.\nNew values for configuration attributes replace the existing ones. If no value is passed in the request, the attribute keeps its value." }, { "info": { "name": "Delete configuration", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/call-link/1/configs/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of a call link configuration to delete." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to delete a call link configuration by its ID." }, { "info": { "name": "Get images", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/call-link/1/images", "params": [ { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to retrieve all images." }, { "info": { "name": "Upload image", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/call-link/1/images/upload/:type", "params": [ { "name": "type", "value": "", "type": "path", "description": "Image type, LOGO or BACKGROUND." } ], "body": { "type": "multipart-form", "data": [ { "name": "file", "type": "text", "value": "" } ] }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to upload an image." }, { "info": { "name": "Get image", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/call-link/1/images/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of an image." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to get an image." }, { "info": { "name": "Delete image", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/call-link/1/images/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of an image to delete." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to delete a call link configuration image." }, { "info": { "name": "Get subdomains", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/call-link/1/subdomains", "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to get all subdomains." }, { "info": { "name": "Create subdomain", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/call-link/1/subdomains", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to add a new call link subdomain. Maximum number of domains is 3. Cannot contain \".\"." }, { "info": { "name": "Delete subdomain", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/call-link/1/subdomains/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of a call link subdomain to delete." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to delete a subdomain by its ID." }, { "info": { "name": "Get call link recordings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/call-link/1/recordings", "params": [ { "name": "sortBy", "value": "START_TIME", "type": "query", "description": "Field that will be used for sorting." }, { "name": "sortDirection", "value": "DESC", "type": "query", "description": "Order in which files will be sorted based on sortBy field." }, { "name": "destinationData", "value": "+1234567890", "type": "query", "description": "Destination the call was made towards. For WEBRTC calls, this is the WebRTC identity. For PHONE calls, this is the phone number. For ROOM calls, this is the room name." }, { "name": "destinationType", "value": "PHONE", "type": "query", "description": "Type of call link destination." }, { "name": "callLinkConfigId", "value": "685bede487a709487c584f91", "type": "query", "description": "ID of the call link configuration used to establish the recorded call." }, { "name": "callLinkId", "value": "55a523d1-b769-4466-a4a9-f610899569e5", "type": "query", "description": "ID of a call link used to establish the recorded call." }, { "name": "startTimeAfter", "value": "2025-01-01T00:00:00.000+0000", "type": "query", "description": "Date and time when the (first) call recording started." }, { "name": "startTimeBefore", "value": "2025-01-01T00:00:00.000+0000", "type": "query", "description": "Date and time when the (last) call recording started." }, { "name": "location", "value": "FRANKFURT", "type": "query", "description": "Recording location." }, { "name": "page", "value": "", "type": "query", "description": "Page number for pagination, starting from 0." }, { "name": "size", "value": "", "type": "query", "description": "Number of items per page, maximum is 100." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to filter and retrieve call link recordings." }, { "info": { "name": "Delete call link recording", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/call-link/1/recordings/:id", "params": [ { "name": "id", "value": "55a523d1-b769-4466-a4a9-f610899569e5", "type": "path", "description": "ID of the recording to delete." }, { "name": "location", "value": "FRANKFURT", "type": "query", "description": "Recording location." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to delete a call link recording by its ID." }, { "info": { "name": "Download a recording file", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/call-link/1/recordings/files/:fileId", "headers": [ { "name": "Range", "value": "bytes=0-1023" } ], "params": [ { "name": "fileId", "value": "d8d84155-3831-43fb-91c9-bb897149a79d", "type": "path", "description": "File ID to match." }, { "name": "location", "value": "FRANKFURT", "type": "query", "description": "Recording location." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to download a recording file by its ID." }, { "info": { "name": "Send email messages", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/email/4/messages", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "99% of all use cases can be achieved by using this API method. Everything from sending a simple single message to a single destination, up to batch sending of personalized messages to the thousands of recipients with a single API request. Scheduling and every advanced feature you can think of is supported." }, { "info": { "name": "Upload binary content", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/email/1/content", "headers": [ { "name": "X-Content-Id", "value": "image_1_jpg" }, { "name": "X-Media-Type", "value": "image/jpeg" }, { "name": "X-Validity-Period-Minutes", "value": "3000" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to upload binary content that you can reference when sending Email messages." }, { "info": { "name": "Send fully featured email", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/email/3/send", "body": { "type": "multipart-form", "data": [] }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send an email or multiple emails to a recipient or multiple recipients with CC/BCC enabled." }, { "info": { "name": "Send MIME email", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/email/4/mime", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send an email where you can specify the content as MIME message." }, { "info": { "name": "Get scheduled bulks", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/email/1/bulks", "params": [ { "name": "bulkId", "value": "[object Object]", "type": "query", "description": "The ID that uniquely identifies the sent bulk." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "See the scheduled time of your Email messages." }, { "info": { "name": "Reschedule messages", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/email/1/bulks", "params": [ { "name": "bulkId", "value": "BULK-ID-123-xyz", "type": "query", "description": "The ID that uniquely identifies the sent bulk." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Change the date and time for sending scheduled messages." }, { "info": { "name": "Get scheduled bulk statuses", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/email/1/bulks/status", "params": [ { "name": "bulkId", "value": "BULK-ID-123-xyz", "type": "query", "description": "The ID that uniquely identifies the sent bulk." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "See the status of scheduled email messages." }, { "info": { "name": "Update scheduled message statuses", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/email/1/bulks/status", "params": [ { "name": "bulkId", "value": "BULK-ID-123-xyz", "type": "query", "description": "The ID that uniquely identifies the sent bulk." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Change status or completely cancel sending of scheduled messages." }, { "info": { "name": "Get email message logs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/email/4/logs", "params": [ { "name": "sender", "value": "", "type": "query", "description": "The sender ID which can be alphanumeric or numeric." }, { "name": "destination", "value": "", "type": "query", "description": "Message destination address." }, { "name": "bulkId", "value": "BULK-ID-123-xyz", "type": "query", "description": "Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. May contain multiple comma-separated values. Maximum length 2048 characters." }, { "name": "messageId", "value": "MESSAGE-ID-123-xyz,MESSAGE-ID-124-xyz", "type": "query", "description": "Unique message ID for which a log is requested. May contain multiple comma-separated values. Maximum length 2048 characters." }, { "name": "generalStatus", "value": "", "type": "query" }, { "name": "sentSince", "value": "2020-02-22T17:42:05.390+01:00", "type": "query", "description": "The logs will only include messages sent after this date. Use it alongside sentUntil to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ." }, { "name": "sentUntil", "value": "2020-02-23T17:42:05.390+01:00", "type": "query", "description": "The logs will only include messages sent before this date. Use it alongside sentSince to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of messages to include in logs. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access logs for the last 48h." }, { "name": "entityId", "value": "promotional-traffic-entity", "type": "query", "description": "Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "applicationId", "value": "marketing-automation-application", "type": "query", "description": "Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "campaignReferenceId", "value": "summersale", "type": "query", "description": "ID of a campaign that was sent in the message. May contain multiple comma-separated values." }, { "name": "useCursor", "value": "", "type": "query", "description": "Flag used to enable cursor-based pagination. When set to true, the system will use the cursor to fetch the next set of logs." }, { "name": "cursor", "value": "", "type": "query", "description": "Value which represents the current position in the data set. For the first request, this field shouldn't be defined. In subsequent requests, use the `nextCursor` value returned from the previous response to continue fetching data." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method for displaying logs for example in the user interface. Available are the logs for the last 48 hours." }, { "info": { "name": "Get email delivery reports", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/email/4/reports", "params": [ { "name": "bulkId", "value": "", "type": "query", "description": "The ID that uniquely identifies the request." }, { "name": "messageId", "value": "", "type": "query", "description": "The ID that uniquely identifies the message sent." }, { "name": "limit", "value": "1", "type": "query", "description": "Maximum number of delivery reports to be returned. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access reports for the last 48h." }, { "name": "entityId", "value": "promotional-traffic-entity", "type": "query", "description": "Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "applicationId", "value": "marketing-automation-application", "type": "query", "description": "Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "campaignReferenceId", "value": "summersale", "type": "query", "description": "ID of a campaign that was sent in the message." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get one-time delivery reports for all sent emails." }, { "info": { "name": "Get email message logs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/email/1/logs", "params": [ { "name": "messageId", "value": "", "type": "query", "description": "The ID that uniquely identifies the sent email." }, { "name": "from", "value": "", "type": "query", "description": "From email address." }, { "name": "to", "value": "", "type": "query", "description": "The recipient email address." }, { "name": "bulkId", "value": "", "type": "query", "description": "Bulk ID that uniquely identifies the request." }, { "name": "campaignReferenceId", "value": "", "type": "query", "description": "The ID that allows you to track, analyze, and show an aggregated overview and the performance of individual campaigns." }, { "name": "generalStatus", "value": "", "type": "query", "description": "Indicates whether the initiated email has been successfully sent, not sent, delivered, not delivered, waiting for delivery or any other possible status." }, { "name": "sentSince", "value": "", "type": "query", "description": "Tells when the email was initiated. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`." }, { "name": "sentUntil", "value": "", "type": "query", "description": "Tells when the email request was processed by Infobip.Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of logs." }, { "name": "applicationId", "value": "", "type": "query", "description": "[Application](https://www.infobip.com/docs/cpaas-x/application-and-entity-management#application) identifier used for filtering." }, { "name": "entityId", "value": "", "type": "query", "description": "[Entity](https://www.infobip.com/docs/cpaas-x/application-and-entity-management#entity) identifier used for filtering." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to get logs for sent emails using their messageId. Email logs are available for the last 48 hours." }, { "info": { "name": "Get email delivery reports", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/email/1/reports", "params": [ { "name": "bulkId", "value": "", "type": "query", "description": "Bulk ID for which report is requested." }, { "name": "messageId", "value": "", "type": "query", "description": "The ID that uniquely identifies the sent email." }, { "name": "campaignReferenceId", "value": "", "type": "query", "description": "The ID that allows you to track, analyze, and show an aggregated overview and the performance of individual campaigns." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of reports." }, { "name": "applicationId", "value": "", "type": "query", "description": "[Application](https://www.infobip.com/docs/cpaas-x/application-and-entity-management#application) identifier used for filtering." }, { "name": "entityId", "value": "", "type": "query", "description": "[Entity](https://www.infobip.com/docs/cpaas-x/application-and-entity-management#entity) identifier used for filtering." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get one-time delivery reports for all sent emails." }, { "info": { "name": "Validate email address", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/email/2/validation", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method lets you request validation of a single email address in real-time,\nhelping you to identify and remove poor-quality emails from your list.\n" }, { "info": { "name": "Get email validations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/email/2/validations", "params": [ { "name": "validationRequestId", "value": "2034072219640523000", "type": "query", "description": "Unique identifier for the bulk email validation request. Provide your own or leave it blank to have one generated automatically.\n" }, { "name": "destination", "value": "", "type": "query" }, { "name": "validMailbox", "value": "true", "type": "query", "description": "Indicates whether email address is valid." }, { "name": "validSyntax", "value": "true", "type": "query", "description": "Indicates whether email address syntax is valid." }, { "name": "catchAll", "value": "false", "type": "query", "description": "Indicates catch all status of email address." }, { "name": "disposable", "value": "false", "type": "query", "description": "Indicates whether email address is disposable.\nA disposable email address is a temporary address that is often used for short-term purposes and can be discarded after use.\n" }, { "name": "roleBased", "value": "false", "type": "query", "description": "Indicates whether email address is role-based.\nA role-based email address is one that is associated with a specific function or group within an organization,\nsuch as marketing@example.org, rather than an individual person.\n" }, { "name": "risk", "value": "LOW", "type": "query" }, { "name": "validatedDateFrom", "value": "2025-03-01T12:03:15.120Z", "type": "query", "description": "Start date for searching validations.\nIf not specified, defaults to 7 days before the current date.\nThe date cannot be more than 1 month in the past.\n" }, { "name": "validatedDateTo", "value": "2025-03-04T15:02:11.400Z", "type": "query", "description": "End date for searching validations." }, { "name": "cursor", "value": "A1F3B5C7D9E2F4A6B8C0D1E3F5A7B9C1D3E5F7A9B2C4D6E8F0A1B3C5D7E9F2A4", "type": "query", "description": "A pagination token for navigating through bulk email validation results.\nInitially empty, it updates with each API response to fetch the next set of results, ensuring efficient data retrieval.\n" }, { "name": "size", "value": "100", "type": "query", "description": "Number of records per page." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method lets you review and analyze the outcomes of your\nsubmitted bulk email validations to gain insights into the quality of your email list.\n" }, { "info": { "name": "Validate email addresses", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/email/2/validations", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method lets you request a bulk email address validation,\nhelping you to detect low-quality emails and tidy up your recipient list.\n" }, { "info": { "name": "Get domains", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/email/1/domains", "params": [ { "name": "size", "value": "", "type": "query", "description": "Maximum number of domains to be viewed per page. Default value is 10 with a maximum of 20 records per page." }, { "name": "page", "value": "", "type": "query", "description": "Page number you want to see. Default is 0." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This API is to get all domain associated with the account. It also provides details of the retrieved domain like the DNS records, Tracking details, Active/Blocked status,etc." }, { "info": { "name": "Add domain", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/email/1/domains", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to add new domains with a limit to create a maximum of 1000 domains in a day." }, { "info": { "name": "Get domain details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/email/1/domains/:domainName", "params": [ { "name": "domainName", "value": "", "type": "path", "description": "Domain for which the details need to be viewed." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This API provides with the details of the domain like the DNS records, Tracking details, Active/Blocked status,etc." }, { "info": { "name": "Delete domain", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/email/1/domains/:domainName", "params": [ { "name": "domainName", "value": "", "type": "path", "description": "Domain name which needs to be deleted." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to delete an existing domain." }, { "info": { "name": "Update domain tracking events", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/email/1/domains/:domainName/tracking", "params": [ { "name": "domainName", "value": "", "type": "path", "description": "Domain for which the tracking events need to be updated." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "API to update tracking events for the provided domain. Tracking events can be updated only for CLICKS, OPENS and UNSUBSCRIBES." }, { "info": { "name": "Verify domain", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/email/1/domains/:domainName/verify", "params": [ { "name": "domainName", "value": "", "type": "path", "description": "Name of the domain that has to be verified." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "API request to verify records(TXT, MX, DKIM) associated with the provided domain." }, { "info": { "name": "Get suppressions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/email/1/suppressions", "params": [ { "name": "domainName", "value": "", "type": "query", "description": "Name of the requested domain." }, { "name": "type", "value": "", "type": "query", "description": "Type of suppression." }, { "name": "emailAddress", "value": "", "type": "query", "description": "Email address that is suppressed." }, { "name": "recipientDomain", "value": "", "type": "query", "description": "Recipient domain that is suppressed." }, { "name": "createdDateFrom", "value": "", "type": "query", "description": "Start date for searching suppressions." }, { "name": "createdDateTo", "value": "", "type": "query", "description": "End date for searching suppressions." }, { "name": "page", "value": "", "type": "query", "description": "Requested page number." }, { "name": "size", "value": "", "type": "query", "description": "Requested page size." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method retrieves the suppressions for domains that are owned or have permissions granted." }, { "info": { "name": "Add suppressions", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/email/1/suppressions", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to add email addresses to the suppression list. It accepts suppression requests, saves them asynchronously, and automatically ignores any duplicate entries." }, { "info": { "name": "Delete suppressions", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/email/1/suppressions", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to delete email addresses from the suppression list. It accepts delete suppression requests and asynchronously deletes them." }, { "info": { "name": "Get suppression domains", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/email/1/suppressions/domains", "params": [ { "name": "page", "value": "", "type": "query", "description": "Requested page number." }, { "name": "size", "value": "", "type": "query", "description": "Requested page size." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to get domains that can be managed for suppressions and are either owned or have granted permissions." }, { "info": { "name": "Get IPs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/email/1/ip-management/ips", "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Returns all the dedicated IP addresses owned by this account." }, { "info": { "name": "Commission IP", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/email/1/ip-management/ips/commission", "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Commission a new Dedicated IP.\nDisaster Recovery is enabled by default for email traffic in the US and EU regions.Each dedicated IP is paired with a corresponding IP from a different data center within the same region. This pairing ensures that if one data center becomes unavailable, the paired IP can seamlessly take over full sending responsibilities, maintaining uninterrupted traffic flow.\nStandard pricing for dedicated IPs applies. Charges are incurred at the time of commissioning and recur m" }, { "info": { "name": "Get IP", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/email/1/ip-management/ips/:ipId", "params": [ { "name": "ipId", "value": "", "type": "path", "description": "Dedicated IP identifier." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get detailed information about provided dedicated IP." }, { "info": { "name": "Decommission IP", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/email/1/ip-management/ips/:ipId", "params": [ { "name": "ipId", "value": "", "type": "path", "description": "Dedicated IP identifier." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Decommission a Dedicated IP\nOnce a dedicated IP is decommissioned, billing for that IP will end at the start of the next billing cycle (on the 1st of the following month). For accounts with Disaster Recovery enabled in the US and EU regions, paired dedicated IPs will be decommissioned together.\n" }, { "info": { "name": "Get IP pools", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/email/1/ip-management/pools", "params": [ { "name": "name", "value": "", "type": "query", "description": "IP pool name." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Returns all the pools that are owned (created) by this account." }, { "info": { "name": "Create IP pool", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/email/1/ip-management/pools", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create a new IP pool." }, { "info": { "name": "Get IP pool", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/email/1/ip-management/pools/:poolId", "params": [ { "name": "poolId", "value": "", "type": "path", "description": "IP pool identifier." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get detailed information about a provided IP pool." }, { "info": { "name": "Update IP pool", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/email/1/ip-management/pools/:poolId", "params": [ { "name": "poolId", "value": "", "type": "path", "description": "IP pool identifier." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update a provided IP pool." }, { "info": { "name": "Delete IP pool", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/email/1/ip-management/pools/:poolId", "params": [ { "name": "poolId", "value": "", "type": "path", "description": "IP pool identifier." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete provided IP pool. Deleting an IP pool also deletes any assigned IPs and any assignments to domains." }, { "info": { "name": "Assign IP to pool", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/email/1/ip-management/pools/:poolId/ips", "params": [ { "name": "poolId", "value": "", "type": "path", "description": "IP pool identifier." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Assign provided dedicated IP to the provided IP pool." }, { "info": { "name": "Unassign IP from pool", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/email/1/ip-management/pools/:poolId/ips/:ipId", "params": [ { "name": "poolId", "value": "", "type": "path", "description": "IP pool identifier." }, { "name": "ipId", "value": "", "type": "path", "description": "Dedicated IP identifier." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Unassign provided IP from the specific pool." }, { "info": { "name": "Get IPs (paginated)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/email/1/ip-management/paginated/ips", "params": [ { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Returns paginated dedicated IP addresses owned by this account." }, { "info": { "name": "Get IP pools (paginated)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/email/1/ip-management/paginated/pools", "params": [ { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Returns paginated IP pools owned by this account." }, { "info": { "name": "Get domain", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/email/1/ip-management/domains/:domainId", "params": [ { "name": "domainId", "value": "", "type": "path", "description": "Domain identifier." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get detailed information for provided domain such as assigned pools and their IPs." }, { "info": { "name": "Assign IP pool to domain", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/email/1/ip-management/domains/:domainId/pools", "params": [ { "name": "domainId", "value": "", "type": "path", "description": "Domain identifier." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Assign an IP pool to the provided domain." }, { "info": { "name": "Update IP pool sending priority", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/email/1/ip-management/domains/:domainId/pools/:poolId", "params": [ { "name": "domainId", "value": "", "type": "path", "description": "Domain identifier." }, { "name": "poolId", "value": "", "type": "path", "description": "IP pool identifier." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update specified pool's sending priority for the provided domain." }, { "info": { "name": "Unassign IP pool from domain", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/email/1/ip-management/domains/:domainId/pools/:poolId", "params": [ { "name": "domainId", "value": "", "type": "path", "description": "Domain identifier." }, { "name": "poolId", "value": "", "type": "path", "description": "IP pool identifier." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Unassign a specified pool from the provided domain." }, { "info": { "name": "Get email templates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/email/1/templates", "params": [ { "name": "page", "value": "", "type": "query", "description": "Identifies a specific page number from which to retrieve the email template details." }, { "name": "size", "value": "", "type": "query", "description": "Identifies the maximum number of email templates returned in the list." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Retrieves a list of available email templates." }, { "info": { "name": "Create email template", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/email/1/templates", "body": { "type": "multipart-form", "data": [] }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Creates a new email template with the provided details." }, { "info": { "name": "Get email template", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/email/1/templates/:templateId", "params": [ { "name": "templateId", "value": "", "type": "path", "description": "Unique identifier (ID) of the email template." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Retrieves the details of a specific email template by its identifier (ID)." }, { "info": { "name": "Update email template", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/email/1/templates/:templateId", "params": [ { "name": "templateId", "value": "", "type": "path", "description": "Unique identifier (ID) of the email template." } ], "body": { "type": "multipart-form", "data": [] }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Updates an existing email template with new data." }, { "info": { "name": "Patch email template", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/email/1/templates/:templateId", "params": [ { "name": "templateId", "value": "", "type": "path", "description": "Unique identifier (ID) of the email template." } ], "body": { "type": "multipart-form", "data": [] }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Partially updates an existing email template with the provided changes." }, { "info": { "name": "Delete email template", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/email/1/templates/:templateId", "params": [ { "name": "templateId", "value": "", "type": "path", "description": "Unique identifier (ID) of the email template." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Deletes a specific email template by its ID." }, { "info": { "name": "Generate email template preview", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/email/1/templates/:templateId/preview", "params": [ { "name": "templateId", "value": "", "type": "path", "description": "Unique identifier (ID) of the email template." } ], "body": { "type": "multipart-form", "data": [] }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Generates a rendered preview of an email template by replacing placeholders with the provided key-value data." }, { "info": { "name": "Get email template attachments", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/email/1/templates/:templateId/attachments", "params": [ { "name": "templateId", "value": "", "type": "path", "description": "Unique identifier (ID) of the email template." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Retrieves a list of attachments associated with a specific email template." }, { "info": { "name": "Upload email template attachment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/email/1/templates/:templateId/attachments", "params": [ { "name": "templateId", "value": "", "type": "path", "description": "Unique identifier (ID) of the email template." } ], "body": { "type": "multipart-form", "data": [] }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Uploads an attachment to a specific email template." }, { "info": { "name": "Delete email template attachment", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/email/1/templates/:templateId/attachments/:attachmentId", "params": [ { "name": "attachmentId", "value": "", "type": "path", "description": "Attachment ID." }, { "name": "templateId", "value": "", "type": "path", "description": "Template ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Removes a specific attachment from an email template." }, { "info": { "name": "Send WhatsApp template message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/whatsapp/1/message/template", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send a single or multiple template messages to one or more recipients. Template messages can be sent and delivered at anytime. Each template needs to be registered and pre-approved by WhatsApp.
    The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead." }, { "info": { "name": "Send WhatsApp text message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/whatsapp/1/message/text", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send a text message to a single recipient. Text messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
    The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead." }, { "info": { "name": "Send WhatsApp document message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/whatsapp/1/message/document", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send a document to a single recipient. Document messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
    The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead." }, { "info": { "name": "Send WhatsApp image message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/whatsapp/1/message/image", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send an image to a single recipient. Image messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
    The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead." }, { "info": { "name": "Send WhatsApp audio message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/whatsapp/1/message/audio", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send an audio to a single recipient. Audio messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
    The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead." }, { "info": { "name": "Send WhatsApp video message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/whatsapp/1/message/video", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send a video to a single recipient. Video messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
    The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead." }, { "info": { "name": "Send WhatsApp sticker message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/whatsapp/1/message/sticker", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send a sticker to a single recipient. Sticker messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
    The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead." }, { "info": { "name": "Send WhatsApp location message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/whatsapp/1/message/location", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send a location to a single recipient. Location messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
    The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead." }, { "info": { "name": "Send WhatsApp contact message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/whatsapp/1/message/contact", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send a contact to a single recipient. Contact messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
    The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead." }, { "info": { "name": "Send WhatsApp interactive buttons message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/whatsapp/1/message/interactive/buttons", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send an interactive buttons message to a single recipient. Interactive buttons messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
    The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead." }, { "info": { "name": "Send WhatsApp interactive list message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/whatsapp/1/message/interactive/list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send an interactive list message to a single recipient. Interactive list messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
    The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead." }, { "info": { "name": "Send WhatsApp interactive media carousel message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/whatsapp/1/message/interactive/media-carousel", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send an interactive media carousel message to a single recipient. Interactive media carousel messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
    The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead." }, { "info": { "name": "Send WhatsApp interactive location request message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/whatsapp/1/message/interactive/location-request", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send an interactive location request message to a single recipient. Interactive location request messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
    The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead." }, { "info": { "name": "Send WhatsApp interactive product message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/whatsapp/1/message/interactive/product", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send an interactive product message to a single recipient. Interactive product messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
    The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead." }, { "info": { "name": "Send WhatsApp interactive multi-product message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/whatsapp/1/message/interactive/multi-product", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send an interactive multi-product message to a single recipient. Interactive multi-product messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
    The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead." }, { "info": { "name": "Send WhatsApp interactive order-details message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/whatsapp/1/message/interactive/order-details", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send an interactive order-details message to a single recipient.
    An order-details message is a structured message containing essential information about the customer's selected products. Alternatively, a [single](#channels/whatsapp/send-whatsapp-interactive-product-message) or [multi-product](#channels/whatsapp/send-whatsapp-interactive-multi-product-message) interactive message can serve this purpose.
    Interactive order-details messages can only be successfully delivered if the recip" }, { "info": { "name": "Send WhatsApp interactive order-status message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/whatsapp/1/message/interactive/order-status", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send an interactive order-status message to a single recipient.
    An order-status message delivers real-time updates to customers about the current status of their order.
    Interactive order-status messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
    The API response will not contain the final delivery status, use [Delivery Rep" }, { "info": { "name": "Send WhatsApp interactive flow message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/whatsapp/1/message/interactive/flow", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send an interactive flow message to a single recipient. Interactive flow messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
    The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead." }, { "info": { "name": "Send WhatsApp interactive url button message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/whatsapp/1/message/interactive/url-button", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send an interactive url button message to a single recipient." }, { "info": { "name": "Send WhatsApp interactive call permission request message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/whatsapp/1/message/interactive/call-permission-request", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send an interactive call permission request message to a single recipient. Interactive call permission request messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
    The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead." }, { "info": { "name": "Send WhatsApp interactive voice button message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/whatsapp/1/message/interactive/voice-button", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send an interactive voice button message to a single recipient. Interactive voice button messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
    The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead." }, { "info": { "name": "Send WhatsApp interactive in-thread authentication request message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/whatsapp/1/message/interactive/in-thread-authentication-request", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send an interactive in-thread authentication request message to a single recipient. Interactive in-thread authentication request messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
    The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead." }, { "info": { "name": "Send WhatsApp interactive request contact info message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/whatsapp/1/message/interactive/request-contact-info", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send an interactive request contact info message to a single recipient. Interactive request contact info messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
    The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead." }, { "info": { "name": "Send WhatsApp events", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/whatsapp/1/events", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send WhatsApp events to multiple recipients." }, { "info": { "name": "Download inbound media", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/whatsapp/1/senders/:sender/media/:mediaId", "params": [ { "name": "sender", "value": "447796344125", "type": "path", "description": "Registered WhatsApp sender number. Must be in international format." }, { "name": "mediaId", "value": "20250_13_123e4567-e89b-12d3-a456-426655440000", "type": "path", "description": "ID of the media." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Download WhatsApp media sent by end-users." }, { "info": { "name": "Get media metadata", "type": "http" }, "http": { "method": "HEAD", "url": "{{baseUrl}}/whatsapp/1/senders/:sender/media/:mediaId", "params": [ { "name": "sender", "value": "447796344125", "type": "path", "description": "Registered WhatsApp sender number. Must be in international format." }, { "name": "mediaId", "value": "20250_13_123e4567-e89b-12d3-a456-426655440000", "type": "path", "description": "ID of the media." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get metadata of WhatsApp media sent by end-users to check media type and the size of a file without downloading the content." }, { "info": { "name": "Mark as read", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/whatsapp/1/senders/:sender/message/:messageId/read", "params": [ { "name": "sender", "value": "447796344125", "type": "path", "description": "Registered WhatsApp sender number. Must be in international format." }, { "name": "messageId", "value": "abcdef_ghij124567890klmnopr", "type": "path", "description": "ID of the message to be marked as read." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Mark WhatsApp messages sent by end-users as read." }, { "info": { "name": "Get India UPI PayU payment status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/whatsapp/1/senders/:sender/payments/upi/payu/:paymentId", "params": [ { "name": "sender", "value": "447796344125", "type": "path", "description": "Registered WhatsApp sender number. Must be in international format." }, { "name": "paymentId", "value": "16085194825", "type": "path", "description": "Unique identifier of the payment." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get India UPI PayU payment and transaction status." }, { "info": { "name": "Get Brazil payment status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/whatsapp/1/senders/:sender/payments/br/:paymentId", "params": [ { "name": "sender", "value": "447796344125", "type": "path", "description": "Registered WhatsApp sender number. Must be in international format." }, { "name": "paymentId", "value": "16085194825", "type": "path", "description": "Unique identifier of the payment." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get Brazil payment and transaction status." }, { "info": { "name": "Get India UPI PayU/Razorpay payment status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/whatsapp/1/senders/:sender/payments/upi/:paymentId", "params": [ { "name": "sender", "value": "447796344125", "type": "path", "description": "Registered WhatsApp sender number. Must be in international format." }, { "name": "paymentId", "value": "16085194825", "type": "path", "description": "Unique identifier of the payment." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get India UPI PayU/Razor payment and transaction status." }, { "info": { "name": "Get WhatsApp Templates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/whatsapp/2/senders/:sender/templates", "params": [ { "name": "sender", "value": "447796344125", "type": "path", "description": "Registered WhatsApp sender number. Must be in international format." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get all the templates and their statuses for a given sender." }, { "info": { "name": "Create WhatsApp Template", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/whatsapp/2/senders/:sender/templates", "params": [ { "name": "sender", "value": "447796344125", "type": "path", "description": "Registered WhatsApp sender number. Must be in international format." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create a WhatsApp template. Once created, Infobip submits a template for WhatsApp's review and approval. When approved, a template can be sent to end users. Refer to [template guidelines](https://www.infobip.com/docs/whatsapp/remaining-compliant#message-templates) for additional info." }, { "info": { "name": "Delete WhatsApp Template", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/whatsapp/2/senders/:sender/templates/:templateName", "params": [ { "name": "sender", "value": "447796344125", "type": "path", "description": "Registered WhatsApp sender number. Must be in international format." }, { "name": "templateName", "value": "template_name", "type": "path", "description": "Template name. Must only contain lowercase alphanumeric characters and underscores." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete a WhatsApp template.\n* If registered in multiple languages, deleting the message template will also delete all its languages.\n* The template will be deleted for all senders registered under the same WhatsApp Business Account (WABA).\n* The system will attempt to deliver sent messages for 30 days, regardless of the template deletion.\n* Once deleted, the name of the approved template cannot be reused for 30 days." }, { "info": { "name": "Get WhatsApp Template", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/whatsapp/2/senders/:sender/templates/:id", "params": [ { "name": "sender", "value": "447796344125", "type": "path", "description": "Registered WhatsApp sender number. Must be in international format." }, { "name": "id", "value": "5653923468715475", "type": "path", "description": "Template ID. Must be a number." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get a single template with its status for a given template ID." }, { "info": { "name": "Edit WhatsApp Template", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/whatsapp/2/senders/:sender/templates/:id", "params": [ { "name": "sender", "value": "447796344125", "type": "path", "description": "Registered WhatsApp sender number. Must be in international format." }, { "name": "id", "value": "5653923468715475", "type": "path", "description": "Template ID. Must be a number." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Edit a WhatsApp template. Once edited, Infobip submits a template for WhatsApp's review and approval. When approved, a template can be sent to end users. Refer to [template guidelines](https://www.infobip.com/docs/whatsapp/remaining-compliant#message-templates) for additional info.\n* Only templates with an approved, rejected, or paused status can be edited.\n* Use the structure provided in the [Create WhatsApp Template](#channels/whatsapp/whatsapp-service-management/create-whatsapp-template) endp" }, { "info": { "name": "Get WhatsApp Templates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/whatsapp/1/senders/:sender/templates", "params": [ { "name": "sender", "value": "447796344125", "type": "path", "description": "Registered WhatsApp sender number. Must be in international format." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get all the templates and their statuses for a given sender. This version is deprecated as of June 29th 2022, meaning no fixes/updates will be provided and no new parameters will be added. This API will be deleted at the end of the year. Please use the [latest version](#channels/whatsapp/get-whatsapp-templates)." }, { "info": { "name": "Create WhatsApp Template", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/whatsapp/1/senders/:sender/templates", "params": [ { "name": "sender", "value": "447796344125", "type": "path", "description": "Registered WhatsApp sender number. Must be in international format." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create a WhatsApp template. Created template will be submitted for WhatsApp's review and approval. Once approved, template can be sent to end-users. Refer to [template guidelines](https://www.infobip.com/docs/whatsapp/message-types#guidelines-amp-best-practices) for additional info. This version is deprecated as of June 29th 2022, meaning no fixes/updates will be provided and no new parameters will be added. This API will be deleted at the end of the year. Please use the [latest version](#channe" }, { "info": { "name": "Get account WhatsApp templates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/whatsapp/1/templates", "params": [ { "name": "sender", "value": "447796344125", "type": "query", "description": "List of registered WhatsApp senders numbers separated by comma. Must be in international format." }, { "name": "status", "value": "", "type": "query", "description": "List of template statuses, separated by commas." }, { "name": "name", "value": "", "type": "query", "description": "Template name." }, { "name": "language", "value": "en,en_US", "type": "query", "description": "List of languages for the templates, separated by commas." }, { "name": "category", "value": "", "type": "query", "description": "List of template categories, separated by commas." }, { "name": "applicationId", "value": "", "type": "query", "description": "Application ID used in outbound send requests. It is also returned in notification events. For more details, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "entityId", "value": "", "type": "query", "description": "Entity ID used in outbound send requests. It is also returned in notification events. For more details, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "page", "value": "", "type": "query", "description": "Current page number." }, { "name": "size", "value": "", "type": "query", "description": "Number of items per page." }, { "name": "orderBy", "value": "name,ASC", "type": "query", "description": "Sorting criteria in the format property,direction. Can be ascending (ASC) or descending (DESC). Available properties: category, language, name, status, templateId" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Retrieve all templates associated with your account based on the provided filter criteria." }, { "info": { "name": "Get WhatsApp Flows", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/whatsapp/1/senders/:sender/flows", "params": [ { "name": "sender", "value": "447796344125", "type": "path", "description": "Registered WhatsApp sender number. Must be in international format." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get all the flows for a given sender." }, { "info": { "name": "Create WhatsApp Flow", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/whatsapp/1/senders/:sender/flows", "params": [ { "name": "sender", "value": "447796344125", "type": "path", "description": "Registered WhatsApp sender number. Must be in international format." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create a WhatsApp flow. If successful, flow will be created in DRAFT status with default flow.json. Flow.json contains structure of the flow and other fields given in request can be updated until publication." }, { "info": { "name": "Update WhatsApp Flow", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/whatsapp/1/senders/:sender/flows/:flowId", "params": [ { "name": "sender", "value": "447796344125", "type": "path", "description": "Registered WhatsApp sender number. Must be in international format." }, { "name": "flowId", "value": "123456", "type": "path", "description": "ID of the flow to be modified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update a WhatsApp flow. Only flows in DRAFT status can be modified." }, { "info": { "name": "Delete WhatsApp Flow", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/whatsapp/1/senders/:sender/flows/:flowId", "params": [ { "name": "sender", "value": "447796344125", "type": "path", "description": "Registered WhatsApp sender number. Must be in international format." }, { "name": "flowId", "value": "123456", "type": "path", "description": "ID of the flow to be deleted." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete a WhatsApp flow. Only flows in DRAFT status can be deleted." }, { "info": { "name": "Publish WhatsApp Flow", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/whatsapp/1/senders/:sender/flows/:flowId/publish", "params": [ { "name": "sender", "value": "447796344125", "type": "path", "description": "Registered WhatsApp sender number. Must be in international format." }, { "name": "flowId", "value": "123456", "type": "path", "description": "ID of the flow to be published." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Publish a WhatsApp flow. If successful, the flow will change its status to PUBLISHED. From now on the flow cannot be modified." }, { "info": { "name": "Get WhatsApp Flow JSON", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/whatsapp/1/senders/:sender/flows/:flowId/json", "params": [ { "name": "sender", "value": "447796344125", "type": "path", "description": "Registered WhatsApp sender number. Must be in international format." }, { "name": "flowId", "value": "123456", "type": "path", "description": "ID of the flow the JSON is attached to." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get the Flow JSON attached to a specified flow." }, { "info": { "name": "Add WhatsApp Flow JSON", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/whatsapp/1/senders/:sender/flows/:flowId/json", "params": [ { "name": "sender", "value": "447796344125", "type": "path", "description": "Registered WhatsApp sender number. Must be in international format." }, { "name": "flowId", "value": "123456", "type": "path", "description": "ID of the flow to attach JSON to." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Add WhatsApp Flow JSON. File created from provided JSON content is sent and validated, errors found are provided in response. Regardless of whether any validation errors are returned, the Flow JSON is loaded on the Meta side and the request is considered successful. The maximum size of created file is 10MB. More information about JSON structure can be found under Meta documentation: https://developers.facebook.com/docs/whatsapp/flows/reference/flowjson." }, { "info": { "name": "Deprecate WhatsApp Flow", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/whatsapp/1/senders/:sender/flows/:flowId/deprecate", "params": [ { "name": "sender", "value": "447796344125", "type": "path", "description": "Registered WhatsApp sender number. Must be in international format." }, { "name": "flowId", "value": "123456", "type": "path", "description": "ID of the flow to be deprecated." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Deprecate a WhatsApp flow. If successful, flow will change its status to DEPRECATED. From now on flow cannot be sent anymore." }, { "info": { "name": "Get WhatsApp Flow's preview", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/whatsapp/1/senders/:sender/flows/:flowId/preview", "params": [ { "name": "sender", "value": "447796344125", "type": "path", "description": "Registered WhatsApp sender number. Must be in international format." }, { "name": "flowId", "value": "123456", "type": "path", "description": "ID of the flow for which the preview URL will be generated." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get flow's preview URL. Link does not require login and will expire in 30 days." }, { "info": { "name": "Generate WhatsApp Flow", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/whatsapp/1/senders/:sender/flows/generate", "params": [ { "name": "sender", "value": "447796344125", "type": "path", "description": "Registered WhatsApp sender number. Must be in international format." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this endpoint to automatically generate a WhatsApp Flow definition using AI, based on a natural language prompt. Provide a descriptive prompt (e.g., \"Create a Static WhatsApp Flow to collect details like Name, Surname and email for our global event next week.\"). The AI will generate a flow configuration designed to match your intent. If you include a responseId from an earlier request, the prompt will be used to modify or refine the flow that was previously generated, so you can adjust and " }, { "info": { "name": "Delete media", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/whatsapp/1/senders/:sender/media", "params": [ { "name": "sender", "value": "447796344125", "type": "path", "description": "Registered WhatsApp sender number. Must be in international format." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete WhatsApp media. May be outbound or inbound media." }, { "info": { "name": "Get quality information of WhatsApp senders", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/whatsapp/1/senders/quality", "params": [ { "name": "senders", "value": "447796344125,447796344126", "type": "query", "description": "List of comma-separated WhatsApp sender numbers." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get WhatsApp sender information, such as quality rating, status, and current limit of given senders. Only senders associated with your account are included in the response." }, { "info": { "name": "Get business info of WhatsApp sender", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/whatsapp/1/senders/:sender/business-info", "params": [ { "name": "sender", "value": "447796344125", "type": "path", "description": "Registered WhatsApp sender number. Must be in international format." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get WhatsApp sender business information, such as about, address, description, email, vertical, websites, and display name." }, { "info": { "name": "Update business info of WhatsApp sender", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/whatsapp/1/senders/:sender/business-info", "params": [ { "name": "sender", "value": "447796344125", "type": "path", "description": "Registered WhatsApp sender number. Must be in international format." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update WhatsApp sender business information, such as about, address, description, email, vertical, websites, and logo." }, { "info": { "name": "Download business logo of WhatsApp sender", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/whatsapp/1/senders/:sender/business-info/logo", "params": [ { "name": "sender", "value": "447796344125", "type": "path", "description": "Registered WhatsApp sender number. Must be in international format." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Download WhatsApp sender business logo." }, { "info": { "name": "Get calling permission", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/whatsapp/1/senders/:sender/calls/:userNumber/permissions", "params": [ { "name": "sender", "value": "447796344125", "type": "path", "description": "Registered WhatsApp sender number. Must be in international format." }, { "name": "userNumber", "value": "447796344125", "type": "path", "description": "End user phone number. Must be in international format." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get calling permission info of WhatsApp sender for specified end user number, including status, allowed actions, and limitations." }, { "info": { "name": "Get WhatsApp sender public key", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/whatsapp/1/senders/:sender/public-key", "params": [ { "name": "sender", "value": "447796344125", "type": "path", "description": "Registered WhatsApp sender number. Must be in international format." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Retrieves the public key for WhatsApp encryption. The public key enables\n end-to-end encrypted data exchange with WhatsApp, such as in WhatsApp Flows." }, { "info": { "name": "Upload WhatsApp sender public key", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/whatsapp/1/senders/:sender/public-key", "params": [ { "name": "sender", "value": "447796344125", "type": "path", "description": "Registered WhatsApp sender number. Must be in international format." } ], "body": { "type": "multipart-form", "data": [] }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Uploads a public key for WhatsApp encryption. The public key enables\n end-to-end encrypted data exchange with WhatsApp, such as in WhatsApp Flows.\n Previous keys are replaced when new ones are uploaded using this endpoint." }, { "info": { "name": "Add WhatsApp sender", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/whatsapp/1/embedded-signup/registrations/business-account/:businessAccountId/senders", "params": [ { "name": "businessAccountId", "value": "12345567897878", "type": "path", "description": "WhatsApp Business Account Id." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Add a WhatsApp sender to your WhatsApp Business Account and initiate the verification process. If the sender is recognized as already verified, it will be automatically submitted for registration." }, { "info": { "name": "Verify WhatsApp sender", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/whatsapp/1/embedded-signup/registrations/senders/:sender/verification", "params": [ { "name": "sender", "value": "447796344125", "type": "path", "description": "WhatsApp sender number. Must be in international format." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Verify your WhatsApp sender and submit it for registration." }, { "info": { "name": "Retry WhatsApp sender verification", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/whatsapp/1/embedded-signup/registrations/senders/:sender/verification", "params": [ { "name": "sender", "value": "447796344125", "type": "path", "description": "WhatsApp sender number. Must be in international format." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Retry the WhatsApp sender verification process in the event of a non-delivered verification code." }, { "info": { "name": "Get identity", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/whatsapp/1/:sender/contacts/:userNumber/identity", "params": [ { "name": "sender", "value": "447796344125", "type": "path", "description": "Registered WhatsApp sender number. Must be in international format." }, { "name": "userNumber", "value": "441134960001", "type": "path", "description": "End user's number. Must be in international format." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get end user's identity info. Feature is not enabled by default." }, { "info": { "name": "Confirm identity", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/whatsapp/1/:sender/contacts/:userNumber/identity", "params": [ { "name": "sender", "value": "447796344125", "type": "path", "description": "Registered WhatsApp sender number. Must be in international format." }, { "name": "userNumber", "value": "441134960001", "type": "path", "description": "End user's number. Must be in international format." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Confirm end user's identity. Feature is not enabled by default." }, { "info": { "name": "Delete identity", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/whatsapp/1/:sender/contacts/:userNumber/identity", "params": [ { "name": "sender", "value": "447796344125", "type": "path", "description": "Registered WhatsApp sender number. Must be in international format." }, { "name": "userNumber", "value": "441134960001", "type": "path", "description": "End user's number. Must be in international format." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete end user's identity. Feature is not enabled by default." }, { "info": { "name": "Submit conversions", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/whatsapp/1/conversions", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Submit WhatsApp conversion events. Events are indivisible, either all are submitted or none." }, { "info": { "name": "Submit WABA conversions", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/whatsapp/1/conversions/waba", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Submit WhatsApp conversion events using your WhatsApp Business Account (WABA) phone number as the source. Each conversion event is linked to an ad click via ctwaClickId — a unique identifier contained within the inbound WhatsApp message originating from the ad. You can optionally include conversion details such as value and currency, and a conversion timestamp (up to 7 days in the past). Events are submitted in batches of up to 1,000 and are indivisible — either all are submitted or none." }, { "info": { "name": "Send Viber messages", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/viber/2/messages", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send text, image, video or file messages to a multiple recipients." }, { "info": { "name": "Send Viber text message(s)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/viber/1/message/text", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send one or many text message(s) possibly to multiple recipients." }, { "info": { "name": "Send Viber image message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/viber/1/message/image", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send an image message to a single recipient." }, { "info": { "name": "Send Viber file message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/viber/1/message/file", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send a file message to a single recipient." }, { "info": { "name": "Send Viber video message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/viber/1/message/video", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send a video message to a single recipient." }, { "info": { "name": "Get Viber delivery reports", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/viber/2/reports", "params": [ { "name": "bulkId", "value": "", "type": "query", "description": "The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address." }, { "name": "messageId", "value": "", "type": "query", "description": "The ID that uniquely identifies the message sent." }, { "name": "limit", "value": "1", "type": "query", "description": "Maximum number of delivery reports to be returned. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access reports for the last 48h." }, { "name": "entityId", "value": "promotional-traffic-entity", "type": "query", "description": "Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "applicationId", "value": "marketing-automation-application", "type": "query", "description": "Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "campaignReferenceId", "value": "summersale", "type": "query", "description": "ID of a campaign that was sent in the message." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "If you are unable to receive real-time delivery reports towards your endpoint for various reasons, we offer you an API method to fetch batches of delivery reports to confirm whether specific messages have been delivered. Each request towards this endpoint will return batches of the latest delivery reports. Please note they will be returned only once." }, { "info": { "name": "Get Viber message logs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/viber/2/logs", "params": [ { "name": "sender", "value": "", "type": "query", "description": "The sender ID which can be alphanumeric or numeric." }, { "name": "destination", "value": "", "type": "query", "description": "Message destination address." }, { "name": "bulkId", "value": "BULK-ID-123-xyz", "type": "query", "description": "Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. May contain multiple comma-separated values. Maximum length 2048 characters." }, { "name": "messageId", "value": "MESSAGE-ID-123-xyz,MESSAGE-ID-124-xyz", "type": "query", "description": "Unique message ID for which a log is requested. May contain multiple comma-separated values. Maximum length 2048 characters." }, { "name": "generalStatus", "value": "", "type": "query" }, { "name": "sentSince", "value": "2020-02-22T17:42:05.390+01:00", "type": "query", "description": "The logs will only include messages sent after this date. Use it alongside sentUntil to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ." }, { "name": "sentUntil", "value": "2020-02-23T17:42:05.390+01:00", "type": "query", "description": "The logs will only include messages sent before this date. Use it alongside sentSince to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of messages to include in logs. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access logs for the last 48h." }, { "name": "entityId", "value": "promotional-traffic-entity", "type": "query", "description": "Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "applicationId", "value": "marketing-automation-application", "type": "query", "description": "Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "campaignReferenceId", "value": "summersale", "type": "query", "description": "ID of a campaign that was sent in the message. May contain multiple comma-separated values." }, { "name": "useCursor", "value": "", "type": "query", "description": "Flag used to enable cursor-based pagination. When set to true, the system will use the cursor to fetch the next set of logs." }, { "name": "cursor", "value": "", "type": "query", "description": "Value which represents the current position in the data set. For the first request, this field shouldn't be defined. In subsequent requests, use the `nextCursor` value returned from the previous response to continue fetching data." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method for displaying logs for example in the user interface. Available are the logs for the last 48 hours." }, { "info": { "name": "Get Viber templates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/viber/1/senders/:sender/templates", "params": [ { "name": "sender", "value": "", "type": "path", "description": "Sender id." }, { "name": "page", "value": "", "type": "query", "description": "Current page number." }, { "name": "size", "value": "", "type": "query", "description": "Number of items per page." }, { "name": "orderBy", "value": "name,ASC", "type": "query", "description": "Sorting criteria in the format `property,direction`. Can be ascending (ASC) or descending (DESC). Available properties: id, sender, channel, templateId, name, createdAt." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Retrieve Viber templates available for specific sender." }, { "info": { "name": "Create Viber template", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/viber/1/senders/:sender/templates", "params": [ { "name": "sender", "value": "", "type": "path", "description": "Sender id." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create a new Viber template for a given sender. Templates must be approved by Viber before they can be used for sending messages." }, { "info": { "name": "Get Viber template", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/viber/1/senders/:sender/templates/:templateId", "params": [ { "name": "sender", "value": "", "type": "path", "description": "Sender id." }, { "name": "templateId", "value": "", "type": "path", "description": "Id of existing template." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Retrieve details of a specific Viber template by its ID and associated sender." }, { "info": { "name": "Delete Viber template", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/viber/1/senders/:sender/templates/:templateId", "params": [ { "name": "sender", "value": "", "type": "path", "description": "Sender id." }, { "name": "templateId", "value": "", "type": "path", "description": "Id of existing template." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete a specific Viber template. Deleted templates can no longer be used for sending messages." }, { "info": { "name": "Send a Viber Bot message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/viber-bot/1/messages", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send one or more messages to multiple recipients." }, { "info": { "name": "Get outbound Viber bot message logs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/viber-bot/1/logs", "params": [ { "name": "sender", "value": "", "type": "query", "description": "The sender ID which can be alphanumeric or numeric." }, { "name": "destination", "value": "", "type": "query", "description": "Message destination address." }, { "name": "bulkId", "value": "BULK-ID-123-xyz", "type": "query", "description": "Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. May contain multiple comma-separated values. Maximum length 2048 characters." }, { "name": "messageId", "value": "MESSAGE-ID-123-xyz,MESSAGE-ID-124-xyz", "type": "query", "description": "Unique message ID for which a log is requested. May contain multiple comma-separated values. Maximum length 2048 characters." }, { "name": "generalStatus", "value": "", "type": "query" }, { "name": "sentSince", "value": "2020-02-22T17:42:05.390+01:00", "type": "query", "description": "The logs will only include messages sent after this date. Use it alongside sentUntil to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ." }, { "name": "sentUntil", "value": "2020-02-23T17:42:05.390+01:00", "type": "query", "description": "The logs will only include messages sent before this date. Use it alongside sentSince to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of messages to include in logs. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access logs for the last 48h." }, { "name": "entityId", "value": "promotional-traffic-entity", "type": "query", "description": "Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "applicationId", "value": "marketing-automation-application", "type": "query", "description": "Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "campaignReferenceId", "value": "summersale", "type": "query", "description": "ID of a campaign that was sent in the message. May contain multiple comma-separated values." }, { "name": "useCursor", "value": "", "type": "query", "description": "Flag used to enable cursor-based pagination. When set to true, the system will use the cursor to fetch the next set of logs." }, { "name": "cursor", "value": "", "type": "query", "description": "Value which represents the current position in the data set. For the first request, this field shouldn't be defined. In subsequent requests, use the `nextCursor` value returned from the previous response to continue fetching data." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method for displaying logs for example in the user interface. Available are the logs for the last 48 hours." }, { "info": { "name": "Get Viber Bot delivery reports", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/viber-bot/1/reports", "params": [ { "name": "bulkId", "value": "", "type": "query", "description": "The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address." }, { "name": "messageId", "value": "", "type": "query", "description": "The ID that uniquely identifies the message sent." }, { "name": "limit", "value": "1", "type": "query", "description": "Maximum number of delivery reports to be returned. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access reports for the last 48h." }, { "name": "entityId", "value": "promotional-traffic-entity", "type": "query", "description": "Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "applicationId", "value": "marketing-automation-application", "type": "query", "description": "Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "campaignReferenceId", "value": "summersale", "type": "query", "description": "ID of a campaign that was sent in the message." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "If you are unable to receive real-time delivery reports towards your endpoint for various reasons, we offer you an API method to fetch batches of delivery reports to confirm whether specific messages have been delivered. Each request towards this endpoint will return batches of the latest delivery reports. Please note they will be returned only once." }, { "info": { "name": "Send a LINE message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/line/1/messages", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send one or more [LINE Official Notifications](https://www.infobip.com/docs/line/message-types#line-official-notifications-lon) messages to multiple recipients." }, { "info": { "name": "Get LON delivery reports", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/line/1/reports", "params": [ { "name": "bulkId", "value": "", "type": "query", "description": "The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address." }, { "name": "messageId", "value": "", "type": "query", "description": "The ID that uniquely identifies the message sent." }, { "name": "limit", "value": "1", "type": "query", "description": "Maximum number of delivery reports to be returned. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access reports for the last 48h." }, { "name": "entityId", "value": "promotional-traffic-entity", "type": "query", "description": "Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "applicationId", "value": "marketing-automation-application", "type": "query", "description": "Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "campaignReferenceId", "value": "summersale", "type": "query", "description": "ID of a campaign that was sent in the message." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "If you are unable to receive real-time delivery reports towards your endpoint for various reasons, we offer you an API method to fetch batches of delivery reports to confirm whether specific messages have been delivered. Each request towards this endpoint will return batches of the latest delivery reports. Please note they will be returned only once." }, { "info": { "name": "Send Zalo messages", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/zalo/2/messages", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send messages to multiple recipients. Only [template messages](https://www.infobip.com/docs/zalo/message-types) registered with Zalo can be sent. The API response will not contain the final delivery status, use [Delivery Reports](/docs/api/channels/zalo/zalo-logs-and-status-reports/receive-outbound-zalo-delivery-reports) instead." }, { "info": { "name": "Get Zalo logs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/zalo/1/logs", "params": [ { "name": "from", "value": "", "type": "query", "description": "Message sender." }, { "name": "to", "value": "", "type": "query", "description": "Message destination." }, { "name": "messageId", "value": "", "type": "query", "description": "List of message IDs (separated by comma) for which logs are requested." }, { "name": "generalStatus", "value": "", "type": "query", "description": "Sent Message status." }, { "name": "sentSince", "value": "", "type": "query", "description": "Lower limit on date and time of sending message. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`." }, { "name": "sentUntil", "value": "", "type": "query", "description": "Upper limit on date and time of sending message. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`." }, { "name": "limit", "value": "", "type": "query", "description": "Maximal number of messages in returned logs. If you want to fetch more than 1000 logs you can retrieve them in pages using `sentSince` and `sentUntil` parameters." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "You should use this method for displaying logs in the user interface or for some other less frequent usage." }, { "info": { "name": "Get Zalo templates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/zalo/1/sender/:sender/templates", "params": [ { "name": "sender", "value": "", "type": "path", "description": "Sender ID." }, { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." }, { "name": "status", "value": "", "type": "query", "description": "Filter templates by status. Use ALL to return all templates regardless of status. Defaults to ENABLE." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Returns all templates for a given sender filtered by status." }, { "info": { "name": "Get Zalo template", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/zalo/1/sender/:sender/templates/:templateName", "params": [ { "name": "sender", "value": "", "type": "path", "description": "Sender ID." }, { "name": "templateName", "value": "", "type": "path", "description": "Name identifying the template. Must be the same as registered template_id." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Returns template's info for given template name." }, { "info": { "name": "Create Zalo template", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/zalo/2/sender/:sender/templates", "params": [ { "name": "sender", "value": "", "type": "path", "description": "Sender ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Creates a new template for the given sender. The template will be submitted for review and must be approved before it can be used." }, { "info": { "name": "Edit Zalo template", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/zalo/2/sender/:sender/templates", "params": [ { "name": "sender", "value": "", "type": "path", "description": "Sender ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Edits an existing template that has REJECTED status. The template will be resubmitted for review." }, { "info": { "name": "Upload Zalo media", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/zalo/1/sender/:sender/media", "params": [ { "name": "sender", "value": "", "type": "path", "description": "Sender ID." } ], "body": { "type": "multipart-form", "data": [ { "name": "file", "type": "text", "value": "" } ] }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Uploads an image file to Zalo and returns the media ID that can be referenced in template content." }, { "info": { "name": "Get Zalo quota", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/zalo/1/sender/:sender/quota", "params": [ { "name": "sender", "value": "", "type": "path", "description": "Sender ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Returns the quota (number) of Zalo notifications sent per day." }, { "info": { "name": "Get Zalo sender public key", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/zalo/1/sender/:sender/public-key", "params": [ { "name": "sender", "value": "", "type": "path", "description": "Sender ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Returns previously generated public RSA key. In case you haven't already generated an RSA key, you need to do that using the \"Create Zalo sender public key\" method. To use the public RSA key, please *Base64 decode* the provided value!" }, { "info": { "name": "Create Zalo sender public key", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/zalo/1/sender/:sender/public-key", "params": [ { "name": "sender", "value": "", "type": "path", "description": "Sender ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "The RSA key generation API allows you to generate a key pair consisting of a public key and a private key.
    Only the public key will be returned by this method. The private key will be stored by Zalo to decrypt the content.
    In case you've already generated an RSA key, please use the public key get API to get the public key.
    To use the public RSA key, please *Base64 decode* the provided value!" }, { "info": { "name": "Send single Push notification", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/push/2/message/single", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to send a single Push notification to one or multiple recipients." }, { "info": { "name": "Send multiple Push notifications", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/push/2/message/multi", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method when sending a large amount of messages or targeting different user segments with different messages to optimize data traffic and increase performance." }, { "info": { "name": "Send Push notifications", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/push/3/messages", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to send Push notifications to a recipient or multiple recipients in one request." }, { "info": { "name": "Get push applications", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/push/1/applications", "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "The following method allows you to fetch all application profiles configured on a single account." }, { "info": { "name": "Get push Application by applicationCode", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/push/1/applications/:applicationCode", "params": [ { "name": "applicationCode", "value": "", "type": "path", "description": "Application code." }, { "name": "useAppCodeAsAppId", "value": "", "type": "query", "description": "Set to true to treat application code as application ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "The following method allows you to fetch information about a specific application profile." }, { "info": { "name": "Get Push statistics", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/push/1/statistics", "params": [ { "name": "bulkId", "value": "", "type": "query", "description": "Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "The following method allows you to retrieve statistics for a specific bulk of sent Push messages." }, { "info": { "name": "Get Push reports", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/push/1/reports", "params": [ { "name": "bulkId", "value": "23568941", "type": "query", "description": "Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request." }, { "name": "messageId", "value": "ff4804ef-6ab6-4abd-984d-ab3b1387e852", "type": "query", "description": "The ID of the individual message for which the report is requested." }, { "name": "limit", "value": "1", "type": "query", "description": "Maximum number of reports." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to get one-time delivery reports for sent Push messages. You can only fetch reports that are no older than 48 hours." }, { "info": { "name": "Receive MO Push messages", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/push/1/inbox/reports", "params": [ { "name": "limit", "value": "2", "type": "query", "description": "Maximum number of received messages to return." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get MO (Mobile Originated) Push messages that have been received by the Infobip platform from your subscribers' devices. These are incoming messages sent from devices to your application, not messages sent from the platform to devices. Each request will return a batch of received messages - only once. The following request will return the next batch of messages." }, { "info": { "name": "Get Push delivery reports", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/push/3/reports", "params": [ { "name": "bulkId", "value": "", "type": "query", "description": "The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address." }, { "name": "messageId", "value": "", "type": "query", "description": "The ID that uniquely identifies the message sent." }, { "name": "limit", "value": "1", "type": "query", "description": "Maximum number of delivery reports to be returned. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access reports for the last 48h" }, { "name": "entityId", "value": "promotional-traffic-entity", "type": "query", "description": "Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "applicationId", "value": "marketing-automation-application", "type": "query", "description": "Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "campaignReferenceId", "value": "summersale", "type": "query", "description": "ID of a campaign that was sent in the message." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "If you are unable to receive real-time delivery reports towards your endpoint for various reasons, we offer you an API method to fetch batches of delivery reports to confirm whether specific messages have been delivered. Each request towards this endpoint will return batches of the latest delivery reports. Please note they will be returned only once." }, { "info": { "name": "Get Push message logs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/push/3/logs", "params": [ { "name": "sender", "value": "", "type": "query", "description": "The sender ID which can be alphanumeric or numeric." }, { "name": "destination", "value": "", "type": "query", "description": "Message destination address." }, { "name": "bulkId", "value": "BULK-ID-123-xyz", "type": "query", "description": "Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. May contain multiple comma-separated values. Maximum length 2048 characters." }, { "name": "messageId", "value": "MESSAGE-ID-123-xyz,MESSAGE-ID-124-xyz", "type": "query", "description": "Unique message ID for which a log is requested. May contain multiple comma-separated values. Maximum length 2048 characters." }, { "name": "generalStatus", "value": "", "type": "query" }, { "name": "sentSince", "value": "2020-02-22T17:42:05.390+01:00", "type": "query", "description": "The logs will only include messages sent after this date. Use it alongside sentUntil to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ." }, { "name": "sentUntil", "value": "2020-02-23T17:42:05.390+01:00", "type": "query", "description": "The logs will only include messages sent before this date. Use it alongside sentSince to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of messages to include in logs. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access logs for the last 48h." }, { "name": "entityId", "value": "promotional-traffic-entity", "type": "query", "description": "Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "applicationId", "value": "marketing-automation-application", "type": "query", "description": "Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "campaignReferenceId", "value": "summersale", "type": "query", "description": "ID of a campaign that was sent in the message. May contain multiple comma-separated values." }, { "name": "useCursor", "value": "", "type": "query", "description": "Flag used to enable cursor-based pagination. When set to true, the system will use the cursor to fetch the next set of logs." }, { "name": "cursor", "value": "", "type": "query", "description": "Value which represents the current position in the data set. For the first request, this field shouldn't be defined. In subsequent requests, use the `nextCursor` value returned from the previous response to continue fetching data." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method for displaying logs for example in the user interface. Available are the logs for the last 48 hours." }, { "info": { "name": "List all configurations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/push/1/applications/:applicationCode/configurations", "params": [ { "name": "applicationCode", "value": "my_app_code", "type": "path", "description": "Application code identifying the application." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "List all MO (Mobile Originated) message configurations for an application." }, { "info": { "name": "Create a new configuration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/push/1/applications/:applicationCode/configurations", "params": [ { "name": "applicationCode", "value": "my_app_code", "type": "path", "description": "Application code identifying the application." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create a new MO (Mobile Originated) message configuration for an application." }, { "info": { "name": "Get a single configuration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/push/1/applications/:applicationCode/configurations/:configurationKey", "params": [ { "name": "applicationCode", "value": "my_app_code", "type": "path", "description": "Application code identifying the application." }, { "name": "configurationKey", "value": "config_key", "type": "path", "description": "Configuration key identifying the configuration." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get a single MO (Mobile Originated) message configuration by key." }, { "info": { "name": "Delete the configuration", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/push/1/applications/:applicationCode/configurations/:configurationKey", "params": [ { "name": "applicationCode", "value": "my_app_code", "type": "path", "description": "Application code identifying the application." }, { "name": "configurationKey", "value": "config_key", "type": "path", "description": "Configuration key identifying the configuration." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete an MO (Mobile Originated) message configuration by key." }, { "info": { "name": "List all actions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/push/1/applications/:applicationCode/configurations/:configurationKey/actions", "params": [ { "name": "applicationCode", "value": "my_app_code", "type": "path", "description": "Application code identifying the application." }, { "name": "configurationKey", "value": "config_key", "type": "path", "description": "Configuration key identifying the configuration." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "List all actions for an MO (Mobile Originated) message configuration." }, { "info": { "name": "Create new action", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/push/1/applications/:applicationCode/configurations/:configurationKey/actions", "params": [ { "name": "applicationCode", "value": "my_app_code", "type": "path", "description": "Application code identifying the application." }, { "name": "configurationKey", "value": "config_key", "type": "path", "description": "Configuration key identifying the configuration." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create a new action for an MO (Mobile Originated) message configuration. Supported action types are HTTP_FORWARD and PULL." }, { "info": { "name": "Delete action", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/push/1/applications/:applicationCode/configurations/:configurationKey/actions/:actionKey", "params": [ { "name": "applicationCode", "value": "my_app_code", "type": "path", "description": "Application code identifying the application." }, { "name": "configurationKey", "value": "config_key", "type": "path", "description": "Configuration key identifying the configuration." }, { "name": "actionKey", "value": "action_key", "type": "path", "description": "Action key identifying the action to delete." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete an action from an MO (Mobile Originated) message configuration." }, { "info": { "name": "Delete Push Inbox messages", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/push/1/inbox/messages", "params": [ { "name": "campaignId", "value": "100004815162342", "type": "query", "description": "`campaignId` of messages that you'd like to delete." }, { "name": "bulkId", "value": "fe40d1aa-b4ec-11ec-b909-0242ac120002", "type": "query", "description": "`bulkId` of messages that you'd like to delete." }, { "name": "messageId", "value": "1738833000000", "type": "query", "description": "`messageId` of the specific message you'd like to delete." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Deletes Push Inbox messages from devices that have a mobile application integrated with the 'Push Inbox'. Beware, this action cannot be undone." }, { "info": { "name": "Delete Push Inbox message for a specific user", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/push/1/user/:externalUserId/inbox/messages", "params": [ { "name": "externalUserId", "value": "", "type": "path", "description": "External identifier of the user" }, { "name": "campaignId", "value": "", "type": "query", "description": "`campaignId` of message to delete" }, { "name": "bulkId", "value": "", "type": "query", "description": "`bulkId` of message to delete" }, { "name": "messageId", "value": "", "type": "query", "description": "`messageId` of the specific message to delete" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Deletes a single Push Inbox message from a specific user's inbox. Requires specifying either campaignId or bulkId." }, { "info": { "name": "Send RCS messages", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/rcs/2/messages", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send RCS messages or RCS template messages to multiple recipients. Maximum request size is 10MB. Including some fields will affect [billing type](https://www.infobip.com/docs/rcs/billing-types)." }, { "info": { "name": "Send RCS message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/ott/rcs/1/message", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Used for sending single RCS messages" }, { "info": { "name": "Send bulk RCS message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/ott/rcs/1/message/bulk", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Used for sending bulk RCS messages" }, { "info": { "name": "Send RCS template message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/ott/rcs/1/message/template", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Used for sending single RCS template messages (only for Vodafone Idea Limited, India)" }, { "info": { "name": "Send bulk RCS template message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/ott/rcs/1/message/template/bulk", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Used for sending bulk RCS template messages (only for Vodafone Idea Limited, India)" }, { "info": { "name": "Send RCS events", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/rcs/1/events", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send RCS events to multiple recipients. Maximum request size is 10MB." }, { "info": { "name": "Get RCS delivery reports", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/rcs/2/reports", "params": [ { "name": "bulkId", "value": "", "type": "query", "description": "The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address." }, { "name": "messageId", "value": "", "type": "query", "description": "The ID that uniquely identifies the message sent." }, { "name": "limit", "value": "1", "type": "query", "description": "Maximum number of delivery reports to be returned. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access reports for the last 48h." }, { "name": "entityId", "value": "promotional-traffic-entity", "type": "query", "description": "Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "applicationId", "value": "marketing-automation-application", "type": "query", "description": "Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "campaignReferenceId", "value": "summersale", "type": "query", "description": "ID of a campaign that was sent in the message." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "If you are unable to receive real-time delivery reports towards your endpoint for various reasons, we offer you an API method to fetch batches of delivery reports to confirm whether specific messages have been delivered. Each request towards this endpoint will return batches of the latest delivery reports. Please note they will be returned only once." }, { "info": { "name": "Get RCS message logs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/rcs/2/logs", "params": [ { "name": "sender", "value": "", "type": "query", "description": "The sender ID which can be alphanumeric or numeric." }, { "name": "destination", "value": "", "type": "query", "description": "Message destination address." }, { "name": "bulkId", "value": "BULK-ID-123-xyz", "type": "query", "description": "Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. May contain multiple comma-separated values. Maximum length 2048 characters." }, { "name": "messageId", "value": "MESSAGE-ID-123-xyz,MESSAGE-ID-124-xyz", "type": "query", "description": "Unique message ID for which a log is requested. May contain multiple comma-separated values. Maximum length 2048 characters." }, { "name": "generalStatus", "value": "", "type": "query" }, { "name": "sentSince", "value": "2020-02-22T17:42:05.390+01:00", "type": "query", "description": "The logs will only include messages sent after this date. Use it alongside sentUntil to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ." }, { "name": "sentUntil", "value": "2020-02-23T17:42:05.390+01:00", "type": "query", "description": "The logs will only include messages sent before this date. Use it alongside sentSince to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of messages to include in logs. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access logs for the last 48h." }, { "name": "entityId", "value": "promotional-traffic-entity", "type": "query", "description": "Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "applicationId", "value": "marketing-automation-application", "type": "query", "description": "Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "campaignReferenceId", "value": "summersale", "type": "query", "description": "ID of a campaign that was sent in the message. May contain multiple comma-separated values." }, { "name": "useCursor", "value": "", "type": "query", "description": "Flag used to enable cursor-based pagination. When set to true, the system will use the cursor to fetch the next set of logs." }, { "name": "cursor", "value": "", "type": "query", "description": "Value which represents the current position in the data set. For the first request, this field shouldn't be defined. In subsequent requests, use the `nextCursor` value returned from the previous response to continue fetching data." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method for displaying logs for example in the user interface. Available are the logs for the last 48 hours." }, { "info": { "name": "Check RCS capability", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/rcs/2/capability-check/query", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this endpoint to verify whether the phone numbers in a given list can receive RCS messages from the specified sender. You can check up to 500 phone numbers in a single request; however, for improved efficiency, performance, and response time, we recommend using smaller batches of 1 to 10 numbers in a single request. This synchronous API is typically used for routing purposes when verifying a number’s RCS capability immediately before sending a message. This API supports up to a 100 requests " }, { "info": { "name": "Check RCS capability (async)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/rcs/2/capability-check/notify", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this endpoint to verify whether the phone numbers in a given list can receive RCS messages from the specified sender. You can check up to 10,000 phone numbers in a single request. The [Capability Check result](#channels/rcs/receive-capability-check-result) returns asynchronously and provides the capability status for each phone number individually.\n\nEnsure the sender is configured and launched on the mobile network/carrier that manages the phone numbers being tested for RCS capability. If th" }, { "info": { "name": "Get RCS senders", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/rcs/1/senders", "params": [ { "name": "page", "value": "0", "type": "query", "description": "Results page you want to retrieve (0..N). The default value is 0." }, { "name": "size", "value": "20", "type": "query", "description": "Number of records per page (1..100). The default value is 20." }, { "name": "sort", "value": "updatedAt,desc", "type": "query", "description": "Sorting criteria in the format: property(,asc|desc). Default sort order is descending by 'updatedAt'. Sortable Properties: 'updatedAt', 'senderName'." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Retrieve list of RCS senders." }, { "info": { "name": "Create an RCS sender", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/rcs/1/senders", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create an RCS sender. Created RCS sender can immediately be used to send test messages to test numbers. See [Add RCS test number](#channels/rcs/add-rcs-test-number) operation for more details about adding test numbers for sender. Please note that following limits will apply when creating RCS sender:\n* It is allowed to add up to 10 senders in total.\n\nPlease contact your account manager if you need to add more senders." }, { "info": { "name": "Get RCS sender", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/rcs/1/senders/:senderName", "params": [ { "name": "senderName", "value": "DemoSender", "type": "path", "description": "Sender identifier." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get a single RCS sender by sender name." }, { "info": { "name": "Update an RCS sender", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/rcs/1/senders/:senderName", "params": [ { "name": "senderName", "value": "DemoSender", "type": "path", "description": "Sender identifier." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update an RCS sender. Please note that once sender is locked, it's not possible to update sender data anymore." }, { "info": { "name": "Update RCS sender platform parameters", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/rcs/1/senders/:senderName/platform-parameters", "params": [ { "name": "senderName", "value": "DemoSender", "type": "path", "description": "Sender identifier." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update platform parameters associated with RCS sender. These parameters can be edited at any point of time." }, { "info": { "name": "Get RCS sender launch status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/rcs/1/senders/:senderName/launch-status", "params": [ { "name": "senderName", "value": "DemoSender", "type": "path", "description": "Sender identifier." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get detailed launch status information for an RCS sender, including coverage details by country and provider. This endpoint provides granular information about the launch progress across different carriers and regions." }, { "info": { "name": "Get RCS available providers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/rcs/1/senders/providers", "params": [ { "name": "countryCode", "value": "IN", "type": "query", "description": "Country code in two-letter ISO 3166-1 alpha 2 standard. If set, only providers available in the specified country will be returned." }, { "name": "page", "value": "0", "type": "query", "description": "Results page you want to retrieve (0..N)." }, { "name": "pageSize", "value": "20", "type": "query", "description": "Number of records per page (1..200)." }, { "name": "sortDirection", "value": "ASC", "type": "query", "description": "Sorting order by property 'countryCode'. Sorting orders: ASC, DESC." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Retrieve a list of RCS available providers specified by countries." }, { "info": { "name": "Get RCS test numbers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/rcs/1/senders/:senderName/test-numbers", "params": [ { "name": "senderName", "value": "DemoSender", "type": "path", "description": "Identifier of a sender for which test number is requested." }, { "name": "page", "value": "0", "type": "query", "description": "Results page you want to retrieve (0..N). The default value is 0." }, { "name": "size", "value": "20", "type": "query", "description": "Number of records per page (1..100). The default value is 20." }, { "name": "sort", "value": "updatedAt,desc", "type": "query", "description": "Sorting criteria in the format: property(,asc|desc). Default sort order is descending by 'updatedAt'. Sortable Properties: 'updatedAt'." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get RCS test numbers for given sender. Please note that information about status of test number was correct at the moment when test number was last time updated. If latest status for some test number is needed, [Get RCS test number](#channels/rcs/get-rcs-test-number) operation can be used." }, { "info": { "name": "Add RCS test number", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/rcs/1/senders/:senderName/test-numbers", "params": [ { "name": "senderName", "value": "DemoSender", "type": "path", "description": "Identifier of a sender for which test number is requested." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Add test number for given RCS sender. Invitation to become tester will be sent to given number and once user accepts invitation it will be possible to send test traffic to given test number using given sender. Please note that following limits will apply when adding test number for RCS sender:\n* It is allowed to add up to 20 test numbers per sender per day.\n* It is allowed to add up to 200 test number per sender in total." }, { "info": { "name": "Get RCS test number", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/rcs/1/senders/:senderName/test-numbers/:testNumber", "params": [ { "name": "senderName", "value": "DemoSender", "type": "path", "description": "Identifier of a sender for which test number is requested." }, { "name": "testNumber", "value": "+441134960001", "type": "path", "description": "Full number in E.164 format, e.g. +1234567890. Leading '+' is optional." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get RCS test number. This operation will check current status of given test number and return most up to date result." }, { "info": { "name": "Update primary flag of RCS test number", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/rcs/1/senders/:senderName/test-numbers/:testNumber", "params": [ { "name": "senderName", "value": "DemoSender", "type": "path", "description": "Identifier of a sender for which test number is requested." }, { "name": "testNumber", "value": "+441134960001", "type": "path", "description": "Full number in E.164 format, e.g. +1234567890. Leading '+' is optional." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update primary flag of RCS test number." }, { "info": { "name": "Refresh RCS test number", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/rcs/1/senders/:senderName/test-numbers/:testNumber/refresh", "params": [ { "name": "senderName", "value": "DemoSender", "type": "path", "description": "Identifier of a sender for which test number is requested." }, { "name": "testNumber", "value": "+441134960001", "type": "path", "description": "Full number in E.164 format, e.g. +1234567890. Leading '+' is optional." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Status of RCS test number is automatically refreshed for 24 hours after it was added. If user does not accept invitation to become a tester in that period, test number will be marked as EXPIRED. Use this endpoint in order to start new 24 hours cycle in which system will periodically check if user has accepted to become a tester." }, { "info": { "name": "Get RCS templates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/rcs/1/senders/:sender/templates", "params": [ { "name": "sender", "value": "Demo", "type": "path", "description": "The sender whose templates will be retrieved." }, { "name": "status", "value": "APPROVED", "type": "query", "description": "The status used to filter and retrieve templates with the specified state. If the status is not specified, all templates are returned." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Retrieve all RCS templates and their statuses for a specified sender. Available only for senders that support templates." }, { "info": { "name": "Create an RCS template", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/rcs/1/senders/:sender/templates", "params": [ { "name": "sender", "value": "Demo", "type": "path", "description": "The sender for whom the template will be created." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create an RCS template for a specified sender. The template will be submitted for review and approval. Once approved, the template can be used for messaging. Available only for senders that support templates." }, { "info": { "name": "Get RCS template", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/rcs/1/senders/:sender/templates/:templateName", "params": [ { "name": "sender", "value": "Demo", "type": "path", "description": "The sender whose specific template will be retrieved." }, { "name": "templateName", "value": "demo_template", "type": "path", "description": "The unique name of the template that will be retrieved for the specified sender." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Retrieve a single RCS template with its status for a given sender and template name. Available only for senders that support templates." }, { "info": { "name": "Create an RCS template", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/rcs/1/senders/:sender/templates/:templateName", "params": [ { "name": "sender", "value": "Demo", "type": "path", "description": "The sender for whom the template will be created." }, { "name": "templateName", "value": "demo_template", "type": "path", "description": "The unique name of the template that will be created for the specified sender. Must contain only alphanumeric characters and underscores." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create an RCS template for a specified sender. The template will be submitted for review and approval. Once approved, the template can be used for messaging. Available only for senders that support templates. Please note that this endpoint is deprecated and will be removed in future versions." }, { "info": { "name": "Edit an RCS template", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/rcs/1/senders/:sender/templates/:templateName", "params": [ { "name": "sender", "value": "Demo", "type": "path", "description": "The sender whose template will be updated." }, { "name": "templateName", "value": "demo_template", "type": "path", "description": "The unique name of the template that will be updated for the specified sender." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Edit an RCS template. Only PENDING, SUSPENDED or REJECTED templates can be edited. APPROVED templates cannot be modified. Available only for senders that support templates.." }, { "info": { "name": "Delete an RCS template", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/rcs/1/senders/:sender/templates/:templateName", "params": [ { "name": "sender", "value": "Demo", "type": "path", "description": "The sender whose template will be deleted." }, { "name": "templateName", "value": "demo_template", "type": "path", "description": "The unique name of the template that will be deleted for the specified sender." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete an RCS template. Any messages sent using a deleted template will be rejected. Available only for senders that support templates." }, { "info": { "name": "Get RCS template status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/rcs/1/senders/:sender/templates/:templateName/status", "params": [ { "name": "sender", "value": "Demo", "type": "path", "description": "The sender whose template status will be retrieved." }, { "name": "templateName", "value": "demo_template", "type": "path", "description": "The unique name of the template for which the status will be retrieved." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Retrieve the detailed status of a specified RCS template for a given sender. Available only for senders that support templates." }, { "info": { "name": "Register an RCS template", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/rcs/1/senders/:sender/templates/:templateName/register", "params": [ { "name": "sender", "value": "Demo", "type": "path", "description": "The sender whose template should be registered with additional providers." }, { "name": "templateName", "value": "demo_template", "type": "path", "description": "The unique name of the template that should be registered with additional providers." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Registers an RCS template with additional providers. Available only for senders that support templates." }, { "info": { "name": "Get RCS template providers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/rcs/1/templates/template-providers", "params": [ { "name": "sender", "value": "Demo", "type": "query", "description": "The sender for which the list of available template providers should be retrieved." }, { "name": "countryCode", "value": "IN", "type": "query", "description": "Country code in two-letter ISO standard. If set, only providers available in the specified country will be returned." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get list of available template providers. List can be filtered by sender and country code." }, { "info": { "name": "List all OMNI failover scenarios", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/omni/1/scenarios", "params": [ { "name": "isDefault", "value": "true", "type": "query", "description": "Get default scenario." }, { "name": "limit", "value": "", "type": "query", "description": "Maximal number of scenarios that will be returned, defaults to __100__." }, { "name": "page", "value": "", "type": "query", "description": "Indexed page of scenarios that will be returned, defaults to 0." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "See all failover scenarios that you have created." }, { "info": { "name": "Create new OMNI failover scenario", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/omni/1/scenarios", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Define which channels, and in which order, would you like to use in your message failover scenario. If the delivery of the message fails for the first channel, we will use the next channel in your scenario, and so on." }, { "info": { "name": "Get specific OMNI failover scenario", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/omni/1/scenarios/:scenarioKey", "params": [ { "name": "scenarioKey", "value": "AD9E01A5DC7BEE2C2B828D208182A611", "type": "path", "description": "Key used to uniquely identify OMNI scenario." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "See configuration of a specific failover scenario." }, { "info": { "name": "Update OMNI failover scenario", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/omni/1/scenarios/:scenarioKey", "params": [ { "name": "scenarioKey", "value": "CD265875E3A6EA43478D5F37A635BE4A", "type": "path", "description": "Key used to uniquely identify OMNI scenario." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Change configuration of a specific failover scenario." }, { "info": { "name": "Send OMNI failover message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/omni/1/advanced", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send one or multiple messages over WhatsApp, Viber, Voice, VKontakte, Line, SMS or Push, with automatic failover to another channel according to the specific scenario." }, { "info": { "name": "Get OMNI failover delivery reports", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/omni/1/reports", "params": [ { "name": "bulkId", "value": "", "type": "query", "description": "The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address." }, { "name": "messageId", "value": "", "type": "query", "description": "The ID that uniquely identifies the message sent." }, { "name": "limit", "value": "1", "type": "query", "description": "Maximal number of messages in returned reports. Default value is __50__ and maximal value is __1000__." }, { "name": "channel", "value": "PUSH", "type": "query", "description": "Channel that was used for message delivering." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get one-time delivery reports to see which channel was used to deliver the failover message." }, { "info": { "name": "Get OMNI failover message logs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/omni/1/logs", "params": [ { "name": "from", "value": "DemoViberApp", "type": "query", "description": "Sender that can be alphanumeric or numeric." }, { "name": "to", "value": "41793026727", "type": "query", "description": "The message destination address." }, { "name": "bulkId", "value": "1dece649-6c8f-404e-8c6e-c7e073be509a,bafdeb3d-719b-4cce-8762-54d47b40f3c5", "type": "query", "description": "The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address." }, { "name": "messageId", "value": "1,2,3", "type": "query", "description": "The ID that uniquely identifies the message sent." }, { "name": "generalStatus", "value": "", "type": "query", "description": "Sent message status group. Indicates whether the message is successfully sent, not sent, delivered, not delivered, waiting for delivery or any other possible status." }, { "name": "channel", "value": "PUSH", "type": "query", "description": "Channel that was used for message delivering." }, { "name": "sentSince", "value": "2015-02-22T17:42:05.390+01:00", "type": "query", "description": "Lower limit on date and time of sending messages." }, { "name": "sentUntil", "value": "2015-02-22T17:44:05.390+01:00", "type": "query", "description": "Upper limit on date and time of sending messages." }, { "name": "limit", "value": "1", "type": "query", "description": "Maximal number of messages in returned logs. Default value is __50__. Maximum value is __1000__." }, { "name": "mcc", "value": "", "type": "query", "description": "Mobile country code." }, { "name": "mnc", "value": "", "type": "query", "description": "Mobile network code." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "If you need to show message logs in some GUI use this method. For message delivery status use [OMNI failover delivery reports](#programmable-communications/omni-failover/get-omni-failover-delivery-reports)." }, { "info": { "name": "Invalidate customer session", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/livechat/1/widgets/:widgetId/sessions/:sessionId", "params": [ { "name": "widgetId", "value": "", "type": "path", "description": "Unique identifier of your widget. You can obtain the identifier from the [widget configuration page](https://portal.infobip.com/apps/livechat) or from the widget installation snippet." }, { "name": "sessionId", "value": "", "type": "path", "description": "Unique identifier of user session to be invalidated. For more information on session identifiers, see the **SID** parameter in [personalization token](https://www.infobip.com/docs/live-chat/users-and-authentication#generate-the-personalization-token-web-authentication) documentation." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method enables you to invalidate an [authenticated Live Chat web session](https://www.infobip.com/docs/live-chat/users-and-authentication#web-authentication).\n Session invalidation is performed whenever you wish to explicitly terminate an authenticated session, for example on user log out or due to security concerns." }, { "info": { "name": "Send Apple Messages for Business", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/apple-mfb/1/messages", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send one or more messages to multiple recipients." }, { "info": { "name": "Send Apple Events", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/apple-mfb/1/events", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send one or more events to multiple recipients." }, { "info": { "name": "Get Apple Messages for Business delivery reports", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/apple-mfb/1/reports", "params": [ { "name": "bulkId", "value": "", "type": "query", "description": "The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address." }, { "name": "messageId", "value": "", "type": "query", "description": "The ID that uniquely identifies the message sent." }, { "name": "limit", "value": "1", "type": "query", "description": "Maximum number of delivery reports to be returned. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access reports for the last 48h." }, { "name": "entityId", "value": "promotional-traffic-entity", "type": "query", "description": "Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "applicationId", "value": "marketing-automation-application", "type": "query", "description": "Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "campaignReferenceId", "value": "summersale", "type": "query", "description": "ID of a campaign that was sent in the message." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "If you are unable to receive real-time delivery reports towards your endpoint for various reasons, we offer you an API method to fetch batches of delivery reports to confirm whether specific messages have been delivered. Each request towards this endpoint will return batches of the latest delivery reports. Please note they will be returned only once." }, { "info": { "name": "Get message logs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/apple-mfb/1/logs", "params": [ { "name": "sender", "value": "", "type": "query", "description": "The sender ID which can be alphanumeric or numeric." }, { "name": "destination", "value": "", "type": "query", "description": "Message destination address." }, { "name": "bulkId", "value": "BULK-ID-123-xyz", "type": "query", "description": "Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. May contain multiple comma-separated values. Maximum length 2048 characters." }, { "name": "messageId", "value": "MESSAGE-ID-123-xyz,MESSAGE-ID-124-xyz", "type": "query", "description": "Unique message ID for which a log is requested. May contain multiple comma-separated values. Maximum length 2048 characters." }, { "name": "generalStatus", "value": "", "type": "query" }, { "name": "sentSince", "value": "2020-02-22T17:42:05.390+01:00", "type": "query", "description": "The logs will only include messages sent after this date. Use it alongside sentUntil to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ." }, { "name": "sentUntil", "value": "2020-02-23T17:42:05.390+01:00", "type": "query", "description": "The logs will only include messages sent before this date. Use it alongside sentSince to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of messages to include in logs. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access logs for the last 48h." }, { "name": "entityId", "value": "promotional-traffic-entity", "type": "query", "description": "Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "applicationId", "value": "marketing-automation-application", "type": "query", "description": "Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "campaignReferenceId", "value": "summersale", "type": "query", "description": "ID of a campaign that was sent in the message. May contain multiple comma-separated values." }, { "name": "useCursor", "value": "", "type": "query", "description": "Flag used to enable cursor-based pagination. When set to true, the system will use the cursor to fetch the next set of logs." }, { "name": "cursor", "value": "", "type": "query", "description": "Value which represents the current position in the data set. For the first request, this field shouldn't be defined. In subsequent requests, use the `nextCursor` value returned from the previous response to continue fetching data." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method for displaying logs for example in the user interface. Available are the logs for the last 48 hours." }, { "info": { "name": "Send a Instagram message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/instagram/1/messages", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send one or more messages to multiple recipients." }, { "info": { "name": "Get Instagram delivery reports", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/instagram/1/reports", "params": [ { "name": "bulkId", "value": "", "type": "query", "description": "The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address." }, { "name": "messageId", "value": "", "type": "query", "description": "The ID that uniquely identifies the message sent." }, { "name": "limit", "value": "1", "type": "query", "description": "Maximum number of delivery reports to be returned. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access reports for the last 48h." }, { "name": "entityId", "value": "promotional-traffic-entity", "type": "query", "description": "Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "applicationId", "value": "marketing-automation-application", "type": "query", "description": "Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "campaignReferenceId", "value": "summersale", "type": "query", "description": "ID of a campaign that was sent in the message." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "If you are unable to receive real-time delivery reports towards your endpoint for various reasons, we offer you an API method to fetch batches of delivery reports to confirm whether specific messages have been delivered. Each request towards this endpoint will return batches of the latest delivery reports. Please note they will be returned only once." }, { "info": { "name": "Get outbound Instagram message logs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/instagram/1/logs", "params": [ { "name": "sender", "value": "", "type": "query", "description": "The sender ID which can be alphanumeric or numeric." }, { "name": "destination", "value": "", "type": "query", "description": "Message destination address." }, { "name": "bulkId", "value": "BULK-ID-123-xyz", "type": "query", "description": "Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. May contain multiple comma-separated values. Maximum length 2048 characters." }, { "name": "messageId", "value": "MESSAGE-ID-123-xyz,MESSAGE-ID-124-xyz", "type": "query", "description": "Unique message ID for which a log is requested. May contain multiple comma-separated values. Maximum length 2048 characters." }, { "name": "generalStatus", "value": "", "type": "query" }, { "name": "sentSince", "value": "2020-02-22T17:42:05.390+01:00", "type": "query", "description": "The logs will only include messages sent after this date. Use it alongside sentUntil to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ." }, { "name": "sentUntil", "value": "2020-02-23T17:42:05.390+01:00", "type": "query", "description": "The logs will only include messages sent before this date. Use it alongside sentSince to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of messages to include in logs. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access logs for the last 48h." }, { "name": "entityId", "value": "promotional-traffic-entity", "type": "query", "description": "Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "applicationId", "value": "marketing-automation-application", "type": "query", "description": "Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "campaignReferenceId", "value": "summersale", "type": "query", "description": "ID of a campaign that was sent in the message. May contain multiple comma-separated values." }, { "name": "useCursor", "value": "", "type": "query", "description": "Flag used to enable cursor-based pagination. When set to true, the system will use the cursor to fetch the next set of logs." }, { "name": "cursor", "value": "", "type": "query", "description": "Value which represents the current position in the data set. For the first request, this field shouldn't be defined. In subsequent requests, use the `nextCursor` value returned from the previous response to continue fetching data." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method for displaying logs for example in the user interface. Available are the logs for the last 48 hours." }, { "info": { "name": "Send a Messenger message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/messenger/1/messages", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send one or more messages to multiple recipients.
    Marketing messages on Messenger are no longer available for new users. For existing users, this feature will be deprecated on January 12, 2026. After this date, marketing messages will fail with an error." }, { "info": { "name": "Get Messenger delivery reports", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/messenger/1/reports", "params": [ { "name": "bulkId", "value": "", "type": "query", "description": "The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address." }, { "name": "messageId", "value": "", "type": "query", "description": "The ID that uniquely identifies the message sent." }, { "name": "limit", "value": "1", "type": "query", "description": "Maximum number of delivery reports to be returned. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access reports for the last 48h." }, { "name": "entityId", "value": "promotional-traffic-entity", "type": "query", "description": "Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "applicationId", "value": "marketing-automation-application", "type": "query", "description": "Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "campaignReferenceId", "value": "summersale", "type": "query", "description": "ID of a campaign that was sent in the message." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "If you are unable to receive real-time delivery reports towards your endpoint for various reasons, we offer you an API method to fetch batches of delivery reports to confirm whether specific messages have been delivered. Each request towards this endpoint will return batches of the latest delivery reports. Please note they will be returned only once." }, { "info": { "name": "Get outbound Messenger message logs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/messenger/1/logs", "params": [ { "name": "sender", "value": "", "type": "query", "description": "The sender ID which can be alphanumeric or numeric." }, { "name": "destination", "value": "", "type": "query", "description": "Message destination address." }, { "name": "bulkId", "value": "BULK-ID-123-xyz", "type": "query", "description": "Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. May contain multiple comma-separated values. Maximum length 2048 characters." }, { "name": "messageId", "value": "MESSAGE-ID-123-xyz,MESSAGE-ID-124-xyz", "type": "query", "description": "Unique message ID for which a log is requested. May contain multiple comma-separated values. Maximum length 2048 characters." }, { "name": "generalStatus", "value": "", "type": "query" }, { "name": "sentSince", "value": "2020-02-22T17:42:05.390+01:00", "type": "query", "description": "The logs will only include messages sent after this date. Use it alongside sentUntil to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ." }, { "name": "sentUntil", "value": "2020-02-23T17:42:05.390+01:00", "type": "query", "description": "The logs will only include messages sent before this date. Use it alongside sentSince to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of messages to include in logs. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access logs for the last 48h." }, { "name": "entityId", "value": "promotional-traffic-entity", "type": "query", "description": "Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "applicationId", "value": "marketing-automation-application", "type": "query", "description": "Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "campaignReferenceId", "value": "summersale", "type": "query", "description": "ID of a campaign that was sent in the message. May contain multiple comma-separated values." }, { "name": "useCursor", "value": "", "type": "query", "description": "Flag used to enable cursor-based pagination. When set to true, the system will use the cursor to fetch the next set of logs." }, { "name": "cursor", "value": "", "type": "query", "description": "Value which represents the current position in the data set. For the first request, this field shouldn't be defined. In subsequent requests, use the `nextCursor` value returned from the previous response to continue fetching data." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method for displaying logs for example in the user interface. Available are the logs for the last 48 hours." }, { "info": { "name": "Get marketing subscriptions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/messenger/1/pages/:pageId/subscriptions", "params": [ { "name": "pageId", "value": "263213833541399", "type": "path", "description": "Page ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get all messenger marketing subscriptions for single page.
    Collecting subscription tokens still works on the Messenger platform. However, marketing messages on Messenger are no longer available for new users. For existing users, this feature will be deprecated on January 12, 2026. After this date, marketing messages will no longer be supported." }, { "info": { "name": "Get campaigns", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/messenger/1/campaigns", "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Returns all Facebook Messenger marketing campaigns for the authenticated account." }, { "info": { "name": "Create campaign", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/messenger/1/campaigns", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create a new Facebook Messenger marketing campaign to send marketing messages to opted-in users. The campaign is associated with your ad account and Facebook page." }, { "info": { "name": "Delete campaign", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/messenger/1/campaigns/:campaignId", "params": [ { "name": "campaignId", "value": "120213234151570", "type": "path", "description": "Campaign ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete an existing Facebook Messenger marketing campaign." }, { "info": { "name": "Get ad accounts", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/messenger/1/ad-accounts", "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Returns all Facebook ad accounts associated with the authenticated marketing account." }, { "info": { "name": "Get audiences", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/messenger/1/audiences", "params": [ { "name": "adAccountId", "value": "", "type": "query", "description": "Facebook ad account ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Retrieve all custom audiences for the given ad account." }, { "info": { "name": "Create custom audience", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/messenger/1/audiences", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create a new custom audience for marketing messages. Users can be uploaded to this audience to grow the marketing messages subscriber base." }, { "info": { "name": "Delete audience", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/messenger/1/audiences/:audienceId", "params": [ { "name": "audienceId", "value": "", "type": "path", "description": "Meta custom audience ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete a custom audience. This permanently removes the audience from Meta and stops any campaigns using it." }, { "info": { "name": "Upload users to audience", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/messenger/1/audiences/:audienceId/users", "params": [ { "name": "audienceId", "value": "", "type": "path", "description": "Meta custom audience ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Upload hashed user data (SHA-256) to a custom audience. Meta matches this data against its user database to grow your marketing messages subscriber base. Maximum 10,000 users per request." }, { "info": { "name": "Remove user from audience", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/messenger/1/audiences/:audienceId/users/:hashedPhoneNumber", "params": [ { "name": "audienceId", "value": "", "type": "path", "description": "Meta custom audience ID." }, { "name": "hashedPhoneNumber", "value": "", "type": "path", "description": "SHA-256 hashed phone number to remove." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Remove a single hashed phone number from a custom audience." }, { "info": { "name": "Send a Kakao Alim message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/kakao-alim/1/messages", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send one or more messages to multiple recipients." }, { "info": { "name": "Get Kakao Alim delivery reports", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/kakao-alim/1/reports", "params": [ { "name": "bulkId", "value": "", "type": "query", "description": "The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address." }, { "name": "messageId", "value": "", "type": "query", "description": "The ID that uniquely identifies the message sent." }, { "name": "limit", "value": "1", "type": "query", "description": "Maximum number of delivery reports to be returned. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access reports for the last 48h." }, { "name": "entityId", "value": "promotional-traffic-entity", "type": "query", "description": "Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "applicationId", "value": "marketing-automation-application", "type": "query", "description": "Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "campaignReferenceId", "value": "summersale", "type": "query", "description": "ID of a campaign that was sent in the message." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "If you are unable to receive real-time delivery reports towards your endpoint for various reasons, we offer you an API method to fetch batches of delivery reports to confirm whether specific messages have been delivered. Each request towards this endpoint will return batches of the latest delivery reports. Please note they will be returned only once." }, { "info": { "name": "Get outbound Kakao Alim message logs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/kakao-alim/1/logs", "params": [ { "name": "sender", "value": "", "type": "query", "description": "The sender ID which can be alphanumeric or numeric." }, { "name": "destination", "value": "", "type": "query", "description": "Message destination address." }, { "name": "bulkId", "value": "BULK-ID-123-xyz", "type": "query", "description": "Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. May contain multiple comma-separated values. Maximum length 2048 characters." }, { "name": "messageId", "value": "MESSAGE-ID-123-xyz,MESSAGE-ID-124-xyz", "type": "query", "description": "Unique message ID for which a log is requested. May contain multiple comma-separated values. Maximum length 2048 characters." }, { "name": "generalStatus", "value": "", "type": "query" }, { "name": "sentSince", "value": "2020-02-22T17:42:05.390+01:00", "type": "query", "description": "The logs will only include messages sent after this date. Use it alongside sentUntil to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ." }, { "name": "sentUntil", "value": "2020-02-23T17:42:05.390+01:00", "type": "query", "description": "The logs will only include messages sent before this date. Use it alongside sentSince to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of messages to include in logs. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access logs for the last 48h." }, { "name": "entityId", "value": "promotional-traffic-entity", "type": "query", "description": "Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "applicationId", "value": "marketing-automation-application", "type": "query", "description": "Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "campaignReferenceId", "value": "summersale", "type": "query", "description": "ID of a campaign that was sent in the message. May contain multiple comma-separated values." }, { "name": "useCursor", "value": "", "type": "query", "description": "Flag used to enable cursor-based pagination. When set to true, the system will use the cursor to fetch the next set of logs." }, { "name": "cursor", "value": "", "type": "query", "description": "Value which represents the current position in the data set. For the first request, this field shouldn't be defined. In subsequent requests, use the `nextCursor` value returned from the previous response to continue fetching data." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method for displaying logs for example in the user interface. Available are the logs for the last 48 hours." }, { "info": { "name": "Send a Kakao Sangdam message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/kakao-sangdam/1/messages", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send one or more messages to multiple recipients." }, { "info": { "name": "Get Kakao Sangdam delivery reports", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/kakao-sangdam/1/reports", "params": [ { "name": "bulkId", "value": "", "type": "query", "description": "The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address." }, { "name": "messageId", "value": "", "type": "query", "description": "The ID that uniquely identifies the message sent." }, { "name": "limit", "value": "1", "type": "query", "description": "Maximum number of delivery reports to be returned. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access reports for the last 48h" }, { "name": "entityId", "value": "promotional-traffic-entity", "type": "query", "description": "Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "applicationId", "value": "marketing-automation-application", "type": "query", "description": "Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "campaignReferenceId", "value": "summersale", "type": "query", "description": "ID of a campaign that was sent in the message." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "If you are unable to receive real-time delivery reports towards your endpoint for various reasons, we offer you an API method to fetch batches of delivery reports to confirm whether specific messages have been delivered. Each request towards this endpoint will return batches of the latest delivery reports. Please note they will be returned only once." }, { "info": { "name": "Get outbound Kakao Sangdam message logs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/kakao-sangdam/1/logs", "params": [ { "name": "sender", "value": "", "type": "query", "description": "The sender ID which can be alphanumeric or numeric." }, { "name": "destination", "value": "", "type": "query", "description": "Message destination address." }, { "name": "bulkId", "value": "BULK-ID-123-xyz", "type": "query", "description": "Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. May contain multiple comma-separated values. Maximum length 2048 characters." }, { "name": "messageId", "value": "MESSAGE-ID-123-xyz,MESSAGE-ID-124-xyz", "type": "query", "description": "Unique message ID for which a log is requested. May contain multiple comma-separated values. Maximum length 2048 characters." }, { "name": "generalStatus", "value": "", "type": "query" }, { "name": "sentSince", "value": "2020-02-22T17:42:05.390+01:00", "type": "query", "description": "The logs will only include messages sent after this date. Use it alongside sentUntil to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ." }, { "name": "sentUntil", "value": "2020-02-23T17:42:05.390+01:00", "type": "query", "description": "The logs will only include messages sent before this date. Use it alongside sentSince to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of messages to include in logs. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access logs for the last 48h." }, { "name": "entityId", "value": "promotional-traffic-entity", "type": "query", "description": "Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "applicationId", "value": "marketing-automation-application", "type": "query", "description": "Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "campaignReferenceId", "value": "summersale", "type": "query", "description": "ID of a campaign that was sent in the message. May contain multiple comma-separated values." }, { "name": "useCursor", "value": "", "type": "query", "description": "Flag used to enable cursor-based pagination. When set to true, the system will use the cursor to fetch the next set of logs." }, { "name": "cursor", "value": "", "type": "query", "description": "Value which represents the current position in the data set. For the first request, this field shouldn't be defined. In subsequent requests, use the `nextCursor` value returned from the previous response to continue fetching data." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method for displaying logs for example in the user interface. Available are the logs for the last 48 hours." }, { "info": { "name": "Send a brand message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/kakao-chingu/1/messages", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send one or more messages to multiple recipients.\nKakao Chingu will be deprecated on January 1, 2026, and Brand Messaging will replace it. Make sure to adjust your API connection to use only new content types that include _FREE_FORM or _VARIABLE in the content type name." }, { "info": { "name": "Get brand message delivery reports", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/kakao-chingu/1/reports", "params": [ { "name": "bulkId", "value": "", "type": "query", "description": "The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address." }, { "name": "messageId", "value": "", "type": "query", "description": "The ID that uniquely identifies the message sent." }, { "name": "limit", "value": "1", "type": "query", "description": "Maximum number of delivery reports to be returned. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access reports for the last 48h." }, { "name": "entityId", "value": "promotional-traffic-entity", "type": "query", "description": "Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "applicationId", "value": "marketing-automation-application", "type": "query", "description": "Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "campaignReferenceId", "value": "summersale", "type": "query", "description": "ID of a campaign that was sent in the message." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "If you are unable to receive real-time delivery reports towards your endpoint for various reasons, we offer you an API method to fetch batches of delivery reports to confirm whether specific messages have been delivered. Each request towards this endpoint will return batches of the latest delivery reports. Please note they will be returned only once." }, { "info": { "name": "Get message logs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/kakao-chingu/1/logs", "params": [ { "name": "sender", "value": "", "type": "query", "description": "The sender ID which can be alphanumeric or numeric." }, { "name": "destination", "value": "", "type": "query", "description": "Message destination address." }, { "name": "bulkId", "value": "BULK-ID-123-xyz", "type": "query", "description": "Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. May contain multiple comma-separated values. Maximum length 2048 characters." }, { "name": "messageId", "value": "MESSAGE-ID-123-xyz,MESSAGE-ID-124-xyz", "type": "query", "description": "Unique message ID for which a log is requested. May contain multiple comma-separated values. Maximum length 2048 characters." }, { "name": "generalStatus", "value": "", "type": "query" }, { "name": "sentSince", "value": "2020-02-22T17:42:05.390+01:00", "type": "query", "description": "The logs will only include messages sent after this date. Use it alongside sentUntil to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ." }, { "name": "sentUntil", "value": "2020-02-23T17:42:05.390+01:00", "type": "query", "description": "The logs will only include messages sent before this date. Use it alongside sentSince to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of messages to include in logs. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access logs for the last 48h." }, { "name": "entityId", "value": "promotional-traffic-entity", "type": "query", "description": "Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "applicationId", "value": "marketing-automation-application", "type": "query", "description": "Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "campaignReferenceId", "value": "summersale", "type": "query", "description": "ID of a campaign that was sent in the message. May contain multiple comma-separated values." }, { "name": "useCursor", "value": "", "type": "query", "description": "Flag used to enable cursor-based pagination. When set to true, the system will use the cursor to fetch the next set of logs." }, { "name": "cursor", "value": "", "type": "query", "description": "Value which represents the current position in the data set. For the first request, this field shouldn't be defined. In subsequent requests, use the `nextCursor` value returned from the previous response to continue fetching data." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method for displaying logs for example in the user interface. Available are the logs for the last 48 hours." }, { "info": { "name": "Get Brand Message templates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/kakao-brand-messages/1/templates", "params": [ { "name": "senderKey", "value": "123456789", "type": "query", "description": "Sender profile key." }, { "name": "senderGroupKey", "value": "", "type": "query", "description": "Sender group profile key." }, { "name": "since", "value": "2025-09-26T14:52:14.000+0200", "type": "query", "description": "Start date in format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`. Defaults to 1 hour before the time of the request." }, { "name": "page", "value": "5", "type": "query", "description": "Current page number." }, { "name": "size", "value": "10", "type": "query", "description": "Number of items per page." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get Brand Message templates with an optional time range filter to include only those modified within that period." }, { "info": { "name": "Create Brand Message template", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/kakao-brand-messages/1/templates", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create Brand Message template." }, { "info": { "name": "Get Brand Message template", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/kakao-brand-messages/1/templates/single", "params": [ { "name": "sender", "value": "123456789", "type": "query", "description": "Must be provided if senderGroup is not provided." }, { "name": "senderGroup", "value": "", "type": "query", "description": "Must be provided if sender is not provided." }, { "name": "templateCode", "value": "abc123dfg345", "type": "query", "description": "Template code." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get Brand Message template" }, { "info": { "name": "Update Brand Message template", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/kakao-brand-messages/1/templates/:templateCode", "params": [ { "name": "templateCode", "value": "TEMPLATE_001", "type": "path", "description": "Template code to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update an existing Brand Message template by template code." }, { "info": { "name": "Send Open Channel inbound message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/open-channel/1/messages/inbound", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Sends a message to Open Channel destination registered on Infobip platform." }, { "info": { "name": "Send TikTok messages", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/tiktok/1/messages", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send one or more text, image, or share-post messages to TikTok users in active conversations with your TikTok Business Account. You can send messages only after the user has messaged your Business Account first." }, { "info": { "name": "Send TikTok events", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/tiktok/1/events", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send typing indicator or mark-as-read events to TikTok users in active conversations with your TikTok Business Account." }, { "info": { "name": "Get TikTok delivery reports", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/tiktok/1/reports", "params": [ { "name": "bulkId", "value": "", "type": "query", "description": "The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address." }, { "name": "messageId", "value": "", "type": "query", "description": "The ID that uniquely identifies the message sent." }, { "name": "limit", "value": "1", "type": "query", "description": "Maximum number of delivery reports to be returned. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access reports for the last 48h" }, { "name": "entityId", "value": "promotional-traffic-entity", "type": "query", "description": "Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "applicationId", "value": "marketing-automation-application", "type": "query", "description": "Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "campaignReferenceId", "value": "summersale", "type": "query", "description": "ID of a campaign that was sent in the message." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this endpoint to pull delivery reports when your endpoint does not receive real-time delivery reports. Each request returns the latest batch of delivery reports from the last 48 hours. Each report is returned only once." }, { "info": { "name": "Get TikTok message logs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/tiktok/1/logs", "params": [ { "name": "sender", "value": "", "type": "query", "description": "The sender ID which can be alphanumeric or numeric." }, { "name": "destination", "value": "", "type": "query", "description": "Message destination address." }, { "name": "bulkId", "value": "BULK-ID-123-xyz", "type": "query", "description": "Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. May contain multiple comma-separated values. Maximum length 2048 characters." }, { "name": "messageId", "value": "MESSAGE-ID-123-xyz,MESSAGE-ID-124-xyz", "type": "query", "description": "Unique message ID for which a log is requested. May contain multiple comma-separated values. Maximum length 2048 characters." }, { "name": "generalStatus", "value": "", "type": "query" }, { "name": "sentSince", "value": "2020-02-22T17:42:05.390+01:00", "type": "query", "description": "The logs will only include messages sent after this date. Use it alongside sentUntil to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ." }, { "name": "sentUntil", "value": "2020-02-23T17:42:05.390+01:00", "type": "query", "description": "The logs will only include messages sent before this date. Use it alongside sentSince to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of messages to include in logs. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access logs for the last 48h." }, { "name": "entityId", "value": "promotional-traffic-entity", "type": "query", "description": "Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "applicationId", "value": "marketing-automation-application", "type": "query", "description": "Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "campaignReferenceId", "value": "summersale", "type": "query", "description": "ID of a campaign that was sent in the message. May contain multiple comma-separated values." }, { "name": "useCursor", "value": "", "type": "query", "description": "Flag used to enable cursor-based pagination. When set to true, the system will use the cursor to fetch the next set of logs." }, { "name": "cursor", "value": "", "type": "query", "description": "Value which represents the current position in the data set. For the first request, this field shouldn't be defined. In subsequent requests, use the `nextCursor` value returned from the previous response to continue fetching data." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this endpoint to retrieve outbound TikTok message logs for display in a user interface. Logs are available for the last 48 hours." } ] }, { "info": { "name": "platform", "type": "folder" }, "items": [ { "info": { "name": "Get all 2FA applications", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/2fa/2/applications", "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "An application is a container for 2FA message templates. Use this method to list your applications." }, { "info": { "name": "Create 2FA application", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/2fa/2/applications", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create and configure a new 2FA application." }, { "info": { "name": "Get 2FA application", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/2fa/2/applications/:appId", "params": [ { "name": "appId", "value": "0933F3BC087D2A617AC6DCB2EF5B8A61", "type": "path", "description": "ID of application for which configuration view was requested." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Get a single 2FA application to see its configuration details." }, { "info": { "name": "Update 2FA application", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/2fa/2/applications/:appId", "params": [ { "name": "appId", "value": "0933F3BC087D2A617AC6DCB2EF5B8A61", "type": "path", "description": "ID of application that should be updated." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Change configuration options for your existing 2FA application." }, { "info": { "name": "Get all 2FA message templates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/2fa/2/applications/:appId/messages", "params": [ { "name": "appId", "value": "0933F3BC087D2A617AC6DCB2EF5B8A61", "type": "path", "description": "ID of application for which requested message was created." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "List all message templates in a 2FA application." }, { "info": { "name": "Create 2FA SMS or Voice message template", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/2fa/2/applications/:appId/messages", "params": [ { "name": "appId", "value": "0933F3BC087D2A617AC6DCB2EF5B8A61", "type": "path", "description": "ID of application for which requested message was created." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Once you have your [2FA application](#channels/sms/2fa/2fa-configuration/create-2fa-application), create one or more [message templates](#channels/sms/2fa/2fa-configuration/create-2fa-message-template) where your PIN will be dynamically included when you send the PIN message over SMS or Voice." }, { "info": { "name": "Get 2FA message template", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/2fa/2/applications/:appId/messages/:msgId", "params": [ { "name": "appId", "value": "0933F3BC087D2A617AC6DCB2EF5B8A61", "type": "path", "description": "ID of application for which requested message was created." }, { "name": "msgId", "value": "16A8B5FE2BCD6CA716A2D780CB3F3390", "type": "path", "description": "Requested message ID." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Get a single 2FA message template from an application to see its configuration details." }, { "info": { "name": "Update 2FA SMS or Voice message template", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/2fa/2/applications/:appId/messages/:msgId", "params": [ { "name": "appId", "value": "0933F3BC087D2A617AC6DCB2EF5B8A61", "type": "path", "description": "ID of application for which requested message was created." }, { "name": "msgId", "value": "16A8B5FE2BCD6CA716A2D780CB3F3390", "type": "path", "description": "Requested message ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Change configuration options for your existing 2FA application SMS or Voice message template." }, { "info": { "name": "Create 2FA Email message template", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/2fa/2/applications/:appId/email/messages", "params": [ { "name": "appId", "value": "0933F3BC087D2A617AC6DCB2EF5B8A61", "type": "path", "description": "ID of application for which requested message was created." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Once you have your [2FA application](#channels/sms/create-2fa-application), create one or more [Email message templates](https://www.infobip.com/docs/email/templates) where your PIN will be dynamically included when you send the PIN message over Email." }, { "info": { "name": "Update 2FA Email message template", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/2fa/2/applications/:appId/email/messages/:msgId", "params": [ { "name": "appId", "value": "0933F3BC087D2A617AC6DCB2EF5B8A61", "type": "path", "description": "ID of application for which requested message was created." }, { "name": "msgId", "value": "16A8B5FE2BCD6CA716A2D780CB3F3390", "type": "path", "description": "Requested message ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Change configuration options for your existing 2FA application Email message template." }, { "info": { "name": "Send 2FA PIN code over SMS", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/2fa/2/pin", "params": [ { "name": "ncNeeded", "value": "true", "type": "query", "description": "Indicates if [Number Lookup](https://www.infobip.com/docs/api/connectivity/number-lookup) is needed before sending the 2FA message. If the parameter value is true, Number Lookup will be requested before sending the SMS. If the value is false, the SMS will be sent without requesting Number Lookup. Field's default value is `true`." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Send a PIN code over SMS using a previously created [message template](#channels/sms/create-2fa-message-template)." }, { "info": { "name": "Resend 2FA PIN code over SMS", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/2fa/2/pin/:pinId/resend", "params": [ { "name": "pinId", "value": "0933F3BC087D2A617AC6DCB2EF5B8A61", "type": "path", "description": "ID of the pin code that has to be verified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "If needed, you can resend the same (previously sent) PIN code over SMS." }, { "info": { "name": "Send 2FA PIN code over Voice", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/2fa/2/pin/voice", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Send a PIN code over Voice using previously created [message template](#channels/sms/create-2fa-message-template)." }, { "info": { "name": "Resend 2FA PIN code over Voice", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/2fa/2/pin/:pinId/resend/voice", "params": [ { "name": "pinId", "value": "0933F3BC087D2A617AC6DCB2EF5B8A61", "type": "path", "description": "ID of the pin code that has to be verified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "If needed, you can resend the same (previously sent) PIN code over Voice." }, { "info": { "name": "Send 2FA PIN code over Email", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/2fa/2/pin/email", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Send a PIN code over Email using previously created [Email message template](#channels/sms/2fa/2fa-configuration/create-2fa-email-message-template)." }, { "info": { "name": "Resend 2FA PIN code over Email", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/2fa/2/pin/:pinId/resend/email", "params": [ { "name": "pinId", "value": "0933F3BC087D2A617AC6DCB2EF5B8A61", "type": "path", "description": "ID of the pin code that has to be verified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "If needed, you can resend the same (previously sent) PIN code over Email." }, { "info": { "name": "Verify a PIN", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/2fa/2/pin/:pinId/verify", "params": [ { "name": "pinId", "value": "0933F3BC087D2A617AC6DCB2EF5B8A61", "type": "path", "description": "ID of the pin code that has to be verified." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Verify OTP to confirm successful phone number verification. pinId is received in the response after [sending the OTP message](#channels/sms/2fa/pin-sending-and-verification/send-2fa-pin-code-over-voice)." }, { "info": { "name": "Get 2FA verification status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/2fa/2/applications/:appId/verifications", "params": [ { "name": "msisdn", "value": "385717284759547", "type": "query", "description": "Filter by msisdn (phone number or email) for which verification status is checked." }, { "name": "verified", "value": "false", "type": "query", "description": "Filter by verified (true or false)." }, { "name": "sent", "value": "true", "type": "query", "description": "Filter by message sent status (true or false)." }, { "name": "appId", "value": "16A8B5FE2BCD6CA716A2D780CB3F3390", "type": "path", "description": "ID of 2-FA application for which phone number verification status is requested." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Check if a phone number (or email) is already verified for a specific 2FA application." }, { "info": { "name": "Get current account balance", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/account/1/balance", "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Returns the current account balance displayed in the currency configured for the account." }, { "info": { "name": "Get remaining free messages", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/account/1/free-messages", "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Returns the remaining number of free messages available for the account." }, { "info": { "name": "Get account balance with free messages", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/account/1/total-balance", "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Returns the current account balance, monthly balance, monthly and total credit limit, currency details, and the remaining count of free messages per service type." }, { "info": { "name": "Get all sub accounts with filter", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/1/accounts", "params": [ { "name": "name", "value": "", "type": "query", "description": "Account name" }, { "name": "limit", "value": "", "type": "query", "description": "Number of account in response" }, { "name": "enabled", "value": "", "type": "query", "description": "Indicates whether the account is enabled" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to get all sub accounts with custom filter" }, { "info": { "name": "Update account", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/settings/1/accounts/:accountKey", "params": [ { "name": "accountKey", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to update account. You can only update sub accounts" }, { "info": { "name": "Get API keys by filter", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/1/accounts/:accountKey/api-keys", "params": [ { "name": "accountKey", "value": "", "type": "path", "description": "Key of the main account the API key belongs to. Use the special `_` value to reference the account of the user making the API request or a standard account key such as `8F0792F86035A9F4290821F1EE6BC06A` to reference an account explicitly." }, { "name": "name", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "enabled", "value": "", "type": "query" }, { "name": "publicApiKey", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to get API keys of some account by filter forwarded" }, { "info": { "name": "Create API key", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/settings/1/accounts/:accountKey/api-keys", "params": [ { "name": "accountKey", "value": "", "type": "path", "description": "Key of the main account the API key belongs to. Use the special `_` value to reference the account of the user making the API request or a standard account key such as `8F0792F86035A9F4290821F1EE6BC06A` to reference an account explicitly." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to create an API key." }, { "info": { "name": "Get API key", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/1/accounts/:accountKey/api-keys/:key", "params": [ { "name": "accountKey", "value": "", "type": "path" }, { "name": "key", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Key of the main account the API key belongs to. Use the special _ value to reference the account of the user making the API request or a standard account key such as 8F0792F86035A9F4290821F1EE6BC06A to reference an account explicitly" }, { "info": { "name": "Update API key", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/settings/1/accounts/:accountKey/api-keys/:key", "params": [ { "name": "accountKey", "value": "", "type": "path" }, { "name": "key", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Key of the main account the API key belongs to. Use the special _ value to reference the account of the user making the API request or a standard account key such as 8F0792F86035A9F4290821F1EE6BC06A to reference an account explicitly." }, { "info": { "name": "Get API keys by filter", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/2/api-keys", "params": [ { "name": "accountId", "value": "", "type": "query", "description": "Unique identifier for account this API keys belongs to. AccountId is optional and if not provided it will default to the account making the request." }, { "name": "name", "value": "", "type": "query", "description": "Name of this API Key." }, { "name": "page", "value": "", "type": "query", "description": "Specify the API key response page you want to fetch, starting with 0. If not set, the response will contain first page. The highest allowed page value is 100." }, { "name": "size", "value": "", "type": "query", "description": "The number of API keys in one response page. If not set, the response will be limited to 100 API keys, which is also the highest allowed size." }, { "name": "orderBy", "value": "", "type": "query", "description": "The ordering parameter of API keys in the response page. If not set, the API keys in the response will be ordered by API key id." }, { "name": "orderDirection", "value": "", "type": "query", "description": "The order direction of API keys in the response page. If not set, the API keys in the response will be in the ascending order." }, { "name": "enabled", "value": "", "type": "query", "description": "Is API key enabled." }, { "name": "apiKeySecret", "value": "", "type": "query", "description": "Authentication key. Use this value for authentication on API. Keep this in secure storage and don't share it." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to fetch an API keys by filter. Only users with certain roles can fetch api keys; for example, Account Manager and Integrations Manager roles." }, { "info": { "name": "Create API key", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/settings/2/api-keys", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to create an API key. Only users with certain roles can create api keys; for example, Account Manager and Integrations Manager roles." }, { "info": { "name": "Get API key", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/2/api-keys/:apiKeyId", "params": [ { "name": "apiKeyId", "value": "", "type": "path", "description": "Unique identifier of api key to be returned." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to fetch an API key. Only users with certain roles can fetch api key; for example, Account Manager and Integrations Manager roles." }, { "info": { "name": "Update API key", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/settings/2/api-keys/:apiKeyId", "params": [ { "name": "apiKeyId", "value": "", "type": "path", "description": "Unique identifier of api key to be updated." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to update an API key. Only users with certain roles can create api keys; for example, Account Manager and Integrations Manager roles." }, { "info": { "name": "Create session token", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/auth/1/session", "body": { "type": "json", "data": "{}" } }, "docs": "This method allows you to create a session (login) which by default will expire after 60 minutes. If you want to create a new token before the session expires, you'll need to destroy it first." }, { "info": { "name": "Destroy session token", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/auth/1/session", "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to destroy the session token." }, { "info": { "name": "Create OAuth2 token", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/auth/1/oauth2/token", "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Generate OAuth2 access token that can later on be used to authenticate other Infobip API calls." }, { "info": { "name": "Export Audit Logs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/audit/1/logs/export", "params": [ { "name": "action", "value": "Create", "type": "query", "description": "User's action. If nothing is provided, logs for all actions are returned." }, { "name": "description", "value": "username", "type": "query", "description": "Description of an action. If nothing is provided, logs for all descriptions are returned." }, { "name": "from", "value": "2023-01-01T00:00:00.000Z", "type": "query", "description": "Date and time filter with the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`. If nothing is provided, there will be no lower limit filter applied on a date and time of recorded activity returned in logs." }, { "name": "item", "value": "User", "type": "query", "description": "Use it as a filter to apply to the action field to narrow down the logs returned. if nothing is provided, logs with all items are returned." }, { "name": "ipAddress", "value": "127.0.0.1", "type": "query", "description": "User's IP address. If nothing is provided, logs for all IP addresses are returned." }, { "name": "limit", "value": "10000", "type": "query", "description": "Max number of user activities returned in logs. Accepts values from `1` to `10000`. Defaults to `10000`." }, { "name": "to", "value": "2023-01-03T00:00:00.000Z", "type": "query", "description": "Date and time filter with the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`. If nothing is provided, there will be no upper limit filter applied on a date and time of recorded user activity returned in logs." }, { "name": "userKey", "value": "JD1I2JD9JD3DDHHGKCNN1PK2O1", "type": "query", "description": "User's key can be found on the user's profile page at the Infobip portal. If nothing is provided, the logs for all user keys are returned." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to search and export users' activities on the web interface." }, { "info": { "name": "Search Audit Logs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/audit/1/logs", "params": [ { "name": "action", "value": "Create", "type": "query", "description": "User's action. If nothing is provided, logs for all actions are returned." }, { "name": "description", "value": "username", "type": "query", "description": "Description of an action. If nothing is provided, logs for all descriptions are returned." }, { "name": "from", "value": "2023-01-01T00:00:00.000Z", "type": "query", "description": "Date and time filter with the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`. If nothing is provided, there will be no lower limit filter applied on a date and time of recorded activity returned in logs." }, { "name": "item", "value": "User", "type": "query", "description": "Use it as a filter to apply to the action field to narrow down the logs returned. if nothing is provided, logs with all items are returned." }, { "name": "ipAddress", "value": "127.0.0.1", "type": "query", "description": "User's IP address. If nothing is provided, logs for all IP addresses are returned." }, { "name": "limit", "value": "10000", "type": "query", "description": "Max number of user activities returned in logs. Accepts values from `1` to `10000`. Defaults to `10000`." }, { "name": "to", "value": "2023-01-03T00:00:00.000Z", "type": "query", "description": "Date and time filter with the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`. If nothing is provided, there will be no upper limit filter applied on a date and time of recorded user activity returned in logs." }, { "name": "userKey", "value": "JD1I2JD9JD3DDHHGKCNN1PK2O1", "type": "query", "description": "User's key can be found on the user's profile page at the Infobip portal. If nothing is provided, the logs for all user keys are returned." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to track and search through users' activities on the web interface." }, { "info": { "name": "Get applications", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/provisioning/1/applications", "params": [ { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get a paginated list of applications." }, { "info": { "name": "Create application", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/provisioning/1/applications", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create an application associated with the specified `applicationId`." }, { "info": { "name": "Get application", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/provisioning/1/applications/:applicationId", "params": [ { "name": "applicationId", "value": "test-application", "type": "path", "description": "The unique identifier of the application. This ID will be a URL path parameter. We recommend using values that do not need URL encoding for easier interaction with other API endpoints." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get an application for the specified `applicationId`." }, { "info": { "name": "Modify application", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/provisioning/1/applications/:applicationId", "params": [ { "name": "applicationId", "value": "test-application", "type": "path", "description": "The unique identifier of the application. This ID will be a URL path parameter. We recommend using values that do not need URL encoding for easier interaction with other API endpoints." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Modify a resource `name` property." }, { "info": { "name": "Delete application", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/provisioning/1/applications/:applicationId", "params": [ { "name": "applicationId", "value": "test-application", "type": "path", "description": "The unique identifier of the application. This ID will be a URL path parameter. We recommend using values that do not need URL encoding for easier interaction with other API endpoints." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete an application associated with the specified `applicationId`.
    Deleting an application will reset all resources that were linked to that application to application = default and entity = null. You should ensure that any configuration (like resource associations, inbound message configurations, subscriptions, bots, API Keys etc) related to given application are appropriately reassigned to other applications before attempting to delete the application." }, { "info": { "name": "Get entities", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/provisioning/1/entities", "params": [ { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get a paginated list of entities." }, { "info": { "name": "Create entity", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/provisioning/1/entities", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create an entity associated with the specified `entityId`.
    An entity attached to a submitted message will get auto created if it doesn't exit yet. It will get the entityId and entityName being the value passed on a message. " }, { "info": { "name": "Get entity", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/provisioning/1/entities/:entityId", "params": [ { "name": "entityId", "value": "test-entity", "type": "path", "description": "The unique identifier of the entity. This ID will be a URL path parameter. We recommend using values that do not need URL encoding for easier interaction with other API endpoints." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get an entity for the specified `entityId`." }, { "info": { "name": "Modify entity", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/provisioning/1/entities/:entityId", "params": [ { "name": "entityId", "value": "test-entity", "type": "path", "description": "The unique identifier of the entity. This ID will be a URL path parameter. We recommend using values that do not need URL encoding for easier interaction with other API endpoints." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Modify a resource `name` property." }, { "info": { "name": "Delete entity", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/provisioning/1/entities/:entityId", "params": [ { "name": "entityId", "value": "test-entity", "type": "path", "description": "The unique identifier of the entity. This ID will be a URL path parameter. We recommend using values that do not need URL encoding for easier interaction with other API endpoints." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete an entity associated with the specified `entityId`.
    Deleting an entity will reset all resources that were linked to that entity to application = default and entity = null. You should ensure that any configuration (like resource associations, inbound message configurations, subscriptions, bots, API Keys etc) related to given entity are appropriately reassigned to other entities before attempting to delete the entity." }, { "info": { "name": "Get resource associations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/provisioning/1/associations", "params": [ { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." }, { "name": "resourceType", "value": "", "type": "query", "description": "The type of resource to be used." }, { "name": "channel", "value": "", "type": "query", "description": "The channel for which the resource will be used." }, { "name": "applicationId", "value": "test-application", "type": "query", "description": "The unique identifier of the application. This ID will be a URL path parameter. We recommend using values that do not need URL encoding for easier interaction with other API endpoints." }, { "name": "entityId", "value": "test-entity", "type": "query", "description": "The unique identifier of the entity. This ID will be a URL path parameter. We recommend using values that do not need URL encoding for easier interaction with other API endpoints." }, { "name": "resourceId", "value": "test-resource", "type": "query", "description": "The unique identifier of the resource. It depends on both the `resourceType` and `channel`.
    Use [numberKey](https://www.infobip.com/docs/api/platform-connectivity/numbers/phone-numbers/list-purchased-numbers) for the NUMBER `resourceType`.
    Use [domainName](https://www.infobip.com/docs/api/channels/email/get-all-domains) for the DOMAIN `resourceType`, which is available only for the Email channel." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get a paginated list of resource associations." }, { "info": { "name": "Create resource association", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/provisioning/1/associations", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create a resource association." }, { "info": { "name": "Delete resource association", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/provisioning/1/associations", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete a resource association." }, { "info": { "name": "Get resource association", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/provisioning/1/associations/single", "params": [ { "name": "resourceType", "value": "", "type": "query", "description": "The type of resource to be used." }, { "name": "channel", "value": "", "type": "query", "description": "The channel for which the resource will be used." }, { "name": "applicationId", "value": "test-application", "type": "query", "description": "The unique identifier of the application. This ID will be a URL path parameter. We recommend using values that do not need URL encoding for easier interaction with other API endpoints." }, { "name": "entityId", "value": "test-entity", "type": "query", "description": "The unique identifier of the entity. This ID will be a URL path parameter. We recommend using values that do not need URL encoding for easier interaction with other API endpoints. If no entity is associated with this resource, set the entityId to `null`." }, { "name": "resourceId", "value": "test-resource", "type": "query", "description": "The unique identifier of the resource. It depends on both the `resourceType` and `channel`.
    Use [numberKey](https://www.infobip.com/docs/api/platform-connectivity/numbers/phone-numbers/list-purchased-numbers) for the NUMBER `resourceType`.
    Use [domainName](https://www.infobip.com/docs/api/channels/email/get-all-domains) for the DOMAIN `resourceType`, which is available only for the Email channel." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get an exact resource association." }, { "info": { "name": "Get available numbers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/numbers/1/numbers/available", "params": [ { "name": "capabilities", "value": "", "type": "query", "description": "An array of communication channels the number is able to support." }, { "name": "country", "value": "", "type": "query", "description": "The number's country code." }, { "name": "state", "value": "", "type": "query", "description": "US Numbers only: US state" }, { "name": "npa", "value": "", "type": "query", "description": "US numbers only: area code." }, { "name": "nxx", "value": "", "type": "query", "description": "US numbers only: the 3 digits following the area code." }, { "name": "limit", "value": "", "type": "query", "description": "Number of records returned per page." }, { "name": "number", "value": "", "type": "query", "description": "Searched number." }, { "name": "page", "value": "", "type": "query", "description": "Page number. Use it with `limit` for paging purposes." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to get all the numbers available to buy. Use the query parameters to filter the returned numbers for specific details." }, { "info": { "name": "List owned numbers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/numbers/1/numbers", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Number of records returned per page." }, { "name": "number", "value": "", "type": "query", "description": "Searched number." }, { "name": "page", "value": "", "type": "query", "description": "Page number. Use with `limit` for paging purposes." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to get all the owned numbers for this account." }, { "info": { "name": "Purchase number", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/numbers/1/numbers", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Using the number ID or number, this method enables you to buy a new number. For buying a US number, only the number should be provided. For all other purchases, only the numberKey must be provided." }, { "info": { "name": "Get single owned number", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/numbers/1/numbers/:numberKey", "params": [ { "name": "numberKey", "value": "", "type": "path", "description": "The unique ID of the number for which information is requested." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get information about an owned number using the unique ID of the number." }, { "info": { "name": "Update owned number", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/numbers/1/numbers/:numberKey", "params": [ { "name": "numberKey", "value": "", "type": "path", "description": "Unique ID of a number." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to update the application and the entity, if required, that is linked to a number." }, { "info": { "name": "Cancel number", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/numbers/1/numbers/:numberKey", "params": [ { "name": "numberKey", "value": "", "type": "path", "description": "Unique ID of a number." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method will cancel your number. Any number purchased from Infobip Numbers inventory you cancel will become available in the numbers pool for anyone to buy." }, { "info": { "name": "Get all number configurations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/numbers/2/numbers/:numberKey/sms", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Number of records returned per page." }, { "name": "numberKey", "value": "", "type": "path", "description": "Unique ID of a number." }, { "name": "page", "value": "", "type": "query", "description": "Page number. Use with `limit` for paging purposes." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "List all configurations set up for a number." }, { "info": { "name": "Create number configuration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/numbers/2/numbers/:numberKey/sms", "params": [ { "name": "numberKey", "value": "", "type": "path", "description": "Unique ID of a number." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create a new configuration for the number. The parameters used for setting up a configuration depend on the action type. Check the examples for more details." }, { "info": { "name": "Update number configuration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/numbers/2/numbers/:numberKey/sms", "params": [ { "name": "numberKey", "value": "", "type": "path", "description": "Unique ID of a number." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update configuration details. Parameters used vary depending on the action type, the same as with the Create a new configuration method." }, { "info": { "name": "Get single number configuration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/numbers/2/numbers/:numberKey/sms/:configurationKey", "params": [ { "name": "configurationKey", "value": "", "type": "path", "description": "Unique ID of configuration." }, { "name": "numberKey", "value": "", "type": "path", "description": "Unique ID of a number." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method fetches a single configuration details set up for the number." }, { "info": { "name": "Delete number configuration", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/numbers/2/numbers/:numberKey/sms/:configurationKey", "params": [ { "name": "configurationKey", "value": "", "type": "path", "description": "Unique ID of configuration." }, { "name": "numberKey", "value": "", "type": "path", "description": "Unique ID of a number." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method will delete the configuration. If there are no configurations, you can still retrieve any incoming message by using a Get received messages method." }, { "info": { "name": "Get all number MMS configurations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/numbers/2/numbers/:numberKey/mms", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Number of records returned per page." }, { "name": "numberKey", "value": "", "type": "path", "description": "Unique ID of a number." }, { "name": "page", "value": "", "type": "query", "description": "Page number. Use with `limit` for paging purposes." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "List all MMS configurations set up for a number." }, { "info": { "name": "Create number MMS configuration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/numbers/2/numbers/:numberKey/mms", "params": [ { "name": "numberKey", "value": "", "type": "path", "description": "Unique ID of a number." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create a new MMS configuration for the number. The parameters used for setting up a configuration depend on the action type. Check the examples for more details." }, { "info": { "name": "Get number MMS configuration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/numbers/2/numbers/:numberKey/mms/:configurationKey", "params": [ { "name": "configurationKey", "value": "", "type": "path", "description": "Unique ID of configuration." }, { "name": "numberKey", "value": "", "type": "path", "description": "Unique ID of a number." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method fetches a single MMS configuration details set up for the number." }, { "info": { "name": "Update number MMS configuration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/numbers/2/numbers/:numberKey/mms/:configurationKey", "params": [ { "name": "numberKey", "value": "", "type": "path", "description": "Unique ID of a number." }, { "name": "configurationKey", "value": "", "type": "path", "description": "Unique ID of configuration." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update MMS configuration details. Parameters used vary depending on the action type, the same as with the Create a new MMS configuration method." }, { "info": { "name": "Delete number MMS configuration", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/numbers/2/numbers/:numberKey/mms/:configurationKey", "params": [ { "name": "configurationKey", "value": "", "type": "path", "description": "Unique ID of configuration." }, { "name": "numberKey", "value": "", "type": "path", "description": "Unique ID of a number." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method will delete MMS configuration. If there are no configurations, you can still retrieve any incoming message by using a Get received messages method." }, { "info": { "name": "Get voice setup on number", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/numbers/2/numbers/:numberKey/voice", "params": [ { "name": "numberKey", "value": "", "type": "path", "description": "Unique ID of a number." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method fetches the voice setup on a number." }, { "info": { "name": "Create voice setup on number", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/numbers/2/numbers/:numberKey/voice", "params": [ { "name": "numberKey", "value": "", "type": "path", "description": "Unique ID of a number." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method will create a new voice setup on a number. There can be only one voice action set for the number." }, { "info": { "name": "Update voice setup on number", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/numbers/2/numbers/:numberKey/voice", "params": [ { "name": "numberKey", "value": "", "type": "path", "description": "Unique ID of a number." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method updates voice setup previously created on a number." }, { "info": { "name": "Delete voice setup on number", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/numbers/2/numbers/:numberKey/voice", "params": [ { "name": "numberKey", "value": "", "type": "path", "description": "Unique ID of a number." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method removes voice setup from a number." }, { "info": { "name": "Get CNAM", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/numbers/2/numbers/:numberKey/voice/cnam", "params": [ { "name": "numberKey", "value": "E9FCDCA496035F08EEA5933702EDF745", "type": "path", "description": "Unique ID of a number." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get CNAM configuration." }, { "info": { "name": "Create CNAM", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/numbers/2/numbers/:numberKey/voice/cnam", "params": [ { "name": "numberKey", "value": "E9FCDCA496035F08EEA5933702EDF745", "type": "path", "description": "Unique ID of a number." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create CNAM configuration.\n\nThis is currently available only for United States and Canada numbers.\n" }, { "info": { "name": "Update CNAM", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/numbers/2/numbers/:numberKey/voice/cnam", "params": [ { "name": "numberKey", "value": "E9FCDCA496035F08EEA5933702EDF745", "type": "path", "description": "Unique ID of a number." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update a CNAM configuration." }, { "info": { "name": "Delete CNAM", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/numbers/2/numbers/:numberKey/voice/cnam", "params": [ { "name": "numberKey", "value": "E9FCDCA496035F08EEA5933702EDF745", "type": "path", "description": "Unique ID of a number." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete CNAM configuration." }, { "info": { "name": "Get CNAM status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/numbers/2/numbers/:numberKey/voice/cnam/status", "params": [ { "name": "numberKey", "value": "E9FCDCA496035F08EEA5933702EDF745", "type": "path", "description": "Unique ID of a number." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get a CNAM configuration status." }, { "info": { "name": "Validate Emergency Service Address", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/numbers/2/numbers/:numberKey/voice/emergency-service/validate-address", "params": [ { "name": "numberKey", "value": "E9FCDCA496035F08EEA5933702EDF745", "type": "path", "description": "Unique ID of a number." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Validate a Emergency Service Address" }, { "info": { "name": "Get Emergency Service Address", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/numbers/2/numbers/:numberKey/voice/emergency-service", "params": [ { "name": "numberKey", "value": "E9FCDCA496035F08EEA5933702EDF745", "type": "path", "description": "Unique ID of a number." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get a Emergency Service Address" }, { "info": { "name": "Create Emergency Service Address", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/numbers/2/numbers/:numberKey/voice/emergency-service", "params": [ { "name": "numberKey", "value": "E9FCDCA496035F08EEA5933702EDF745", "type": "path", "description": "Unique ID of a number." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create Emergency Service Address\n\nEmergency Service Address allows you to set any physical address in the United States as your address to be transmitted on emergency number calls.\nThis means your calls to the emergency number will route to the closest PSAP (Public Safety Answering Point) to your registered address on our system. \n\nThat address will also appear on the emergency services operator’s screen when you call.\n" }, { "info": { "name": "Update Emergency Service Address", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/numbers/2/numbers/:numberKey/voice/emergency-service", "params": [ { "name": "numberKey", "value": "E9FCDCA496035F08EEA5933702EDF745", "type": "path", "description": "Unique ID of a number." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update a Emergency Service Address" }, { "info": { "name": "Delete Emergency Service Address", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/numbers/2/numbers/:numberKey/voice/emergency-service", "params": [ { "name": "numberKey", "value": "E9FCDCA496035F08EEA5933702EDF745", "type": "path", "description": "Unique ID of a number." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete a Emergency Service Address" }, { "info": { "name": "Get Emergency Service Address status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/numbers/2/numbers/:numberKey/voice/emergency-service/status", "params": [ { "name": "numberKey", "value": "E9FCDCA496035F08EEA5933702EDF745", "type": "path", "description": "Unique ID of a number." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get a Emergency Service Address status." }, { "info": { "name": "Get Brands", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/number-registration/1/brands", "params": [ { "name": "id", "value": "", "type": "query", "description": "Filters brands to those that match the supplied ID(s)." }, { "name": "type", "value": "", "type": "query", "description": "Filters brands to those that match the supplied brand types(s)." }, { "name": "nameLike", "value": "", "type": "query", "description": "Filters brands to those whose names contain the supplied name." }, { "name": "referenceId", "value": "", "type": "query", "description": "Filters brands to those that match the supplied referenceId(s)." }, { "name": "applicationId", "value": "", "type": "query", "description": "Filters brands to those whose application ID contains the supplied value." }, { "name": "entityId", "value": "", "type": "query", "description": "Filters brands to those whose entity ID contains the supplied value." }, { "name": "page", "value": "", "type": "query", "description": "Results page you want to retrieve (0..N). The default value is 0." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page (0..2000). The default value is 20. The maximum value is 2000." }, { "name": "sort", "value": "createdDate,desc", "type": "query", "description": "Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Sortable Properties: 'id', 'name', 'type', 'createdDate', 'lastModifiedDate'." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get a page of brands, using query parameters to filter results." }, { "info": { "name": "Create Brand", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/number-registration/1/brands", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Creates a brand within the Infobip platform. This operation does not register the brand with any registrars. Registration can be done using created brand's ID with the 'Register Brand' endpoint." }, { "info": { "name": "Get Brand", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/number-registration/1/brands/:brandId", "params": [ { "name": "brandId", "value": "", "type": "path", "description": "The ID of the desired brand." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Retrieves a previously created brand by its ID." }, { "info": { "name": "Update Brand", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/number-registration/1/brands/:brandId", "params": [ { "name": "brandId", "value": "", "type": "path", "description": "The ID of the desired brand." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Updates a brand that has not yet been registered within the Infobip platform (response 200) or that has a successful or failed registration\n(response 202). This method will not support a brand update with pending registration status and will return a 400 Bad Request.\nAlso for successfully registered brands, updates to the legalName, type, taxId, and taxIdIssuingCountry are restricted\nand will also return a 400 Bad Request." }, { "info": { "name": "Delete Brand", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/number-registration/1/brands/:brandId", "params": [ { "name": "brandId", "value": "", "type": "path", "description": "The ID of the brand to delete." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Removes a previously created brand by its ID.\nThis operation is only supported if all associated campaigns are in a stage that allows deletion (applies to vetted and non-vetted brands).\n" }, { "info": { "name": "Register Brand", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/number-registration/1/brands/:brandId/register", "params": [ { "name": "brandId", "value": "", "type": "path", "description": "The ID of the desired brand." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Registers the brand with the given ID with all available registrars. Each registered brand incurs a cost, consult your contract for pricing details.\nWhen registering brands of type TENDLC_PUBLIC_COMPANY brands, brand authentication+ verification are automatically triggered.\nThis is only available for 10DLC Brands" }, { "info": { "name": "Get Brand Registrar Statuses", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/number-registration/1/brands/:brandId/registrar-statuses", "params": [ { "name": "brandId", "value": "", "type": "path", "description": "The ID of the desired brand." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Retrieves status of a registered brand for each registrar." }, { "info": { "name": "Request Brand Authentication+ Verification", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/number-registration/1/brands/:brandId/brand-auth-verification", "params": [ { "name": "brandId", "value": "", "type": "path", "description": "The ID of the desired brand." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Request brand authentication+ verification to finalize brand registration process.\nThis operation can be executed for TENDLC_PUBLIC_COMPANY brand type only when Brand authentication is not in progress." }, { "info": { "name": "Resend 2FA Email For Brand Authentication", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/number-registration/1/brands/:brandId/resend2fa", "params": [ { "name": "brandId", "value": "", "type": "path", "description": "The ID of the desired brand." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Resend 2FA email to proceed with Brand authentication.\nThis operation can be executed for TENDLC_PUBLIC_COMPANY brand type only when Brand authentication is in progress.\nIn 2 hour time window can resend only one 2FA email." }, { "info": { "name": "Submit Brand Identity Appeal", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/number-registration/1/brands/:brandId/appeal", "params": [ { "name": "brandId", "value": "", "type": "path", "description": "The ID of the desired brand." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Submit an appeal for a 10DLC brand with REJECTED registration status.\nAppeal can be submitted inside 45 calendar days after rejection happen.\nOnly one pending appeal per brand is allowed at a time.\nCharges apply only if the appeal is processed by TCR. Appeals rejected internally are not charged and can be resubmitted." }, { "info": { "name": "Get Brand Appeals", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/number-registration/1/brands/:brandId/appeals", "params": [ { "name": "brandId", "value": "", "type": "path", "description": "The ID of the desired brand." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Retrieves the list of all appeals submitted for the specified brand." }, { "info": { "name": "Get Brand Vets", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/number-registration/1/brands/:brandId/vets", "params": [ { "name": "brandId", "value": "", "type": "path", "description": "The ID of the desired brand." }, { "name": "page", "value": "", "type": "query", "description": "Results page you want to retrieve (0..N). The default value is 0." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page (0..2000). The default value is 20. The maximum value is 2000." }, { "name": "sort", "value": "vettedDate,desc", "type": "query", "description": "Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Sortable Properties: 'vetId', 'type', 'vettedDate', 'enhancedVettedDate'." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Retrieves all vets done for the brand with the given ID." }, { "info": { "name": "Vet Brand", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/number-registration/1/brands/:brandId/vets", "params": [ { "name": "brandId", "value": "", "type": "path", "description": "The ID of the desired brand." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Vets the brand with the given ID. Vetting a brand may only be performed once every 30 days.\nCan be created as vet type standard or enhanced.\nEach vet of a brand incurs a cost, consult your contract for pricing information." }, { "info": { "name": "Get Brand Vet", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/number-registration/1/brands/:brandId/vets/:vetId", "params": [ { "name": "brandId", "value": "", "type": "path", "description": "The ID of the desired brand." }, { "name": "vetId", "value": "", "type": "path", "description": "The ID of the desired vet." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Retrieves brand vet done for the brand with the given ID." }, { "info": { "name": "Update Brand Vet", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/number-registration/1/brands/:brandId/vets/:vetId", "params": [ { "name": "brandId", "value": "", "type": "path", "description": "The ID of the desired brand." }, { "name": "vetId", "value": "", "type": "path", "description": "The ID of the brand active vet." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Updates a brand vetting type.\nProvided vet must be current active standard vet and it may only be updated to an enhanced vet if it was performed within the last 30 days.\nAll other attempts to update a vet are considered an error." }, { "info": { "name": "Import Existing Brand Vet", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/number-registration/1/brands/:brandId/vets/import", "params": [ { "name": "brandId", "value": "", "type": "path", "description": "The ID of the desired brand." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Imports Existing Brand Vet provider" }, { "info": { "name": "Get Brand Enhanced Vet Report", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/number-registration/1/brands/:brandId/vets/:vetId/report", "params": [ { "name": "brandId", "value": "", "type": "path", "description": "The ID of the desired brand." }, { "name": "vetId", "value": "", "type": "path", "description": "The ID of the desired vet." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Retrieves brand enhanced vet report by given vetId." }, { "info": { "name": "Get Campaigns", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/number-registration/1/campaigns", "params": [ { "name": "id", "value": "", "type": "query", "description": "Filters campaigns to those that match the supplied ID(s)." }, { "name": "brandId", "value": "", "type": "query", "description": "Filters campaigns to those that match the supplied brand ID(s)." }, { "name": "type", "value": "", "type": "query", "description": "Filters campaigns to those that match the supplied campaign type(s)." }, { "name": "nameLike", "value": "", "type": "query", "description": "Filters campaigns to those whose names contain the supplied name." }, { "name": "referenceId", "value": "", "type": "query", "description": "Filters campaigns to those that match the supplied referenceId(s)." }, { "name": "applicationId", "value": "", "type": "query", "description": "Filters campaigns to those whose application ID contains the supplied value." }, { "name": "entityId", "value": "", "type": "query", "description": "Filters campaigns to those whose entity ID contains the supplied value." }, { "name": "stage", "value": "", "type": "query", "description": "Filters campaigns to those that match the campaign stage(s)." }, { "name": "number", "value": "", "type": "query", "description": "Filters campaigns to those that match the number(s)." }, { "name": "page", "value": "", "type": "query", "description": "Results page you want to retrieve (0..N). The default value is 0." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page (0..2000). The default value is 20. The maximum value is 2000." }, { "name": "sort", "value": "createdDate,desc", "type": "query", "description": "Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Sortable Properties: 'id', 'name', 'type', 'createdDate', 'lastModifiedDate'." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets a page of campaigns, using query parameters to filter results." }, { "info": { "name": "Create Campaign", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/number-registration/1/campaigns", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Creates a campaign within the Infobip platform. This operation does not register the campaign with any networks. Registration can be done using created campaign's ID with the 'Register Campaign' endpoint." }, { "info": { "name": "Create Toll Free Campaign", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/number-registration/1/campaigns/toll-free", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Creates a toll free campaign within the Infobip platform." }, { "info": { "name": "Get Campaign", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/number-registration/1/campaigns/:campaignId", "params": [ { "name": "campaignId", "value": "", "type": "path", "description": "The ID of the desired campaign." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Retrieves a previously created campaign by its ID." }, { "info": { "name": "Update Campaign", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/number-registration/1/campaigns/:campaignId", "params": [ { "name": "campaignId", "value": "", "type": "path", "description": "The ID of the desired campaign." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Updates a campaign that has not yet been registered within the Infobip platform or has been rejected by Infobip. This operation is only supported for campaigns that are in DRAFT or REJECTED stage." }, { "info": { "name": "Delete Campaign", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/number-registration/1/campaigns/:campaignId", "params": [ { "name": "campaignId", "value": "", "type": "path", "description": "The ID of the campaign to delete." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Removes a previously created campaign by its ID.\nThis operation is only supported for campaigns that are in DRAFT, DEREGISTERED or REJECTED stage.\n" }, { "info": { "name": "Submit Campaign", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/number-registration/1/campaigns/:campaignId/register", "params": [ { "name": "campaignId", "value": "", "type": "path", "description": "The ID of the desired campaign." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Submits the campaign with the given ID for Infobip review. If a campaign gets approved by Infobip, it will get registered with carriers, and submitted for underlying connectivity provider's review. Each registered campaign incurs a cost, consult your contract for pricing information." }, { "info": { "name": "Get Campaign Network Statuses", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/number-registration/1/campaigns/:campaignId/network-statuses", "params": [ { "name": "campaignId", "value": "", "type": "path", "description": "The ID of the desired campaign." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Retrieves status of a registered campaign for each network." }, { "info": { "name": "Deregister Campaign", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/number-registration/1/campaigns/:campaignId/deregister", "params": [ { "name": "campaignId", "value": "", "type": "path", "description": "The ID of the desired campaign." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Deregisters the campaign with the given ID with all available networks." }, { "info": { "name": "Update Registered Campaign", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/number-registration/1/campaigns/:campaignId/update-registration", "params": [ { "name": "campaignId", "value": "", "type": "path", "description": "The ID of the desired campaign." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Updates a campaign that has already been registered. If the campaign registration has not been completed, attempting to update via this api will result in a 400 Bad Request. Numbers which require OSR to be updated in advance could be identified by using Numbers API's \"List owned number\" GET endpoint." }, { "info": { "name": "Add Numbers to Registered Campaign", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/number-registration/1/campaigns/:campaignId/add-numbers", "params": [ { "name": "campaignId", "value": "", "type": "path", "description": "The ID of the desired campaign." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Adds numbers to campaign that has already been registered. If the campaign registration has not been completed or numbers size exceeds the limit, attempting to update via this api will result in a 400 Bad Request. Numbers which require OSR to be updated in advance could be identified by using Numbers API's \"List owned number\" GET endpoint." }, { "info": { "name": "Remove Numbers from Registered Campaign", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/number-registration/1/campaigns/:campaignId/remove-numbers", "params": [ { "name": "campaignId", "value": "", "type": "path", "description": "The ID of the desired campaign." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Removes numbers from campaign that has already been registered. If the campaign registration has not been completed or numbers size exceeds the limit, attempting to update via this api will result in a 400 Bad Request." }, { "info": { "name": "Get Campaign numbers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/number-registration/1/campaigns/:campaignId/numbers", "params": [ { "name": "campaignId", "value": "", "type": "path", "description": "The ID of the campaign for which the numbers should be fetched." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Retrieves all the numbers associated with a campaign, regardless of the stage, by its ID." }, { "info": { "name": "Appeal Campaign", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/number-registration/1/campaigns/:campaignId/appeal", "params": [ { "name": "campaignId", "value": "", "type": "path", "description": "The ID of the desired campaign." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Appeals a rejected 10DLC campaign within the Infobip platform. Campaigns are eligible for appeal if they were rejected within the past 3 months and can be appealed up to five times." }, { "info": { "name": "Get Campaign Priorities", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/number-registration/1/campaigns/priorities", "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Retrieves campaign priority levels for your account(if applicable). Please contact your account manager to learn more about priorities." }, { "info": { "name": "Attach Number Pool to Campaign", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/number-registration/1/campaigns/:campaignId/number-pool/attach", "params": [ { "name": "campaignId", "value": "", "type": "path", "description": "The ID of the desired campaign." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Associates an existing number pool with a campaign. Number pooling is required when a campaign utilizes more than 49 numbers. This is common in high-throughput environments such as call centers. Attaching a number pool ensures proper provisioning and compliance with carrier requirements." }, { "info": { "name": "Detach Number Pool from Campaign", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/number-registration/1/campaigns/:campaignId/number-pool/detach", "params": [ { "name": "campaignId", "value": "", "type": "path", "description": "The ID of the desired campaign." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Detaches an existing number pool from the specified campaign. This operation is subject to validation: the campaign must have fewer than 50 assigned numbers at the time of detachment." }, { "info": { "name": "Get Owned Number Pools", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/number-registration/1/number-pools", "params": [ { "name": "availability", "value": "", "type": "query", "description": "Filters number pools to those that match the supplied availability." }, { "name": "registrarRecordId", "value": "", "type": "query", "description": "Filters number pools to those that match the supplied referenceId." }, { "name": "page", "value": "", "type": "query", "description": "Results page you want to retrieve (0..N). The default value is 0." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page (0..2000). The default value is 10. The maximum value is 1000." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Returns a paginated list of number pools owned by the authenticated account." }, { "info": { "name": "Upload Document", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/number-registration/1/documents", "body": { "type": "multipart-form", "data": [] }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Uploads a document file to the system and returns the document metadata. The uploaded document can be used for 10DLC campaign registration purposes. Documents not attached to a campaign within 7 days will be automatically deleted. Supported file types: .bmp, .dib, .docx, .gif, .htm, .html, .jpeg, .jpg, .m2a, .m4a, .m4b, .m4p, .m4r, .m4v, .mp1, .mp2, .mp3, .mp4, .mpa, .oga, .ogg, .ogm, .ogv, .ogx, .odt, .pdf, .png, .raw, .rtf, .spx, .tif, .tiff, .txt, .wav, .webm, .xml, Maximum file size: 10MB." }, { "info": { "name": "Download Document", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/number-registration/1/documents/:documentId", "params": [ { "name": "documentId", "value": "", "type": "path", "description": "Unique identifier for the document." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Downloads a document file by its unique identifier. Access to the document is restricted based on account ownership." }, { "info": { "name": "Submit Existing Campaign for AI Review", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/number-registration/1/automatic-review/campaigns/:campaignUuid", "params": [ { "name": "campaignUuid", "value": "4d3601ed-c632-4979-ae22-43854ef4ffaf", "type": "path", "description": "The UUID assigned to the campaign when it was created or imported into the infobip platform. This identifier is returned during campaign creation." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Submits an existing campaign for automatic AI compliance review. Returns a request UUID that can be used to fetch the review results. Contact your account manager to learn more." }, { "info": { "name": "Submit Campaign Info for AI Review", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/number-registration/1/automatic-review", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Submits new campaign information for automatic AI compliance review. Returns a request UUID that can be used to fetch the review results. Contact your account manager to learn more." }, { "info": { "name": "Get AI Review Results", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/number-registration/1/automatic-review/:requestUuid", "params": [ { "name": "requestUuid", "value": "", "type": "path", "description": "The UUID of the AI review request." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Retrieves the results of a campaign AI compliance review by its request UUID. Contact your account manager to learn more." }, { "info": { "name": "Start Campaign Builder", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/number-registration/1/campaign-builder", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Submits a request to build a campaign based on the provided brand and campaign information.\nReturns a request UUID that can be used to track the job status." }, { "info": { "name": "Get Campaign Builder Results", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/number-registration/1/campaign-builder/:requestUuid", "params": [ { "name": "requestUuid", "value": "", "type": "path", "description": "The UUID of the campaign builder request." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Retrieves the results of a campaign builder by its request UUID.\nThe result structure varies based on the campaign type used when starting the builder." }, { "info": { "name": "Get subscriptions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/1/subscription/:channel", "params": [ { "name": "channel", "value": "", "type": "path", "description": "Channel name. A separate subscription is needed for each channel." }, { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." }, { "name": "applicationId", "value": "", "type": "query", "description": "CPaaS-X application identifier." }, { "name": "entityId", "value": "", "type": "query", "description": "CPaaS-X entity identifier." }, { "name": "callsConfigurationId", "value": "", "type": "query", "description": "Calls configuration identifier." }, { "name": "resource", "value": "", "type": "query", "description": "Resource." }, { "name": "user", "value": "", "type": "query", "description": "User." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Returns a list of all subscriptions for the specified channel with pagination. By default, the result is sorted by creation date in descending order.
    The search can be used with various criteria passed via query parameters (all criteria combinations have AND semantic).
    Note.To avoid validation errors and inconsistent results query parameters need to be encoded (see RFC 3986, section 2.1).
    Example. Find subscriptions ha" }, { "info": { "name": "Create subscription", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/subscriptions/1/subscription/:channel", "params": [ { "name": "channel", "value": "", "type": "path", "description": "Channel name. A separate subscription is needed for each channel." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method will create a new subscription. You can provide an ID of an existing profile, or submit a full definition of a profile and security settings if you want to create new ones." }, { "info": { "name": "Get single subscription", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/1/subscription/:channel/:subscriptionId", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "ID of the subscription you want to get." }, { "name": "channel", "value": "", "type": "path", "description": "Channel name. A separate subscription is needed for each channel." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Returns a specific subscription by ID." }, { "info": { "name": "Update subscription", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/subscriptions/1/subscription/:channel/:subscriptionId", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "ID of the subscription you want to modify." }, { "name": "channel", "value": "", "type": "path", "description": "Channel name. A separate subscription is needed for each channel." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to update the subscription. You can change its properties and provide an ID of a profile if you wish to change it." }, { "info": { "name": "Delete subscription", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/subscriptions/1/subscription/:channel/:subscriptionId", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "ID of the subscription you want to delete." }, { "name": "channel", "value": "", "type": "path", "description": "Channel name. A separate subscription is needed for each channel." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method will delete the subscription specified by ID." }, { "info": { "name": "Get notification profiles", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/1/profiles", "params": [ { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Returns a list of all notification profiles for your account with pagination." }, { "info": { "name": "Create notification profile", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/subscriptions/1/profiles", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method will create a new notification profile. You can provide an ID of existing security settings if you wish to reuse them or submit full definition, if you want to create a new one." }, { "info": { "name": "Get single notification profile", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/1/profiles/:profileId", "params": [ { "name": "profileId", "value": "", "type": "path", "description": "Notification profile ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Returns a specific notification profile by ID." }, { "info": { "name": "Update notification profile", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/subscriptions/1/profiles/:profileId", "params": [ { "name": "profileId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to update a notification profile. You can change its properties and provide an ID of security settings if you wish to change them." }, { "info": { "name": "Delete notification profile", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/subscriptions/1/profiles/:profileId", "params": [ { "name": "profileId", "value": "", "type": "path", "description": "Notification profile ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method will delete a notification profile specified by ID." }, { "info": { "name": "Get security settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/1/security", "params": [ { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Returns a list of security settings for your account with pagination." }, { "info": { "name": "Create security settings", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/subscriptions/1/security", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method will create new security settings." }, { "info": { "name": "Get single security settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/1/security/:authId", "params": [ { "name": "authId", "value": "", "type": "path", "description": "Security settings ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Returns specific security settings item by ID." }, { "info": { "name": "Update security settings", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/subscriptions/1/security/:authId", "params": [ { "name": "authId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to update the security settings." }, { "info": { "name": "Delete security settings", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/subscriptions/1/security/:authId", "params": [ { "name": "authId", "value": "", "type": "path", "description": "Security settings ID." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method will delete the security settings item by ID." }, { "info": { "name": "Get filtered certificate details page", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/1/certificates", "params": [ { "name": "search", "value": "", "type": "query", "description": "Search filter. Limits returned results." }, { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." }, { "name": "sortBy", "value": "", "type": "query", "description": "Sorting parameter." }, { "name": "direction", "value": "", "type": "query", "description": "Sorting direction." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Returns a page containing certificates details by filtering condition." }, { "info": { "name": "Upload certificate", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/subscriptions/1/certificates", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Upload the certificate Infobip will present for your webhook to verify Infobip when sending notification events." }, { "info": { "name": "Get certificate details by identifier", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/1/certificates/:certificateId", "params": [ { "name": "certificateId", "value": "", "type": "path", "description": "Certificate identifier." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Returns a certificate details." }, { "info": { "name": "Delete certificate", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/subscriptions/1/certificates/:certificateId", "params": [ { "name": "certificateId", "value": "", "type": "path", "description": "Certificate identifier." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Deletes an existing certificate by a given identifier. Note, certificates cannot be deleted if linked to a Notification Profile." }, { "info": { "name": "Get filtered certificates statuses page", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/1/certificates/status", "params": [ { "name": "search", "value": "", "type": "query", "description": "Search filter. Limits returned results." }, { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." }, { "name": "sortBy", "value": "", "type": "query", "description": "Sorting parameter." }, { "name": "direction", "value": "", "type": "query", "description": "Sorting direction." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Returns a page containing certificates statuses by filtering condition." }, { "info": { "name": "Get certificate status by identifier", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/1/certificates/status/:certificateId", "params": [ { "name": "certificateId", "value": "", "type": "path", "description": "Certificate identifier." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Returns a certificate status." }, { "info": { "name": "Test connection to a webhook", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/subscriptions/1/certificates/test/webhook", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Performs connectivity check to provided webhook with the given certificate. Note, it does not send a notification event." }, { "info": { "name": "Query aggregated traffic data", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/metrics/1/query-aggregate-data", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Start process for traffic data aggregation. The result will be posted to `callbackURL` provided in the request. The response format is described in [Receive aggregated data result](#platform/metrics-api/receive-aggregate-data-result) operation." }, { "info": { "name": "Get status of query aggregate data request", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/metrics/1/requests/:requestId", "params": [ { "name": "requestId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Return the status of ongoing request, started by invoking [Query aggregated traffic data](#platform/metrics-api/query-aggregate-data)." }, { "info": { "name": "Query billing usage data", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/billing/1/usage/query", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Start the process of aggregating billing-grade financial cost data for your Infobip traffic. The results are delivered once via POST to the `callbackURL` provided in the request. Make sure the URL is reachable before submitting. See [Receive billing usage result](#platform/billing-usage/receive-billing-usage-result) for the webhook payload structure." }, { "info": { "name": "Get sending strategies", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/provisioning/2/sending-strategies", "params": [ { "name": "sendingStrategyId", "value": "", "type": "query", "description": "Id of created Sending Strategy." }, { "name": "applicationId", "value": "", "type": "query", "description": "Application Id of created Sending Strategy. For more details, see the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "entityId", "value": "", "type": "query", "description": "Entity Id of created Sending Strategy. For more details, see the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "page", "value": "", "type": "query", "description": "Requested page number." }, { "name": "size", "value": "", "type": "query", "description": "Requested page size." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get sending strategies." }, { "info": { "name": "Create sending strategy", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/provisioning/2/sending-strategies", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create sending strategy." }, { "info": { "name": "Delete sending strategy by sending strategy id", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/provisioning/2/sending-strategies/:sendingStrategyId", "params": [ { "name": "sendingStrategyId", "value": "78D8394AC3EG0460B4CF0E723FC31B49", "type": "path", "description": "Id of the Sending Strategy." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete sending strategy by sending strategy id." }, { "info": { "name": "Get all blocklists", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/platform/1/blocklists", "params": [ { "name": "sender", "value": "", "type": "query", "description": "The sender ID for which blocklist happened." }, { "name": "destination", "value": "", "type": "query", "description": "Blocklisted destination address." }, { "name": "channel", "value": "", "type": "query", "description": "Channel used for sending for which blocklist happened.\n\nIf you want to check blocklist records for all channels, this field can be left out." }, { "name": "sourceType", "value": "", "type": "query", "description": "Represents the way blocklist record was created:\n\nCUSTOM - blocklist record that was created manually\n\nMO - blocklist record automatically created once an end user unsubscribes by replying with a specific keyword (e.g.: STOP). This is applicable for the following channels: SMS, MMS.\n\nURL_OPT_OUT - blocklist record automatically created once an end user clicks an opt-out link included in the message.\n\nCAMPAIGN - blocklist record automatically created through a triggered event in the Flow (e.g., if the message was not opened in 24h, add to blocklist)." }, { "name": "accountKey", "value": "", "type": "query", "description": "Account connected with a blocklist record. Main account has access to blocklist records of their subaccounts. Subaccounts can only access blocklist records specific to them. [API to retrieve account key](https://www.infobip.com/docs/api/platform/account-management/get-all-accounts)." }, { "name": "getAllAccountKeysBlocklists", "value": "", "type": "query", "description": "If set to `true`, blocklist records for subaccounts will be returned as well." }, { "name": "createdDateFrom", "value": "", "type": "query", "description": "Use with `createDateTo` to search for blocklists for a particular date range." }, { "name": "createdDateTo", "value": "", "type": "query", "description": "Use with `createDateFrom` to search for blocklists for a particular date range." }, { "name": "campaign", "value": "", "type": "query", "description": "ID that allows you to track, analyze, and show an aggregated overview and the performance of individual campaigns per sending channel." }, { "name": "page", "value": "", "type": "query", "description": "Requested page number." }, { "name": "size", "value": "", "type": "query", "description": "Requested page size." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to get all blocklist records or filter them based on specific parameters." }, { "info": { "name": "Create blocklists", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/platform/1/blocklists", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to add someone to blocklist. It accepts create request with blocklists and asynchronously saves them, leaving out duplicate entries." }, { "info": { "name": "Delete blocklists", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/platform/1/blocklists", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to remove someone from blocklist. It accepts delete request and asynchronously deletes all blocklists that match given properties. \n\nNote: To delete a blocklist, you must list all properties that were defined in the create request. For example, to delete the blocklist with the following properties: \n\n`{\"sender\": \"10950\", \"destination\": \"12022921990\", \"sourceType\": \"CUSTOM\", \"channel\": \"MMS\", \"createdDate\": \"2022-08-18T12:36:42.123Z\"}` \n\nThe delete request must contain all " }, { "info": { "name": "Get catalogs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/catalogs/1/catalogs", "params": [ { "name": "ids", "value": "1,2,3,4,5", "type": "query", "description": "Catalog IDs." }, { "name": "name", "value": "Catalog name", "type": "query", "description": "Catalog name." }, { "name": "type", "value": "blank", "type": "query", "description": "Catalog type." }, { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of catalogs per page." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to get a list of catalogs with pagination. Query parameters are optional and can be used to narrow down the results." }, { "info": { "name": "Create catalog", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/catalogs/1/catalogs", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to create a catalog." }, { "info": { "name": "Get catalog", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/catalogs/1/catalogs/:id", "params": [ { "name": "id", "value": "10000", "type": "path", "description": "Catalog id." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to get a specific catalog." }, { "info": { "name": "Update catalog", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/catalogs/1/catalogs/:id", "params": [ { "name": "id", "value": "10000", "type": "path", "description": "Catalog id." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to overwrite a catalog with the data passed in the request body.\nNew values replace the existing values from the catalog. If no value is passed in the request,\nthe parameter keeps its value." }, { "info": { "name": "Delete catalog", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/catalogs/1/catalogs/:id", "params": [ { "name": "id", "value": "10000", "type": "path", "description": "Catalog id." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to delete a catalog." }, { "info": { "name": "Get fields", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/catalogs/1/catalogs/:catalogId/fields", "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Catalog id." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to get a list of fields for a specific catalog." }, { "info": { "name": "Create fields", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/catalogs/1/catalogs/:catalogId/fields", "params": [ { "name": "catalogId", "value": "10000", "type": "path", "description": "Catalog id." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to add catalog fields to a specific catalog.

    \nNOTE
    " }, { "info": { "name": "Get field", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/catalogs/1/catalogs/:catalogId/fields/:fieldId", "params": [ { "name": "catalogId", "value": "10000", "type": "path", "description": "Catalog id." }, { "name": "fieldId", "value": "8b00a8c6-5302-4fd0-a0cc-bb090b28ac34", "type": "path", "description": "Field id." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to get a specific catalog field." }, { "info": { "name": "Update field", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/catalogs/1/catalogs/:catalogId/fields/:fieldId", "params": [ { "name": "catalogId", "value": "10000", "type": "path", "description": "Catalog id." }, { "name": "fieldId", "value": "8b00a8c6-5302-4fd0-a0cc-bb090b28ac34", "type": "path", "description": "Field id." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to update a catalog field." }, { "info": { "name": "Delete field", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/catalogs/1/catalogs/:catalogId/fields/:fieldId", "params": [ { "name": "catalogId", "value": "10000", "type": "path", "description": "Catalog id." }, { "name": "fieldId", "value": "8b00a8c6-5302-4fd0-a0cc-bb090b28ac34", "type": "path", "description": "Field id." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to delete a field." }, { "info": { "name": "Get items", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/catalogs/1/catalogs/:catalogId/items", "params": [ { "name": "catalogId", "value": "10000", "type": "path", "description": "Catalog id." }, { "name": "queryFilter", "value": "( type == \"Jeans\" AND type == \"Shirt\" ) OR ( price > 10.99 AND color == \"Red\" )", "type": "query", "description": "Enables filtering items using [URL-encoded](https://www.w3schools.com/tags/ref_urlencode.asp) queries passed to a parameter. Wrap a catalog column name in square brackets `[]`, if the name contains UNICODE characters, e.g. `[文 本]` or a space, e.g. `[shirt type]`\n##### List of supported logical operators:\n\n\n\n\n\n\n\n\n\n\n\n
    Logical OperatorDescription
    ANDJoins query clauses with a logical AND. Returns all items that match the conditions of both clauses.
    Example: price > 10.99 AND color == Red
    ORJoins query clauses with a logical OR. Returns all items that match the conditions of either clause.
    Example: type == Jeans OR type == Shirt
    \n\n##### List of supported comparison operators:\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    Comparison OperatorSupported TypeDescription
    Greater than: >integer, decimalMatches values that are greater than a specified value.
    Example: price > 99.99
    Greater or equal: ≥integer, decimalMatches all values that are greater than or equal to a specified value.
    Example: price ≥ 99.99
    Less than: <integer, decimalMatches all values that are less than a specified value.
    Example: price < 99.99
    Less or equal: ≤integer, decimalMatches all that are values less than or equal to a specified value.
    Example: price ≤ 99
    Equal: ==integer, decimal, string, date, time, dateTimeMatches values that are equal to a specified value.
    Example: color == green
    Not equal: !=integer, decimal, string, date, time, dateTimeMatches values that are not equal to a specified value.
    Example: color != green
    \n\n##### List of supported date/time range operators:\n\n\n\n\n\n\n\n\n\n\n\n
    Date/time Range OperatorSupported TypeDescription
    BETWEENdate, time, dateTimeSpecifies date/time range between dates.
    Example: createdAt BETWEEN 2023-03-01 AND 2023-03-30
    NOT BETWEENdate, time, dateTimeSpecifies date/time range not between dates.
    Example: createdAt NOT BETWEEN 2023-03-01 AND 2023-03-30
    \n\n##### List of supported string operators:\n\n\n\n\n\n\n\n\n\n\n\n
    String Operator   Supported TypeDescription
    STARTS WITHstringMatches all values starting with specific substring.
    Example: name STARTS WITH Bo
    ENDS WITHstringMatches all values ending with specific substring.
    Example: name ENDS WITH an
    ." }, { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of items per page." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to get a list of items from a catalog with pagination. Query parameters are optional and can be used to narrow list results." }, { "info": { "name": "Add items", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/catalogs/1/catalogs/:catalogId/items", "params": [ { "name": "catalogId", "value": "10000", "type": "path", "description": "Catalog id." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to add items to a specific catalog.

    \nNOTE
    Response details:
    NOTE
    " }, { "info": { "name": "Update items", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/catalogs/1/catalogs/:catalogId/items", "params": [ { "name": "catalogId", "value": "10000", "type": "path", "description": "Catalog id." }, { "name": "queryFilter", "value": "( type == \"Jeans\" AND type == \"Shirt\" ) OR ( price > 10.99 AND color == \"Red\" )", "type": "query", "description": "Enables filtering items using [URL-encoded](https://www.w3schools.com/tags/ref_urlencode.asp) queries passed to a parameter. Wrap a catalog column name in square brackets `[]`, if the name contains UNICODE characters, e.g. `[文 本]` or a space, e.g. `[shirt type]`\n##### List of supported logical operators:\n\n\n\n\n\n\n\n\n\n\n\n
    Logical OperatorDescription
    ANDJoins query clauses with a logical AND. Returns all items that match the conditions of both clauses.
    Example: price > 10.99 AND color == Red
    ORJoins query clauses with a logical OR. Returns all items that match the conditions of either clause.
    Example: type == Jeans OR type == Shirt
    \n\n##### List of supported comparison operators:\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    Comparison OperatorSupported TypeDescription
    Greater than: >integer, decimalMatches values that are greater than a specified value.
    Example: price > 99.99
    Greater or equal: ≥integer, decimalMatches all values that are greater than or equal to a specified value.
    Example: price ≥ 99.99
    Less than: <integer, decimalMatches all values that are less than a specified value.
    Example: price < 99.99
    Less or equal: ≤integer, decimalMatches all that are values less than or equal to a specified value.
    Example: price ≤ 99
    Equal: ==integer, decimal, string, date, time, dateTimeMatches values that are equal to a specified value.
    Example: color == green
    Not equal: !=integer, decimal, string, date, time, dateTimeMatches values that are not equal to a specified value.
    Example: color != green
    \n\n##### List of supported date/time range operators:\n\n\n\n\n\n\n\n\n\n\n\n
    Date/time Range OperatorSupported TypeDescription
    BETWEENdate, time, dateTimeSpecifies date/time range between dates.
    Example: createdAt BETWEEN 2023-03-01 AND 2023-03-30
    NOT BETWEENdate, time, dateTimeSpecifies date/time range not between dates.
    Example: createdAt NOT BETWEEN 2023-03-01 AND 2023-03-30
    \n\n##### List of supported string operators:\n\n\n\n\n\n\n\n\n\n\n\n
    String Operator   Supported TypeDescription
    STARTS WITHstringMatches all values starting with specific substring.
    Example: name STARTS WITH Bo
    ENDS WITHstringMatches all values ending with specific substring.
    Example: name ENDS WITH an
    " } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to update list of filtered items." }, { "info": { "name": "Delete items", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/catalogs/1/catalogs/:catalogId/items", "params": [ { "name": "catalogId", "value": "10000", "type": "path", "description": "Catalog id." }, { "name": "queryFilter", "value": "( type == \"Jeans\" AND type == \"Shirt\" ) OR ( price > 10.99 AND color == \"Red\" )", "type": "query", "description": "Enables filtering items using [URL-encoded](https://www.w3schools.com/tags/ref_urlencode.asp) queries passed to a parameter. Wrap a catalog column name in square brackets `[]`, if the name contains UNICODE characters, e.g. `[文 本]` or a space, e.g. `[shirt type]`\n##### List of supported logical operators:\n\n\n\n\n\n\n\n\n\n\n\n
    Logical OperatorDescription
    ANDJoins query clauses with a logical AND. Returns all items that match the conditions of both clauses.
    Example: price > 10.99 AND color == Red
    ORJoins query clauses with a logical OR. Returns all items that match the conditions of either clause.
    Example: type == Jeans OR type == Shirt
    \n\n##### List of supported comparison operators:\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    Comparison OperatorSupported TypeDescription
    Greater than: >integer, decimalMatches values that are greater than a specified value.
    Example: price > 99.99
    Greater or equal: ≥integer, decimalMatches all values that are greater than or equal to a specified value.
    Example: price ≥ 99.99
    Less than: <integer, decimalMatches all values that are less than a specified value.
    Example: price < 99.99
    Less or equal: ≤integer, decimalMatches all that are values less than or equal to a specified value.
    Example: price ≤ 99
    Equal: ==integer, decimal, string, date, time, dateTimeMatches values that are equal to a specified value.
    Example: color == green
    Not equal: !=integer, decimal, string, date, time, dateTimeMatches values that are not equal to a specified value.
    Example: color != green
    \n\n##### List of supported date/time range operators:\n\n\n\n\n\n\n\n\n\n\n\n
    Date/time Range OperatorSupported TypeDescription
    BETWEENdate, time, dateTimeSpecifies date/time range between dates.
    Example: createdAt BETWEEN 2023-03-01 AND 2023-03-30
    NOT BETWEENdate, time, dateTimeSpecifies date/time range not between dates.
    Example: createdAt NOT BETWEEN 2023-03-01 AND 2023-03-30
    \n\n##### List of supported string operators:\n\n\n\n\n\n\n\n\n\n\n\n
    String Operator   Supported TypeDescription
    STARTS WITHstringMatches all values starting with specific substring.
    Example: name STARTS WITH Bo
    ENDS WITHstringMatches all values ending with specific substring.
    Example: name ENDS WITH an
    " } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to delete a list of filtered items." }, { "info": { "name": "Get item", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/catalogs/1/catalogs/:catalogId/items/:itemId", "params": [ { "name": "catalogId", "value": "10000", "type": "path", "description": "Catalog id." }, { "name": "itemId", "value": "10000", "type": "path", "description": "Item id." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to get a specific item from a catalog." }, { "info": { "name": "Update item", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/catalogs/1/catalogs/:catalogId/items/:itemId", "params": [ { "name": "catalogId", "value": "10000", "type": "path", "description": "Catalog id." }, { "name": "itemId", "value": "10000", "type": "path", "description": "Item id." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to update the field values of items." }, { "info": { "name": "Delete item", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/catalogs/1/catalogs/:catalogId/items/:itemId", "params": [ { "name": "catalogId", "value": "10000", "type": "path", "description": "Catalog id." }, { "name": "itemId", "value": "10000", "type": "path", "description": "Item id." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to delete a specific item." }, { "info": { "name": "Get item count", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/catalogs/1/catalogs/:catalogId/items/count", "params": [ { "name": "catalogId", "value": "10000", "type": "path", "description": "Catalog id." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to get the total number of items in a specific catalog." }, { "info": { "name": "Send a Messages API message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/messages-api/1/messages", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send messages at scale through multiple channels, utilizing various message types." }, { "info": { "name": "Validate a Messages API message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/messages-api/1/messages/validate", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Perform a detailed validation of Messages API messages. This endpoint executes more specific checks than the `/messages` endpoint such as: possible channel-specific validations, verification of each failover step and unknown fields. Returns `200 OK` when the request would be accepted by the platform or `400 BAD_REQUEST` when it may fail at any point. Use this endpoint to validate messages before sending them to catch potential issues early." }, { "info": { "name": "Send a Messages API event", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/messages-api/1/events", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Send one or more events to multiple recipients.\n\nAn event is an interaction with end-user's device which does not impact messaging content of conversation.\n\nExamples of events are: TYPING_STARTED, TYPING_STOPPED." }, { "info": { "name": "Get delivery reports", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/messages-api/1/reports", "params": [ { "name": "channel", "value": "", "type": "query", "description": "Messaging channel for which the report will be fetched." }, { "name": "bulkId", "value": "", "type": "query", "description": "The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address." }, { "name": "messageId", "value": "", "type": "query", "description": "The ID that uniquely identifies the message sent." }, { "name": "limit", "value": "1", "type": "query", "description": "Maximum number of delivery reports to be returned. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access reports for the last 48h" }, { "name": "entityId", "value": "promotional-traffic-entity", "type": "query", "description": "Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "applicationId", "value": "marketing-automation-application", "type": "query", "description": "Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "campaignReferenceId", "value": "summersale", "type": "query", "description": "ID of a campaign that was sent in the message." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "If you are unable to receive real-time delivery reports towards your endpoint for various reasons, we offer you an API method to fetch batches of delivery reports to confirm whether specific messages have been delivered. Each request towards this endpoint will return batches of the latest delivery reports. This endpoint retrieves delivery reports for messages sent through Messages API as well as messages sent using channel-specific standalone APIs (for example, Viber, API, WhatsApp API, or SMS A" }, { "info": { "name": "Get inbound messages", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/messages-api/1/inbound", "params": [ { "name": "channel", "value": "", "type": "query", "description": "Messaging channel for which inbound messages will be fetched." }, { "name": "limit", "value": "2", "type": "query", "description": "Maximum number of messages to be returned in a response. If not set, last 50 records are returned. Maximum limit is `1000` and you can only access messages for the last 48h." }, { "name": "applicationId", "value": "marketing-automation-application", "type": "query", "description": "Application ID that the message is linked to. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "entityId", "value": "promotional-traffic-entity", "type": "query", "description": "Entity ID that the message is linked to. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, { "name": "campaignReferenceId", "value": "mycampaign", "type": "query", "description": "ID of a campaign that message belongs to." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "If you are unable to receive incoming messages to the endpoint of your choice in real-time, you can use this API call to fetch messages. Each request will return a batch of received messages, only once. The API request will only return new messages that arrived since the last API request." }, { "info": { "name": "Add phone numbers to a list", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/signals/1/trusted-msisdns", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Add phone numbers to a MSISDN list of trusted numbers so that\n Signals never blocks messages sent to these numbers.\n" }, { "info": { "name": "Remove phone numbers from a list", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/signals/1/trusted-msisdns", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Remove phone numbers from a MSISDN list of trusted phone numbers.\n" }, { "info": { "name": "Check for phone numbers on a list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/signals/1/trusted-msisdns/:msisdn/check", "params": [ { "name": "msisdn", "value": "38512345678", "type": "path", "description": "Phone number (in MSISDN or international format) for which to check whether it is in the trusted MSISDN list." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Check whether a phone number exists on a MSISDN list of trusted phone numbers.\n" }, { "info": { "name": "Get inbound configurations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/resource-management/1/inbound-message-configurations", "params": [ { "name": "configurationKey", "value": "58BC6DB7966CB9F69A91EB956DF73239", "type": "query", "description": "Unique ID of configuration." }, { "name": "number", "value": "41793026727", "type": "query" }, { "name": "numberKey", "value": "58BC6DB7966CB9F69A91EB956DF73239", "type": "query", "description": "Unique ID of a number." }, { "name": "resource", "value": "41793026727", "type": "query" }, { "name": "resourceKey", "value": "58BC6DB7966CB9F69A91EB956DF73239", "type": "query", "description": "Unique ID of a resource." }, { "name": "keyword", "value": "STARTKW", "type": "query", "description": "Configuration keyword." }, { "name": "channel", "value": "SMS", "type": "query", "description": "Required if number, numberKey, resource or resourceKey present." }, { "name": "countryCode", "value": "GB", "type": "query", "description": "Country code in two-letter ISO standard. Required for identifying country specific resources (for instance, short code number types)." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get all configurations using a filter.
    \nIf you want configuration for a specific number or resource, then one of the following parameters is required: number, numberKey, resource or resourceKey.
    \nIf you are using configurationKey none of previously mentioned parameters are needed." }, { "info": { "name": "Manage inbound configuration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/resource-management/1/inbound-message-configurations", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create and update configuration details for incoming messages. Each action type and channel will require different parameters." }, { "info": { "name": "Delete inbound configuration", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/resource-management/1/inbound-message-configurations/:configurationKey", "params": [ { "name": "configurationKey", "value": "58BC6DB7966CB9F69A91EB956DF73239", "type": "path", "description": "Unique ID of configuration." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method will delete the configuration." }, { "info": { "name": "Search resources", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/resources/1/resources", "params": [ { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of items per page." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Search resources already owned by your account, such as senders and usable numbers, using filters. This endpoint does not return available resources for purchase or request, it only lists resources that are currently assigned to you.
    \nPagination is supported; however, if no pagination arguments are supplied, the full unpaginated result set will be returned.\n" }, { "info": { "name": "Lookup coverage for a resource", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/resources/1/coverage-lookup", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Look up the coverage for a single resource by specifying the resource type, identifier (such as sender name or phone number), and associated country code.
    \n" }, { "info": { "name": "Get resource requirements", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/resources/1/requirements-lookup", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get a list of requirements needed for requesting a specific resource." }, { "info": { "name": "Get resource requests", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/resources/1/requests", "params": [ { "name": "countryCode", "value": "US,HR", "type": "query", "description": "Filters resources to those that match the supplied country code." }, { "name": "status", "value": "IN_REVIEW,UPDATE_REQUESTED_BY_INTERNAL_REVIEWER,IN_PROGRESS,COMPLETED,REJECTED", "type": "query", "description": "Filters resources to those that match the resource request status." }, { "name": "type", "value": "ALPHANUMERIC_REGISTRATION,NUMBER_PURCHASE,RCS_SENDER_LAUNCH", "type": "query", "description": "Filters resources to those that match the supplied resource type." }, { "name": "page", "value": "", "type": "query", "description": "Results page you want to retrieve (0..N). The default value is 0." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page (0..2000). The default value is 20. The maximum value is 2000." }, { "name": "sort", "value": "requestedDate,desc", "type": "query", "description": "Sorting criteria in the format: property(,asc|desc). Default sort order is descending by last modified date. Sortable Properties: 'status', 'requestedDate'." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets a page of resource requests, using query parameters to filter results." }, { "info": { "name": "Submit resource request", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/resources/1/requests", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Submits a resource request with Infobip. Please note that costs may apply." }, { "info": { "name": "Get resource request", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/resources/1/requests/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the desired resource." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Retrieves a previously submitted resource request by its ID." }, { "info": { "name": "Update resource request", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/resources/1/requests/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the resource request." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Updates an existing resource request with Infobip. Resource request may only be updated when in UPDATE_REQUESTED and UPDATE_REQUESTED_BY_INTERNAL_REVIEWER status.\nLimited to ALPHANUMERIC_REGISTRATION, NUMBER_PURCHASE and RCS_SENDER_LAUNCH requests only.\n**All requirements data must be provided within the request, not just the incorrect or changed ones.**\n" }, { "info": { "name": "Cancel resource request", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/resources/1/requests/:id/cancel", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the resource request." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Cancels an existing resource request with Infobip. Resource request may only be canceled when in UPDATE_REQUESTED and UPDATE_REQUESTED_BY_INTERNAL_REVIEWER status.\nLimited to ALPHANUMERIC_REGISTRATION, NUMBER_PURCHASE and RCS_SENDER_LAUNCH requests only.\n" }, { "info": { "name": "Upload document", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/resources/1/documents", "body": { "type": "multipart-form", "data": [] }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Upload a document prior to providing it as a requirement within a resource request." }, { "info": { "name": "Download document", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/resources/1/documents/:documentId", "params": [ { "name": "documentId", "value": "", "type": "path", "description": "The ID of the desired document." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Download a requirement supporting document (template or sample) or a document you have previously uploaded." }, { "info": { "name": "Delete document", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/resources/1/documents/:documentId", "params": [ { "name": "documentId", "value": "", "type": "path", "description": "The ID of the document for deletion." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete a document you have previously uploaded." } ] }, { "info": { "name": "connectivity", "type": "folder" }, "items": [ { "info": { "name": "Number Context lookup (async)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/number/1/notify", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to get number context information for requested phone numbers and receive information at some endpoint asynchronously. Information may vary per country and your package. For package change, contact your account manager or [support](https://www.infobip.com/contact)." }, { "info": { "name": "Number Context lookup", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/number/1/query", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to get Number Context information for the requested phone numbers. For package change, contact your account manager or [support](https://www.infobip.com/contact)." }, { "info": { "name": "Get Number Context logs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/number/1/logs", "params": [ { "name": "to", "value": "", "type": "query", "description": "Destination address." }, { "name": "bulkId", "value": "", "type": "query", "description": "Bulk ID for which log is requested." }, { "name": "messageId", "value": "", "type": "query", "description": "NC lookup ID for which log is requested." }, { "name": "generalStatus", "value": "", "type": "query", "description": "Requested Number Context [status](https://www.infobip.com/docs/essentials/response-status-and-error-codes#api-status-codes)." }, { "name": "sentSince", "value": "2015-02-22T17:42:05.390+0100", "type": "query", "description": "The logs will only include NC lookups sent after this date. Use it alongside `sentUntil` to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`." }, { "name": "sentUntil", "value": "2015-02-22T19:42:05.390+0100", "type": "query", "description": "The logs will only include NC lookups sent before this date. Use it alongside `sentSince` to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of Number Context lookups in returned logs. If not set, the latest 50 records are returned. Maximum limit value is `1000` and you can only access logs for the last 48h." }, { "name": "mcc", "value": "", "type": "query", "description": "Mobile Country Code." }, { "name": "mnc", "value": "", "type": "query", "description": "Mobile Network Code. Mobile Country Code is required if this property is used. " } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This method allows you to get logs of sent Number Context requests." }, { "info": { "name": "Get Network Reports metadata", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/number-activation-state/1/network-reports", "params": [ { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." }, { "name": "dateFrom", "value": "2024-03-02", "type": "query", "description": "Date in UTC that exactly defines the dateFrom property of the reports.
    Format: yyyy-MM-dd
    When both dateFrom and dateTo are provided then a list of reports between those two dates are returned." }, { "name": "dateTo", "value": "2024-03-03", "type": "query", "description": "Date in UTC that exactly defines the dateTo property of the reports.
    Format: yyyy-MM-dd
    When both dateFrom and dateTo are provided then a list of reports between those two dates are returned." }, { "name": "reportId", "value": "1f7a9938-0e3b-4e20-bb69-4968dca75078", "type": "query", "description": "The reportId to find" }, { "name": "networkId", "value": "1717", "type": "query", "description": "The networkId of network that provided the report content." }, { "name": "networkName", "value": "Verizon Wireless", "type": "query", "description": "The name of network that provided the report content." }, { "name": "generatedDateFrom", "value": "2024-03-01", "type": "query", "description": "Filter by report generation date (inclusive lower bound)" }, { "name": "generatedDateTo", "value": "2024-03-31", "type": "query", "description": "Filter by report generation date (inclusive upper bound)" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get a paginated list of Network Reports metadata." }, { "info": { "name": "Get Network Report content", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/number-activation-state/1/network-reports/:reportId/records", "params": [ { "name": "page", "value": "", "type": "query", "description": "Results page to retrieve (0..N)." }, { "name": "size", "value": "", "type": "query", "description": "Number of records per page." }, { "name": "reportId", "value": "", "type": "path", "description": "The reportId to retrieve" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get a paginated list of destination number activation state changes from a given Report." }, { "info": { "name": "Silent Mobile Verification", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/mi/verification/1/verify", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Verify possession of end-user's mobile phone number with the mobile network operator's data connection.\nAPI and URL may vary per country. Please contact your sales for more details." }, { "info": { "name": "Advanced Silent Mobile Verification", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/mi/verification/1/verify/advanced", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Verify possession of the end user's mobile phone number with a mobile network operator's data connection.\nIf request body is supplied with additional data, the following can be done:\n- SIM swap check before the mobile phone number verification\n- Fallback SMS message if silent mobile verification fails\n\nAPI and URL may vary per country. Contact your Account Manager for implementation details." }, { "info": { "name": "Synchronous Silent Mobile Verification", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/mi/verification/1/verify/synchronous", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Verify possession of end-user's mobile phone number with the mobile network operator's data connection.\nThis API endpoint is available only in Brazil. Please contact your sales for more details." }, { "info": { "name": "Zero rated request initialization", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/mi/verification/1/zero-rated/init", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Initialise zero rated request.\nThis API endpoint is available only in Brazil. Please contact your sales for more details." }, { "info": { "name": "Zero rated request verify", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/mi/verification/1/verify/zero-rated", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Verify possession of end-user's mobile phone number with the mobile network operator's data connection.\nThis API endpoint is available only in Brazil. Please contact your sales for more details." }, { "info": { "name": "Number Intelligence", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/mi/number-intelligence/1/query", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to perform a query by a mobile phone number (MSISDN) for a given attribute name.\nAPI and URL may vary per country. Contact your Account Manager for implementation details." }, { "info": { "name": "SIM Swap", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/mi/simswap/1/check", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Verify if there was a SIM swap event for a given mobile phone number and period.
    \nAPI and URL may vary per country. Contact your Account Manager for implementation details." }, { "info": { "name": "National Identity Number check", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/mi/national-identity-number/1/check", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Check if provided mobile phone number (MSISDN) belongs to user with provided national identity number.\n" }, { "info": { "name": "Get Scenarios", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/biometrics/1/scenarios", "params": [ { "name": "applicationTypes", "value": "", "type": "query", "description": "One or more application types to filter scenarios. If none is set, then scenarios for all application types are returned in the response. Example: `?applicationTypes=extraction,kyc`." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This function is used to retrieve all scenarios enabled for your account." }, { "info": { "name": "Get Extraction Session", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/biometrics/1/extraction/sessions", "headers": [ { "name": "X-Session-Id", "value": "efc373be-ab6d-4c63-b798-1f65b7b4b2b3" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This function is used to retrieve a session by `sessionId` received in [Create Extraction Session](#platform-connectivity/biometrics/create-biometrics-extraction-session) response." }, { "info": { "name": "Create Extraction Session", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/biometrics/1/extraction/sessions", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This function is used to initiate a session. It is the very first step for extraction application." }, { "info": { "name": "Abort Extraction Session", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/biometrics/1/extraction/sessions", "headers": [ { "name": "X-Session-Id", "value": "efc373be-ab6d-4c63-b798-1f65b7b4b2b3" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This function is used to abort the session. Use `sessionId` received in the [Create Extraction Session](#platform-connectivity/biometrics/create-biometrics-extraction-session) response." }, { "info": { "name": "Get KYC Session", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/biometrics/1/kyc/sessions", "headers": [ { "name": "X-Session-Id", "value": "efc373be-ab6d-4c63-b798-1f65b7b4b2b3" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This function is used to retrieve a session by `sessionId` received in the [Create KYC Session](#platform-connectivity/biometrics/create-biometrics-kyc-session) response." }, { "info": { "name": "Create KYC Session", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/biometrics/1/kyc/sessions", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This function is used to initiate a session. It is the very first step for KYC application." }, { "info": { "name": "Abort KYC Session", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/biometrics/1/kyc/sessions", "headers": [ { "name": "X-Session-Id", "value": "efc373be-ab6d-4c63-b798-1f65b7b4b2b3" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This function is used to abort the session. Use `sessionId` received in the [Create KYC Session](#platform-connectivity/biometrics/create-biometrics-kyc-session) response." }, { "info": { "name": "Get Enrollment Session", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/biometrics/1/enrollment/sessions", "headers": [ { "name": "X-Session-Id", "value": "efc373be-ab6d-4c63-b798-1f65b7b4b2b3" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This function is used to retrieve a session by `sessionId` received in the [Create Enrollment Session](#platform-connectivity/biometrics/create-biometrics-enrollment-session) response." }, { "info": { "name": "Create Enrollment Session", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/biometrics/1/enrollment/sessions", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This function is used to initiate a session. It is the very first step for Enrollment application." }, { "info": { "name": "Abort Enrollment Session", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/biometrics/1/enrollment/sessions", "headers": [ { "name": "X-Session-Id", "value": "efc373be-ab6d-4c63-b798-1f65b7b4b2b3" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This function is used to abort the session. Use `sessionId` received in the [Create Enrollment Session](#platform-connectivity/biometrics/create-biometrics-enrollment-session) response." }, { "info": { "name": "Get Verification Session", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/biometrics/1/verification/sessions", "headers": [ { "name": "X-Session-Id", "value": "efc373be-ab6d-4c63-b798-1f65b7b4b2b3" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This function is used to retrieve a session by `sessionId` received in the [Create Verification Session](#platform-connectivity/biometrics/create-biometrics-verification-session) response." }, { "info": { "name": "Create Verification Session", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/biometrics/1/verification/sessions", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This function is used to initiate a session. It is the very first step for Verification application." }, { "info": { "name": "Abort Verification Session", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/biometrics/1/verification/sessions", "headers": [ { "name": "X-Session-Id", "value": "efc373be-ab6d-4c63-b798-1f65b7b4b2b3" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This function is used to abort the session. Use `sessionId` received in the [Create Verification Session](#platform-connectivity/biometrics/create-biometrics-verification-session) response." }, { "info": { "name": "Number verify device authorization", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/camara/number-verification/v0/authorize", "params": [ { "name": "clientId", "value": "enterprise-client-id", "type": "query", "description": "Client ID to identify the client on whose behalf the device is making the request. This is **provided to the client** upon registration. The value is usually the username that is being used to login into Infobip portal when generating [API key header](https://www.infobip.com/docs/essentials/api-essentials/api-authentication#api-key-header) and/or client_id that is being used when [generating OAuth2 token](https://www.infobip.com/docs/api/platform/account-management/create-oauth2-token)." }, { "name": "redirectUrl", "value": "https://enterprise.com/authorization-complete", "type": "query", "description": "URL to redirect back the device to after authorization on MNO network. **This URL needs to be static**. For request tracking and correlation purposes, the `state` query parameter will be added to this URL before redirecting the device back." }, { "name": "state", "value": "51A7_7131", "type": "query", "description": "String that will be returned as a query parameter in the `redirectUrl`." }, { "name": "login_hint", "value": "tel:+441134961234", "type": "query", "description": "OIDC login hint. Expects a phone number in `tel:+{phone_number_with_country_code}` format." } ] }, "docs": "Use this method to redirect the mobile device on the MNO network for authorization, based on the mobile device IP address.\nUpon authorization, the device is redirected back to the URL specified in `redirectUrl`.\nWhen redirected back, a new query parameter `code` is being added.\nIt needs to be sent in a subsequent verify request to complete verification.\n\n**Error handling behavior:**\n- When `redirectUrl` parameter **is provided**: All errors are returned as a 302 redirect back to the `redirectUrl" }, { "info": { "name": "Number Verification", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/camara/number-verification/v0/verify", "headers": [ { "name": "X-Correlator", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to verify possession of the end-user's mobile phone number with the mobile network operator's data connection." }, { "info": { "name": "Number verification DCQL Request", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/camara/number-verification/v2/dcql", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to generate a credential request structure for the Android CredentialManager. The response must be passed to the device for SIM-based (TS.43) authentication." }, { "info": { "name": "Get Phone Number", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/camara/number-verification/v2/device-phone-number", "headers": [ { "name": "X-Correlator", "value": "" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to retrieve the phone number associated with the device SIM." }, { "info": { "name": "Number Verification", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/camara/number-verification/v2/verify", "headers": [ { "name": "X-Correlator", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to verify possession of the end-user's mobile phone number with the phone SIM card." }, { "info": { "name": "Device Location Verification", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/camara/location/v0/verify", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to verify whether the device location is within a requested area.\nA circle with a center specified by the latitude and longitude, and a radius specified by the accuracy.\n" }, { "info": { "name": "SIM Swap", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/camara/sim-swap/v0/check", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to verify if there was a SIM swap event for a given mobile phone number and period." }, { "info": { "name": "Retrieve SIM Swap date", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/camara/sim-swap/v0/retrieve-date", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to retrieve the last date when the SIM Swap occurred for a given mobile phone number." }, { "info": { "name": "KYC Match", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/camara/kyc-match/v0.3/match", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Use this method to match customer data against Mobile Operators data." } ] }, { "info": { "name": "tools", "type": "folder" }, "items": [ { "info": { "name": "Get OpenAPI Specification", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/platform/1/openapi" }, "docs": "Returns the complete OpenAPI Specification for the Infobip platform." }, { "info": { "name": "Get OpenAPI Specification for a specific product", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/platform/1/openapi/:product", "params": [ { "name": "product", "value": "", "type": "path", "description": "Product identifier." } ] }, "docs": "Returns the OpenAPI specification for a specific Infobip product, such as SMS, Email, or WhatsApp. To get the correct product identifier, [view the list of available products](https://www.infobip.com/docs/api/tools/openapi/get-available-products)." }, { "info": { "name": "Get a list of available products", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/platform/1/openapi/available-products" }, "docs": "Returns a list of all available Infobip products that can be used to fetch the [OpenAPI Specification for a specific product](https://www.infobip.com/docs/api/tools/openapi/get-product-level-openapi). Use this list to find the correct value for the product path parameter." } ] } ], "bundled": true }