### GET /provisioning/1/applications Source: https://api.infobip.com/platform/1/openapi Get a paginated list of applications. ```markdown ### Parameters - **page** (integer (int32), query, optional): Results page to retrieve (0..N). - **size** (integer (int32), query, optional): Number of records per page. ### Responses #### 200 - OK **2be764ef53499e28cc8da8dff3890f0787860aba10984e520352c73612c0342b.PageApplication** - **results** (array (2be764ef53499e28cc8da8dff3890f0787860aba10984e520352c73612c0342b.Application)) Array items: - **applicationName** (string): Descriptive name of the resource. (example: "Test name") - **applicationId** (string) (required): 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. (example: "test-application") - **paging** (object) - **page** (integer (int32)) (required): Requested page number. - **size** (integer (int32)) (required): Requested page size. - **totalPages** (integer (int32)) (required): The total number of pages of the results matching the requested parameters. - **totalResults** (integer (int64)) (required): The total number of the results matching the requested parameters. #### 401 - response **ApiException** - **requestError** (object) - **serviceException** (object) - **messageId** (string): Identifier of the error. - **text** (string): Detailed error description. - **validationErrors** (object): Validation errors. **ApiException** #### 403 - response **ApiException** - **requestError** (object) - **serviceException** (object) - **messageId** (string): Identifier of the error. - **text** (string): Detailed error description. - **validationErrors** (object): Validation errors. **ApiException** #### 429 - response **ApiException** - **requestError** (object) - **serviceException** (object) - **messageId** (string): Identifier of the error. - **text** (string): Detailed error description. - **validationErrors** (object): Validation errors. **ApiException** #### 500 - response **ApiException** - **requestError** (object) - **serviceException** (object) - **messageId** (string): Identifier of the error. - **text** (string): Detailed error description. - **validationErrors** (object): Validation errors. **ApiException** ### Example Usage ```bash curl -X GET "https://api.example.com/provisioning/1/applications?page=0&size=20" ``` ``` -------------------------------- ### GET /numbers/2/numbers/{numberKey}/voice Source: https://api.infobip.com/platform/1/openapi This method fetches the voice setup on a number. ```markdown ### Parameters - **numberKey** (string, path, required): Unique ID of a number. ### Responses #### 200 - OK **7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.VoiceSetup** - **applicationId** (string): ID of the Application that would be associated with the voice setup. - **entityId** (string): ID of the Entity that would be associated with the voice setup. - **action** (object) (required): Voice action configuration. - **type** (string (PULL|HTTP_FORWARD|SMPP_FORWARD|MAIL_FORWARD|NO_ACTION|BLOCK|AUTORESPONSE|USSD|SEND_BULK_MT|EMAIL_TO_SMS_FORWARD|CNS_FWD|USE_CONVERSATIONS|FORWARD_TO_PSTN|FORWARD_TO_IP|FORWARD_TO_IVR|VOICE_NUMBER_MASKING|VOICE_CALL_DROP|FORWARD_TO_WEBRTC|VOICE_FORWARD_TO_CONVERSATIONS|VOICE_FORWARD_TO_CONVERSATIONS_WITH_FLOW|CALL_FORWARD_TO_APPLICATION|FORWARD_TO_SUBSCRIPTION|FORWARD_TO_CALL_ROUTING|USE_ANSWERS|VOICE_FORWARD_TO_ANSWERS|VOICE_FORWARD_TO_FLOW|VOICE_FORWARD_TO_FLOW_WITH_CONVERSATIONS|FORWARD_TO_OPERATOR_CONNECT|FORWARD_TO_EXTERNAL_INTEGRATION|FORWARD_TO_AI_AGENT|FORWARD_TO_MARKUP_LANGUAGE|OTHER)): Defines action type. It is not possible to create new action type. ("PULL"|"HTTP_FORWARD"|"SMPP_FORWARD"|"MAIL_FORWARD"|"NO_ACTION"|"BLOCK"|"AUTORESPONSE"|"USSD"|"SEND_BULK_MT"|"EMAIL_TO_SMS_FORWARD"|"CNS_FWD"|"USE_CONVERSATIONS"|"FORWARD_TO_PSTN"|"FORWARD_TO_IP"|"FORWARD_TO_IVR"|"VOICE_NUMBER_MASKING"|"VOICE_CALL_DROP"|"FORWARD_TO_WEBRTC"|"VOICE_FORWARD_TO_CONVERSATIONS"|"VOICE_FORWARD_TO_CONVERSATIONS_WITH_FLOW"|"CALL_FORWARD_TO_APPLICATION"|"FORWARD_TO_SUBSCRIPTION"|"FORWARD_TO_CALL_ROUTING"|"USE_ANSWERS"|"VOICE_FORWARD_TO_ANSWERS"|"VOICE_FORWARD_TO_FLOW"|"VOICE_FORWARD_TO_FLOW_WITH_CONVERSATIONS"|"FORWARD_TO_OPERATOR_CONNECT"|"FORWARD_TO_EXTERNAL_INTEGRATION"|"FORWARD_TO_AI_AGENT"|"FORWARD_TO_MARKUP_LANGUAGE"|"OTHER") - **description** (string): Additional action description. #### 401 - response **ApiException** - **requestError** (object) - **serviceException** (object) - **messageId** (string): Identifier of the error. - **text** (string): Detailed error description. - **validationErrors** (object): Validation errors. **ApiException** #### 403 - response **ApiException** - **requestError** (object) - **serviceException** (object) - **messageId** (string): Identifier of the error. - **text** (string): Detailed error description. - **validationErrors** (object): Validation errors. **ApiException** #### 404 - Not Found Not Found #### 500 - response **ApiException** - **requestError** (object) - **serviceException** (object) - **messageId** (string): Identifier of the error. - **text** (string): Detailed error description. - **validationErrors** (object): Validation errors. **ApiException** ### Example Usage ```bash curl -X GET "https://api.example.com/numbers/2/numbers/{numberKey}/voice" ``` ``` -------------------------------- ### POST /calls/1/configurations Source: https://api.infobip.com/platform/1/openapi Create calls configuration. ```markdown ### Request Body **Content-Type:** application/json - **id** (string): Calls configuration ID. If not provided, system will generate random ID, which will be returned in response. - **name** (string): Calls configuration name. ### Responses #### 201 - Calls configuration created. **87fdb606ad2c440ed89e04f515deb90150ccd79b7e43f8b50549f5895d6c3429.CallsConfigurationResponse** - **id** (string): Calls configuration ID. - **name** (string): Calls configuration name. #### 400 - Bad request **e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException** - **requestError** (object) - **serviceException** (object) - **messageId** (string): Identifier of the error. - **text** (string): Detailed error description. - **validationErrors** (object): Validation errors. #### 401 - response **ApiException** - **requestError** (object) - **serviceException** (object) - **messageId** (string): Identifier of the error. - **text** (string): Detailed error description. - **validationErrors** (object): Validation errors. **ApiException** #### 403 - response **ApiException** - **requestError** (object) - **serviceException** (object) - **messageId** (string): Identifier of the error. - **text** (string): Detailed error description. - **validationErrors** (object): Validation errors. **ApiException** #### 429 - response **ApiException** - **requestError** (object) - **serviceException** (object) - **messageId** (string): Identifier of the error. - **text** (string): Detailed error description. - **validationErrors** (object): Validation errors. **ApiException** #### 500 - response **ApiException** - **requestError** (object) - **serviceException** (object) - **messageId** (string): Identifier of the error. - **text** (string): Detailed error description. - **validationErrors** (object): Validation errors. **ApiException** ### Example Usage ```bash curl -X POST "https://api.example.com/calls/1/configurations" \ -H "Content-Type: application/json" \ -d '{ "id": "string", "name": "string" }' ``` ``` -------------------------------- ### GET /voice/recording/1/configuration/numbers/{key} Source: https://api.infobip.com/platform/1/openapi This method allows you to read Voice number recording configuration setup. ```markdown ### Parameters - **key** (string, path, required): Key. ### Responses #### 200 - OK **23d5bd6dfba8fab1c2f75d681069f6548a9057984b7c504a8537be7b0ef6dfe3.NumberConfigurationModel** - **numberKey** (string): *numberKey* - available through number configuration - **recording** (object): Recording Configuration object - **enabled** (boolean): True or False. Default is *false*. If *true* then each call made toward this number will be recorded. #### 401 - response **ApiException** - **requestError** (object) - **serviceException** (object) - **messageId** (string): Identifier of the error. - **text** (string): Detailed error description. - **validationErrors** (object): Validation errors. **ApiException** #### 403 - response **ApiException** - **requestError** (object) - **serviceException** (object) - **messageId** (string): Identifier of the error. - **text** (string): Detailed error description. - **validationErrors** (object): Validation errors. **ApiException** #### 404 - response **ApiException** - **requestError** (object) - **serviceException** (object) - **messageId** (string): Identifier of the error. - **text** (string): Detailed error description. - **validationErrors** (object): Validation errors. **ApiException** #### 500 - response **ApiException** - **requestError** (object) - **serviceException** (object) - **messageId** (string): Identifier of the error. - **text** (string): Detailed error description. - **validationErrors** (object): Validation errors. **ApiException** #### 4XX - Error responses **ApiException** - **requestError** (object) - **serviceException** (object) - **messageId** (string): Identifier of the error. - **text** (string): Detailed error description. - **validationErrors** (object): Validation errors. #### 5XX - Error responses **ApiException** - **requestError** (object) - **serviceException** (object) - **messageId** (string): Identifier of the error. - **text** (string): Detailed error description. - **validationErrors** (object): Validation errors. ### Example Usage ```bash curl -X GET "https://api.example.com/voice/recording/1/configuration/numbers/{key}" ``` ``` -------------------------------- ### POST /people/3/events Source: https://api.infobip.com/platform/1/openapi 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 an existing person profile and a predefined event type. If an event references a person identifier that does not match any existing profile, a new `CUSTOMER` profile will automatically be created for that identifier.
**Note**: The entire batch will fail to import if any single event fails due to missing event type, properties, etc. ```markdown ### Request Body **Content-Type:** application/json - Array of object - **eventId** (string,null): Unique identifier of the event. If provided, it helps prevent duplicate events in case of retries—for example, if the first API call fails and the same event is sent again. Passing the same `eventId` ensures the event is only recorded once in the person profile.
The value must be `1–36` characters long and can include letters `(A–Z, a–z)`, digits `(0–9)`, underscores `(_)`, and hyphens `(-)` only. - **definitionId** (string) (required): Unique identifier of event schema. - **occurredTime** (string (date-time)) (required): Time of event occurrence, as the following format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`. Events occurred more than 30 days ago will be rejected. Future dates are not allowed and will be automatically set to the current UTC time. (example: "2025-03-17T13:00:27.864Z") - **identifier** (object) (required): Used to match the event to an existing person profile using the provided identifier.
If no matching profile is found, a new profile will be automatically created.
**Note**: New profiles can only be created for the following identifier types: `PHONE`, `EMAIL`, or `EXTERNAL_ID`. - **id** (string) (required): Unique identifier of the person who performed the event. The value must match the `type` property. - **type** (string (ID|EXTERNAL_ID|PHONE|EMAIL|LINE|FACEBOOK|TELEGRAM|PUSH|WEB_PUSH|LIVE_CHAT|VIBER_BOTS|INSTAGRAM|INSTAGRAM_DM|TWITTER|APPLE_BUSINESS_CHAT|KAKAO_SANGDAM|GOOGLE_BUSINESS_MESSAGES)) (required) ("ID"|"EXTERNAL_ID"|"PHONE"|"EMAIL"|"LINE"|"FACEBOOK"|"TELEGRAM"|"PUSH"|"WEB_PUSH"|"LIVE_CHAT"|"VIBER_BOTS"|"INSTAGRAM"|"INSTAGRAM_DM"|"TWITTER"|"APPLE_BUSINESS_CHAT"|"KAKAO_SANGDAM"|"GOOGLE_BUSINESS_MESSAGES") - **sender** (string,null): Sender or application ID. `sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`. - **properties** (object,null): Object containing event properties. Must match the corresponding event definition. See People Events [documentation](https://www.infobip.com/docs/people/events#properties-custom-events) for supported data types. **Content-Type:** application/json-patch+json - Array of object - **eventId** (string,null): Unique identifier of the event. If provided, it helps prevent duplicate events in case of retries—for example, if the first API call fails and the same event is sent again. Passing the same `eventId` ensures the event is only recorded once in the person profile.
The value must be `1–36` characters long and can include letters `(A–Z, a–z)`, digits `(0–9)`, underscores `(_)`, and hyphens `(-)` only. - **definitionId** (string) (required): Unique identifier of event schema. - **occurredTime** (string (date-time)) (required): Time of event occurrence, as the following format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`. Events occurred more than 30 days ago will be rejected. Future dates are not allowed and will be automatically set to the current UTC time. (example: "2025-03-17T13:00:27.864Z") - **identifier** (object) (required): Used to match the event to an existing person profile using the provided identifier.
If no matching profile is found, a new profile will be automatically created.
**Note**: New profiles can only be created for the following identifier types: `PHONE`, `EMAIL`, or `EXTERNAL_ID`. - **id** (string) (required): Unique identifier of the person who performed the event. The value must match the `type` property. - **type** (string (ID|EXTERNAL_ID|PHONE|EMAIL|LINE|FACEBOOK|TELEGRAM|PUSH|WEB_PUSH|LIVE_CHAT|VIBER_BOTS|INSTAGRAM|INSTAGRAM_DM|TWITTER|APPLE_BUSINESS_CHAT|KAKAO_SANGDAM|GOOGLE_BUSINESS_MESSAGES)) (required) ("ID"|"EXTERNAL_ID"|"PHONE"|"EMAIL"|"LINE"|"FACEBOOK"|"TELEGRAM"|"PUSH"|"WEB_PUSH"|"LIVE_CHAT"|"VIBER_BOTS"|"INSTAGRAM"|"INSTAGRAM_DM"|"TWITTER"|"APPLE_BUSINESS_CHAT"|"KAKAO_SANGDAM"|"GOOGLE_BUSINESS_MESSAGES") - **sender** (string,null): Sender or application ID. `sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`. - **properties** (object,null): Object containing event properties. Must match the corresponding event definition. See People Events [documentation](https://www.infobip.com/docs/people/events#properties-custom-events) for supported data types. **Content-Type:** text/json - Array of object - **eventId** (string,null): Unique identifier of the event. If provided, it helps prevent duplicate events in case of retries—for example, if the first API call fails and the same event is sent again. Passing the same `eventId` ensures the event is only recorded once in the person profile.
The value must be `1–36` characters long and can include letters `(A–Z, a–z)`, digits `(0–9)`, underscores `(_)`, and hyphens `(-)` only. - **definitionId** (string) (required): Unique identifier of event schema. - **occurredTime** (string (date-time)) (required): Time of event occurrence, as the following format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`. Events occurred more than 30 days ago will be rejected. Future dates are not allowed and will be automatically set to the current UTC time. (example: "2025-03-17T13:00:27.864Z") - **identifier** (object) (required): Used to match the event to an existing person profile using the provided identifier.
If no matching profile is found, a new profile will be automatically created.
**Note**: New profiles can only be created for the following identifier types: `PHONE`, `EMAIL`, or `EXTERNAL_ID`. - **id** (string) (required): Unique identifier of the person who performed the event. The value must match the `type` property. - **type** (string (ID|EXTERNAL_ID|PHONE|EMAIL|LINE|FACEBOOK|TELEGRAM|PUSH|WEB_PUSH|LIVE_CHAT|VIBER_BOTS|INSTAGRAM|INSTAGRAM_DM|TWITTER|APPLE_BUSINESS_CHAT|KAKAO_SANGDAM|GOOGLE_BUSINESS_MESSAGES)) (required) ("ID"|"EXTERNAL_ID"|"PHONE"|"EMAIL"|"LINE"|"FACEBOOK"|"TELEGRAM"|"PUSH"|"WEB_PUSH"|"LIVE_CHAT"|"VIBER_BOTS"|"INSTAGRAM"|"INSTAGRAM_DM"|"TWITTER"|"APPLE_BUSINESS_CHAT"|"KAKAO_SANGDAM"|"GOOGLE_BUSINESS_MESSAGES") - **sender** (string,null): Sender or application ID. `sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`. - **properties** (object,null): Object containing event properties. Must match the corresponding event definition. See People Events [documentation](https://www.infobip.com/docs/people/events#properties-custom-events) for supported data types. **Content-Type:** application/*+json - Array of object - **eventId** (string,null): Unique identifier of the event. If provided, it helps prevent duplicate events in case of retries—for example, if the first API call fails and the same event is sent again. Passing the same `eventId` ensures the event is only recorded once in the person profile.
The value must be `1–36` characters long and can include letters `(A–Z, a–z)`, digits `(0–9)`, underscores `(_)`, and hyphens `(-)` only. - **definitionId** (string) (required): Unique identifier of event schema. - **occurredTime** (string (date-time)) (required): Time of event occurrence, as the following format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`. Events occurred more than 30 days ago will be rejected. Future dates are not allowed and will be automatically set to the current UTC time. (example: "2025-03-17T13:00:27.864Z") - **identifier** (object) (required): Used to match the event to an existing person profile using the provided identifier.
If no matching profile is found, a new profile will be automatically created.
**Note**: New profiles can only be created for the following identifier types: `PHONE`, `EMAIL`, or `EXTERNAL_ID`. - **id** (string) (required): Unique identifier of the person who performed the event. The value must match the `type` property. - **type** (string (ID|EXTERNAL_ID|PHONE|EMAIL|LINE|FACEBOOK|TELEGRAM|PUSH|WEB_PUSH|LIVE_CHAT|VIBER_BOTS|INSTAGRAM|INSTAGRAM_DM|TWITTER|APPLE_BUSINESS_CHAT|KAKAO_SANGDAM|GOOGLE_BUSINESS_MESSAGES)) (required) ("ID"|"EXTERNAL_ID"|"PHONE"|"EMAIL"|"LINE"|"FACEBOOK"|"TELEGRAM"|"PUSH"|"WEB_PUSH"|"LIVE_CHAT"|"VIBER_BOTS"|"INSTAGRAM"|"INSTAGRAM_DM"|"TWITTER"|"APPLE_BUSINESS_CHAT"|"KAKAO_SANGDAM"|"GOOGLE_BUSINESS_MESSAGES") - **sender** (string,null): Sender or application ID. `sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`. - **properties** (object,null): Object containing event properties. Must match the corresponding event definition. See People Events [documentation](https://www.infobip.com/docs/people/events#properties-custom-events) for supported data types. ### Responses #### 202 - Accepted Empty response body #### 400 - Bad request **b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.ProblemDetailsResponse** - **status** (integer (int32)) (required): The HTTP status code indicating the nature of the error. - **title** (string) (required): A short, human-readable summary of the error type. This title remains consistent across similar error occurrences, aiding in easy identification. - **type** (string (uri)) (required): A URI reference that provides additional information about the error type. - **traceId** (string): A unique identifier for the request, useful for tracing purposes. This ID helps in correlating logs and tracking the request through the system. - **errors** (array (b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.ErrorDetailsResponse)): An array containing detailed information about each error encountered. Array items: - **index** (integer (int32)) (required): The position of the entity in the request array that caused the error. An index of -1 indicates a general error not tied to a specific entity. - **code** (integer (int32)) (required): A specific error code that categorizes the type of error, aiding in quick identification and resolution. - **message** (string) (required): A descriptive message explaining the nature of the error. - **details** (array (b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.ErrorDetailsItemResponse)): An array providing additional context about specific aspects of the error. Array items: - **property** (string) (required): The name of the specific property or field related to the error. - **message** (string) (required): A descriptive message explaining the nature of the error associated with the property. **b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.ProblemDetailsResponse** **b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.ProblemDetailsResponse** **b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.ProblemDetailsResponse** #### 401 - response **ApiException** - **requestError** (object) - **serviceException** (object) - **messageId** (string): Identifier of the error. - **text** (string): Detailed error description. - **validationErrors** (object): Validation errors. **ApiException** #### 403 - response **ApiException** - **requestError** (object) - **serviceException** (object) - **messageId** (string): Identifier of the error. - **text** (string): Detailed error description. - **validationErrors** (object): Validation errors. **ApiException** #### 500 - response **ApiException** - **requestError** (object) - **serviceException** (object) - **messageId** (string): Identifier of the error. - **text** (string): Detailed error description. - **validationErrors** (object): Validation errors. **ApiException** ### Example Usage ```bash curl -X POST "https://api.example.com/people/3/events" \ -H "Content-Type: application/json" \ -d '[ { "eventId": "value", "definitionId": "string", "occurredTime": "2025-03-17T13:00:27.864Z", "identifier": { "id": "string", "type": "value", "sender": "value" }, "properties": "value" } ]' ``` ``` -------------------------------- ### GET /metrics/1/requests/{requestId} Source: https://api.infobip.com/platform/1/openapi Return the status of ongoing request, started by invoking [Query aggregated traffic data](#platform/metrics-api/query-aggregate-data). ```markdown ### Parameters - **requestId** (string, path, required) ### Responses #### 200 - Request status retrieved. **99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.RequestInfo** - **requestId** (string) (required): Request ID. (example: "B61D150B0F6596F68D88D253886432B5") - **status** (string (IN_PROGRESS|SUCCESS|FAILED)) (required): Request processing status. ("IN_PROGRESS"|"SUCCESS"|"FAILED") - **failureMessage** (string): Additional explanation in case of FAILED status. #### 401 - response **ApiError** - **errorCode** (string) (required): An error code uniquely identifying the error case. - **description** (string) (required): A detailed description of an error. - **action** (string) (required): An action that should be taken to recover from the error. - **violations** (array (ApiErrorViolation)) (required): List of violations that caused the error. Array items: - **property** (string): Request property that caused the error. - **violation** (string): Detailed violation description. - **resources** (array (ApiErrorResource)) (required): List of available resources to recover from the error. Array items: - **name** (string): Resource name. - **url** (string): Resource URL. **ApiError** #### 403 - response **ApiError** - **errorCode** (string) (required): An error code uniquely identifying the error case. - **description** (string) (required): A detailed description of an error. - **action** (string) (required): An action that should be taken to recover from the error. - **violations** (array (ApiErrorViolation)) (required): List of violations that caused the error. Array items: - **property** (string): Request property that caused the error. - **violation** (string): Detailed violation description. - **resources** (array (ApiErrorResource)) (required): List of available resources to recover from the error. Array items: - **name** (string): Resource name. - **url** (string): Resource URL. **ApiError** #### 404 - Request with provided id not found. **ApiError** - **errorCode** (string) (required): An error code uniquely identifying the error case. - **description** (string) (required): A detailed description of an error. - **action** (string) (required): An action that should be taken to recover from the error. - **violations** (array (ApiErrorViolation)) (required): List of violations that caused the error. Array items: - **property** (string): Request property that caused the error. - **violation** (string): Detailed violation description. - **resources** (array (ApiErrorResource)) (required): List of available resources to recover from the error. Array items: - **name** (string): Resource name. - **url** (string): Resource URL. #### 429 - response **ApiError** - **errorCode** (string) (required): An error code uniquely identifying the error case. - **description** (string) (required): A detailed description of an error. - **action** (string) (required): An action that should be taken to recover from the error. - **violations** (array (ApiErrorViolation)) (required): List of violations that caused the error. Array items: - **property** (string): Request property that caused the error. - **violation** (string): Detailed violation description. - **resources** (array (ApiErrorResource)) (required): List of available resources to recover from the error. Array items: - **name** (string): Resource name. - **url** (string): Resource URL. **ApiError** #### 500 - response **ApiError** - **errorCode** (string) (required): An error code uniquely identifying the error case. - **description** (string) (required): A detailed description of an error. - **action** (string) (required): An action that should be taken to recover from the error. - **violations** (array (ApiErrorViolation)) (required): List of violations that caused the error. Array items: - **property** (string): Request property that caused the error. - **violation** (string): Detailed violation description. - **resources** (array (ApiErrorResource)) (required): List of available resources to recover from the error. Array items: - **name** (string): Resource name. - **url** (string): Resource URL. **ApiError** ### Example Usage ```bash curl -X GET "https://api.example.com/metrics/1/requests/{requestId}" ``` ``` -------------------------------- ### POST /calls/1/calls/{callId}/start-media-stream Source: https://api.infobip.com/platform/1/openapi Start streaming media. ```markdown ### Parameters - **callId** (string, path, required): Call ID. ### Request Body **Content-Type:** application/json - **mediaStream** (object) (required) - **audioProperties** (object) - **mediaStreamConfigId** (string) (required): Media stream configuration ID. - **replaceMedia** (boolean): Indicates whether outbound media should be replaced. The replacement media is received from the url defined in the media stream configuration. - **multiChannel** (object): Multi-channel configuration. If enabled, audio of each participant will be in a separate channel in the composed file. Otherwise, audio of all participants will be mixed into a single channel in the composed file. - **enabled** (boolean) (required) ### Responses #### 200 - Success **4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse** - **status** (string (PENDING|IN_PROGRESS|COMPLETED|FAILED)): Action status. ("PENDING"|"IN_PROGRESS"|"COMPLETED"|"FAILED") #### 400 - Bad request **e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException** - **requestError** (object) - **serviceException** (object) - **messageId** (string): Identifier of the error. - **text** (string): Detailed error description. - **validationErrors** (object): Validation errors. #### 401 - response **ApiException** - **requestError** (object) - **serviceException** (object) - **messageId** (string): Identifier of the error. - **text** (string): Detailed error description. - **validationErrors** (object): Validation errors. **ApiException** #### 403 - response **ApiException** - **requestError** (object) - **serviceException** (object) - **messageId** (string): Identifier of the error. - **text** (string): Detailed error description. - **validationErrors** (object): Validation errors. **ApiException** #### 404 - Not found **e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException** - **requestError** (object) - **serviceException** (object) - **messageId** (string): Identifier of the error. - **text** (string): Detailed error description. - **validationErrors** (object): Validation errors. #### 429 - response **ApiException** - **requestError** (object) - **serviceException** (object) - **messageId** (string): Identifier of the error. - **text** (string): Detailed error description. - **validationErrors** (object): Validation errors. **ApiException** #### 500 - response **ApiException** - **requestError** (object) - **serviceException** (object) - **messageId** (string): Identifier of the error. - **text** (string): Detailed error description. - **validationErrors** (object): Validation errors. **ApiException** ### Example Usage ```bash curl -X POST "https://api.example.com/calls/1/calls/{callId}/start-media-stream" \ -H "Content-Type: application/json" \ -d '{ "mediaStream": "value" }' ``` ```