Infobip
Infobip Conversations API

Conversations is a solution that allows Enterprises to engage in conversations with their customers over multiple channels. The solution is available either as a web-based cloud platform web interface or over HTTP API for 2-way messaging over SMS, WhatsApp, Viber, and Facebook messenger. — 75 operation path(s) and 0 webhook(s) in Infobip's published OpenAPI.
Documentation GitHub OpenAPI
OpenAPI Specification

{
 "openapi":"3.1.0",
 "info":{
  "title":"Infobip OpenAPI Specification",
  "description":"OpenAPI Specification that contains all public endpoints and webhooks.",
  "contact":{
   "name":"Infobip support",
   "email":"support@infobip.com"
  },
  "version":"3.210.0",
  "x-generatedAt":"2026-07-23T15:23:52.205997667Z"
 },
 "tags":[
  {
   "name":"customer-engagement",
   "description":"Complete solutions that will help you drive better outcomes for your customers and business across the entire customer journey.\n",
   "x-type":"category",
   "x-displayName":"Customer Engagement"
  },
  {
   "name":"conversations",
   "description":"Conversations is a solution that allows Enterprises to engage in conversations with their customers over multiple channels. The solution is available either as a web-based cloud platform web interface or over HTTP API for 2-way messaging over SMS, WhatsApp, Viber, and Facebook messenger. It supports conversation threading, conversation management including queues and routing, agent assignment, resolution management and conversation history overview.",
   "x-type":"product",
   "x-displayName":"Conversations"
  },
  {
   "name":"conversation-management",
   "description":"",
   "x-type":"section",
   "x-displayName":"Conversation management"
  },
  {
   "name":"conversation-tags",
   "description":"",
   "x-type":"section",
   "x-displayName":"Conversation tags"
  },
  {
   "name":"conversation-messages",
   "description":"",
   "x-type":"section",
   "x-displayName":"Conversation messages"
  },
  {
   "name":"conversation-events",
   "description":"",
   "x-type":"section",
   "x-displayName":"Conversation events"
  },
  {
   "name":"conversation-notes",
   "description":"",
   "x-type":"section",
   "x-displayName":"Conversation notes"
  },
  {
   "name":"conversation-agents",
   "description":"",
   "x-type":"section",
   "x-displayName":"Conversation agents"
  },
  {
   "name":"conversation-queues",
   "description":"",
   "x-type":"section",
   "x-displayName":"Conversation queues"
  },
  {
   "name":"conversation-routing",
   "description":"",
   "x-type":"section",
   "x-displayName":"Conversation routing"
  },
  {
   "name":"bots",
   "description":"",
   "x-type":"section",
   "x-displayName":"Bots"
  },
  {
   "name":"metadata",
   "description":"",
   "x-type":"section",
   "x-displayName":"Metadata"
  },
  {
   "name":"templates",
   "description":"",
   "x-type":"section",
   "x-displayName":"Templates"
  },
  {
   "name":"conversation-forms",
   "description":"",
   "x-type":"section",
   "x-displayName":"Conversation forms"
  },
  {
   "name":"account-configuration",
   "description":"",
   "x-type":"section",
   "x-displayName":"Account Configuration"
  },
  {
   "name":"agent-configuration-calls",
   "description":"",
   "x-type":"section",
   "x-displayName":"Agent Configuration (Calls)"
  },
  {
   "name":"outbound-call-conversation-calls",
   "description":"",
   "x-type":"section",
   "x-displayName":"Outbound Call Conversation (Calls)"
  },
  {
   "name":"waiting-strategies-calls",
   "description":"",
   "x-type":"section",
   "x-displayName":"Waiting Strategies (Calls)"
  },
  {
   "name":"recording-configuration-calls",
   "description":"",
   "x-type":"section",
   "x-displayName":"Recording Configuration (Calls)"
  },
  {
   "name":"recording-metadata-calls",
   "description":"",
   "x-type":"section",
   "x-displayName":"Recording metadata (Calls)"
  },
  {
   "name":"recording-calls",
   "description":"",
   "x-type":"section",
   "x-displayName":"Recording (Calls)"
  },
  {
   "name":"wrap-up-configuration-calls",
   "description":"",
   "x-type":"section",
   "x-displayName":"Wrap Up Configuration (Calls)"
  },
  {
   "name":"wrap-up-time-calls",
   "description":"",
   "x-type":"section",
   "x-displayName":"Wrap Up Time (Calls)"
  },
  {
   "name":"transfers-calls",
   "description":"",
   "x-type":"section",
   "x-displayName":"Transfers (Calls)"
  },
  {
   "name":"transfer-to-external-number-configuration-calls",
   "description":"",
   "x-type":"section",
   "x-displayName":"Transfer to External Number Configuration (Calls)"
  },
  {
   "name":"transfer-strategy-calls",
   "description":"",
   "x-type":"section",
   "x-displayName":"Transfer Strategy (Calls)"
  },
  {
   "name":"call-hold-calls",
   "description":"",
   "x-type":"section",
   "x-displayName":"Call Hold (Calls)"
  },
  {
   "name":"hold-configuration-calls",
   "description":"",
   "x-type":"section",
   "x-displayName":"Hold Configuration (Calls)"
  },
  {
   "name":"call-timeout-calls",
   "description":"",
   "x-type":"section",
   "x-displayName":"Call Timeout (Calls)"
  },
  {
   "name":"working-hours",
   "description":"",
   "x-type":"section",
   "x-displayName":"Working Hours"
  },
  {
   "name":"tts-options-calls",
   "description":"",
   "x-type":"section",
   "x-displayName":"TTS options (Calls)"
  },
  {
   "name":"away-audio-messages",
   "description":"",
   "x-type":"section",
   "x-displayName":"Away Audio Messages"
  },
  {
   "name":"web-forms",
   "description":"",
   "x-type":"section",
   "x-displayName":"Web Forms"
  }
 ],
 "paths":{
  "/ccaas/1/conversations":{
   "get":{
    "tags":[
     "customer-engagement",
     "conversations",
     "conversation-management"
    ],
    "summary":"Get conversations",
    "description":"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. <a href=\"https://www.infobip.com/docs/conversations-api\" target=\"_blank\">More info</a>",
    "operationId":"get-conversations",
    "parameters":[
     {
      "name":"conversationIds",
      "in":"query",
      "description":"Optional. List of conversation Ids.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"array",
       "items":{
        "type":"string"
       }
      }
     },
     {
      "name":"queueIds",
      "in":"query",
      "description":"Optional. List of queue Ids.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"array",
       "items":{
        "type":"string"
       }
      }
     },
     {
      "name":"tagNames",
      "in":"query",
      "description":"Optional. List of tag names.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"array",
       "items":{
        "type":"string"
       }
      }
     },
     {
      "name":"agentId",
      "in":"query",
      "description":"Optional. Id of an agent assigned to conversations.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"string"
      }
     },
     {
      "name":"status",
      "in":"query",
      "description":"Optional. Conversation status.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"string",
       "enum":[
        "OPEN",
        "WAITING",
        "SOLVED",
        "CLOSED"
       ]
      }
     },
     {
      "name":"priority",
      "in":"query",
      "description":"Optional. Conversation priority.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"string",
       "enum":[
        "URGENT",
        "HIGH",
        "NORMAL",
        "LOW"
       ]
      }
     },
     {
      "name":"createdAfter",
      "in":"query",
      "description":"Optional. Filter results created after specific date and time. Format: yyyy-MM-dd'T'HH:mm:ss.SSS+0000",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"string",
       "format":"date-time"
      }
     },
     {
      "name":"createdBefore",
      "in":"query",
      "description":"Optional. Filter results created before specific date and time. Format: yyyy-MM-dd'T'HH:mm:ss.SSS+0000",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"string",
       "format":"date-time"
      }
     },
     {
      "name":"updatedAfter",
      "in":"query",
      "description":"Optional. Filter results updated after specific date and time. Format: yyyy-MM-dd'T'HH:mm:ss.SSS+0000",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"string",
       "format":"date-time"
      }
     },
     {
      "name":"updatedBefore",
      "in":"query",
      "description":"Optional. Filter results updated before specific date and time. Format: yyyy-MM-dd'T'HH:mm:ss.SSS+0000",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"string",
       "format":"date-time"
      }
     },
     {
      "name":"closedAfter",
      "in":"query",
      "description":"Optional. Filter results closed after specific date and time. Format: yyyy-MM-dd'T'HH:mm:ss.SSS+0000",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"string",
       "format":"date-time"
      }
     },
     {
      "name":"closedBefore",
      "in":"query",
      "description":"Optional. Filter results closed before specific date and time. Format: yyyy-MM-dd'T'HH:mm:ss.SSS+0000",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"string",
       "format":"date-time"
      }
     },
     {
      "name":"limit",
      "in":"query",
      "description":"Size of the result page.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"integer",
       "format":"int64",
       "default":10,
       "maximum":999
      }
     },
     {
      "name":"page",
      "in":"query",
      "description":"Number of the current page.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"integer",
       "format":"int64",
       "default":0
      }
     },
     {
      "name":"orderBy",
      "in":"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.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"string"
      }
     }
    ],
    "responses":{
     "200":{
      "description":"OK",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationResultPage"
        }
       }
      }
     },
     "400":{
      "description":"Bad request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
        },
        "examples":{
         "Invalid page size":{
          "summary":"Invalid page size",
          "description":"Invalid page size",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Page size has to be bigger or equal to zero!"
            }
           }
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "conversations:manage",
     "conversations:read"
    ]
   },
   "post":{
    "tags":[
     "customer-engagement",
     "conversations",
     "conversation-management"
    ],
    "summary":"Create conversation",
    "description":"Use this method to create a new conversation. All conversation parameters are optional. <a href=\"https://www.infobip.com/docs/conversations-api\" target=\"_blank\">More info</a>",
    "operationId":"create-conversation",
    "requestBody":{
     "content":{
      "application/json":{
       "schema":{
        "$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationApiModel"
       }
      }
     },
     "required":true
    },
    "responses":{
     "200":{
      "description":"OK",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationApiModel"
        },
        "examples":{
         "Successful response":{
          "summary":"Successful response",
          "description":"Successful response",
          "value":{
           "id":"1ddece93-041f-42ac-8e25-d05801dfe358",
           "topic":"Conversation topic",
           "summary":"Conversation summary",
           "status":"OPEN",
           "priority":"HIGH",
           "queueId":"6f2e6c5a-e4ca-48c6-bc0a-d9c18479743a",
           "agentId":"c856e230-a8cd-498b-9996-42bbed35029a",
           "createdAt":"2024-01-01T00:00:00.000+00:00",
           "updatedAt":"2024-01-01T00:00:00.000+00:00"
          }
         }
        }
       }
      }
     },
     "400":{
      "description":"Bad request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
        },
        "examples":{
         "Invalid body":{
          "summary":"Invalid body",
          "description":"Invalid body",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Invalid request body."
            }
           }
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "conversations:manage"
    ]
   }
  },
  "/ccaas/1/conversations/{conversationId}":{
   "get":{
    "tags":[
     "customer-engagement",
     "conversations",
     "conversation-management"
    ],
    "summary":"Get conversation",
    "description":"Use this method to get a single conversation. <a href=\"https://www.infobip.com/docs/conversations-api\" target=\"_blank\">More info</a>",
    "operationId":"get-conversation",
    "parameters":[
     {
      "name":"conversationId",
      "in":"path",
      "description":"Id of the conversation to get.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string"
      }
     }
    ],
    "responses":{
     "200":{
      "description":"OK",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationApiModel"
        },
        "examples":{
         "Successful response":{
          "summary":"Successful response",
          "description":"Successful response",
          "value":{
           "id":"1ddece93-041f-42ac-8e25-d05801dfe358",
           "topic":"Conversation topic",
           "summary":"Conversation summary",
           "status":"OPEN",
           "priority":"HIGH",
           "queueId":"6f2e6c5a-e4ca-48c6-bc0a-d9c18479743a",
           "agentId":"c856e230-a8cd-498b-9996-42bbed35029a",
           "createdAt":"2024-01-01T00:00:00.000+00:00",
           "updatedAt":"2024-01-01T00:00:00.000+00:00"
          }
         }
        }
       }
      }
     },
     "400":{
      "description":"Bad request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
        },
        "examples":{
         "Invalid id":{
          "summary":"Invalid id",
          "description":"Invalid id",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"NOT_FOUND",
             "text":"Invalid id 'e43bc422-09c9-4591-8b9d-82debcf04e0d' given! No such entity exists."
            }
           }
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "$ref":"#/components/responses/ApiException404"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "conversations:manage",
     "conversations:read"
    ]
   },
   "put":{
    "tags":[
     "customer-engagement",
     "conversations",
     "conversation-management"
    ],
    "summary":"Update conversation",
    "description":"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).<a href=\"https://www.infobip.com/docs/conversations-api\" target=\"_blank\">More info</a>",
    "operationId":"update-conversation",
    "parameters":[
     {
      "name":"conversationId",
      "in":"path",
      "description":"Id of the conversation being updated.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string"
      }
     }
    ],
    "requestBody":{
     "content":{
      "application/json":{
       "schema":{
        "$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationApiModel"
       }
      }
     },
     "required":true
    },
    "responses":{
     "200":{
      "description":"OK",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationApiModel"
        },
        "examples":{
         "Successful response":{
          "summary":"Successful response",
          "description":"Successful response",
          "value":{
           "id":"1ddece93-041f-42ac-8e25-d05801dfe358",
           "topic":"Conversation topic",
           "summary":"Conversation summary",
           "status":"OPEN",
           "priority":"HIGH",
           "queueId":"6f2e6c5a-e4ca-48c6-bc0a-d9c18479743a",
           "agentId":"c856e230-a8cd-498b-9996-42bbed35029a",
           "createdAt":"2024-01-01T00:00:00.000+00:00",
           "updatedAt":"2024-01-01T00:00:00.000+00:00"
          }
         }
        }
       }
      }
     },
     "400":{
      "description":"Bad request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
        },
        "examples":{
         "Invalid id":{
          "summary":"Invalid id",
          "description":"Invalid id",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"NOT_FOUND",
             "text":"Invalid id 'e43bc422-09c9-4591-8b9d-82debcf04e0d' given! No such entity exists."
            }
           }
          }
         },
         "Conversation is closed":{
          "summary":"Conversation is closed",
          "description":"Conversation is closed",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Closed conversation cannot be changed"
            }
           }
          }
         },
         "Invalid body":{
          "summary":"Invalid body",
          "description":"Invalid body",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Invalid request body."
            }
           }
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "$ref":"#/components/responses/ApiException404"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "conversations:manage"
    ]
   },
   "patch":{
    "tags":[
     "customer-engagement",
     "conversations",
     "conversation-management"
    ],
    "summary":"Patch conversation",
    "description":"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).<a href=\"https://www.infobip.com/docs/conversations-api\" target=\"_blank\">More info</a>",
    "operationId":"patch-conversation",
    "parameters":[
     {
      "name":"conversationId",
      "in":"path",
      "description":"Id of the conversation being patched.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string"
      }
     }
    ],
    "requestBody":{
     "content":{
      "application/json":{
       "schema":{
        "$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.PatchConversationApiRequest"
       }
      }
     },
     "required":true
    },
    "responses":{
     "200":{
      "description":"OK",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationApiModel"
        },
        "examples":{
         "Successful response":{
          "summary":"Successful response",
          "description":"Successful response",
          "value":{
           "id":"1ddece93-041f-42ac-8e25-d05801dfe358",
           "topic":"Conversation topic",
           "summary":"Conversation summary",
           "status":"OPEN",
           "priority":"HIGH",
           "queueId":"6f2e6c5a-e4ca-48c6-bc0a-d9c18479743a",
           "agentId":"c856e230-a8cd-498b-9996-42bbed35029a",
           "createdAt":"2024-01-01T00:00:00.000+00:00",
           "updatedAt":"2024-01-01T00:00:00.000+00:00"
          }
         }
        }
       }
      }
     },
     "400":{
      "description":"Bad request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
        },
        "examples":{
         "Invalid id":{
          "summary":"Invalid id",
          "description":"Invalid id",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"NOT_FOUND",
             "text":"Invalid id 'e43bc422-09c9-4591-8b9d-82debcf04e0d' given! No such entity exists."
            }
           }
          }
         },
         "Conversation is closed":{
          "summary":"Conversation is closed",
          "description":"Conversation is closed",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Closed conversation cannot be changed"
            }
           }
          }
         },
         "Invalid body":{
          "summary":"Invalid body",
          "description":"Invalid body",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Invalid request body."
            }
           }
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "$ref":"#/components/responses/ApiException404"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "conversations:manage"
    ]
   }
  },
  "/ccaas/1/conversations/{conversationId}/tags":{
   "post":{
    "tags":[
     "customer-engagement",
     "conversations",
     "conversation-management"
    ],
    "summary":"Add tag to conversation",
    "description":"Use this method to add a tag to the conversation. With tag(s) you can categorize conversations for assignment and/or reporting purposes. <a href=\"https://www.infobip.com/docs/conversations-api/tags\" target=\"_blank\">More info</a>",
    "operationId":"add-conversation-tag",
    "parameters":[
     {
      "name":"conversationId",
      "in":"path",
      "description":"Id of the conversation the tag is added to.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string"
      }
     }
    ],
    "requestBody":{
     "content":{
      "application/json":{
       "schema":{
        "$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.AddTagToConversationApiRequest"
       }
      }
     },
     "required":true
    },
    "responses":{
     "200":{
      "description":"OK",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
        },
        "examples":{
         "Success request response":{
          "summary":"Success request response",
          "description":"Success request response",
          "value":{
           "statusCode":"SUCCESS",
           "message":"Tag added to conversation successfully."
          }
         }
        }
       }
      }
     },
     "400":{
      "description":"Bad request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
        },
        "examples":{
         "Invalid tag name":{
          "summary":"Invalid tag name",
          "description":"Invalid tag name",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"NOT_FOUND",
             "text":"Invalid tagName 'INVALID_TAG_NAME' given! No such entity exists."
            }
           }
          }
         },
         "Conversation is closed":{
          "summary":"Conversation is closed",
          "description":"Conversation is closed",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Closed conversation cannot be changed"
            }
           }
          }
         },
         "Invalid body":{
          "summary":"Invalid body",
          "description":"Invalid body",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Invalid request body."
            }
           }
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "$ref":"#/components/responses/ApiException404"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "conversations:manage"
    ]
   }
  },
  "/ccaas/1/conversations/{conversationId}/assignee":{
   "put":{
    "tags":[
     "customer-engagement",
     "conversations",
     "conversation-management"
    ],
    "summary":"Change conversation assignment",
    "description":"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. <a href=\"https://www.infobip.com/docs/conversations-api\" target=\"_blank\">More info</a>",
    "operationId":"change-conversation-assignment",
    "parameters":[
     {
      "name":"conversationId",
      "in":"path",
      "description":"Id of the conversation for which the assignment is to be updated.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"string"
      }
     }
    ],
    "requestBody":{
     "content":{
      "application/json":{
       "schema":{
        "$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.AssignAgentApiRequest"
       }
      }
     },
     "required":true
    },
    "responses":{
     "200":{
      "description":"OK",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.ConversationApiModel"
        },
        "examples":{
         "Success request response":{
          "summary":"Success request response",
          "description":"Success request response",
          "value":{
           "id":"1ddece93-041f-42ac-8e25-d05801dfe358",
           "topic":"Conversation topic",
           "summary":"Conversation summary",
           "status":"OPEN",
           "priority":"HIGH",
           "queueId":"6f2e6c5a-e4ca-48c6-bc0a-d9c18479743a",
           "agentId":"c856e230-a8cd-498b-9996-42bbed35029a",
           "createdAt":"2024-01-01T00:00:00.000+00:00",
           "updatedAt":"2024-01-01T00:00:00.000+00:00"
          }
         }
        }
       }
      }
     },
     "400":{
      "description":"Bad request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/e89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2.StatusCodeResponse"
        },
        "examples":{
         "Invalid agent Id":{
          "summary":"Invalid agent Id",
          "description":"Invalid agent Id",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"NOT_FOUND",
             "text":"Invalid id 'e43bc422-09c9-4591-8b9d-82debcf04e0d' given! No such entity exists."
            }
           }
          }
         },
         "Invalid body":{
          "summary":"Invalid body",
          "description":"Invalid body",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Invalid request body."
            }
           }
          }
         },
         "Conversation is closed":{
          "summary":"Conversation is closed",
          "description":"Conversation is closed",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Closed conversation cannot be changed"
            }
           }
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "$ref":"#/components/responses/ApiException404"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "conversations:manage"
 

# --- truncated at 32 KB (766 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/infobip/refs/heads/main/openapi/infobip-conversations-openapi.json
Infobip Conversations API

Documentation

Specifications

Other Resources

OpenAPI Specification
