Conversation Management

All endpoints of Conversation management are protected with Ecommerce.Settings permission.

Conversation will only be used for Whatsapp for now.

Insert Conversation

  /v2.0/apps/{appId}/conversations:
    post:
      summary: "POST v2.0/apps/{appId}/conversations"
      parameters:
      - name: "appId"
        in: "path"
      responses:
        "200":
          description: "OK"

Request Body

{
  "accountName": "Furkan",
  "title": "Support",
  "type": "Whatsapp",
  "properties": {
    "ECommerceButton": true,
    "IsOnline": false,
    "ApiKey": "xxx1122xxx"
  }
}

NOTE The Properties field is completely dynamic. Because different providers will be used. The Properties field is a configuration object. You can add whatever information is required for the Provider.

Response

{
  "success": true,
  "data": {
    "type": "Whatsapp",
    "accountName": "Furkan",
    "title": "Support",
    "properties": {
      "eCommerceButton": true,
      "isOnline": false,
      "apiKey": "xxx1122xxx"
    },
    "id": "62e2de39f86f2656de67841f",
    "createDate": "2022-07-28T19:06:33.2114035Z",
    "updateDate": "2022-07-28T19:06:33.2114041Z"
  }
}

---

Filter Conversation

  /v2.0/apps/{appId}/conversations:
    get:
      summary: "GET v2.0/apps/{appId}/conversations"
      parameters:
      - name: "appId"
        in: "path"
      - name: "model"
        in: "query"
      responses:
        "200":
          description: "OK"

It is used to filter all the conversation information of the application.

Filtering can be done by type, account name and title information.

Response

{
  "success": true,
  "data": [
    {
      "type": "Whatsapp",
      "accountName": "Furkan2",
      "title": "Support",
      "properties": {
        "eCommerceButton": true,
        "isOnline": false,
        "apiKey": "xxx1122xxx"
      },
      "id": "62e2de39f86f2656de67841f",
      "createDate": "2022-07-28T19:06:33.211Z",
      "updateDate": "2022-07-28T19:07:01.501Z"
    }
  ],
  "meta": {
    "totalCount": 1
  }
}

---

Delete Conversation

 /v2.0/apps/{appId}/conversations/{id}:
    delete:
      summary: "DELETE v2.0/apps/{appId}/conversations/{id}"
      parameters:
      - name: "appId"
        in: "path"
      - name: "id"
        in: "path"
      responses:
        "200":
          description: "OK"

---

Update Conversation

/v2.0/apps/{appId}/conversations/{id}:
    put:
      summary: "PUT v2.0/apps/{appId}/conversations/{id}"
      parameters:
      - name: "appId"
        in: "path"
      - name: "id"
        in: "path"
      responses:
        "200":
          description: "OK"

Request Body

{
  "accountName": "Furkan2",
  "title": "Support",
  "type": "Whatsapp",
  "properties": {
    "ECommerceButton": true,
    "IsOnline": false,
    "ApiKey": "xxx1122xxx"
  }
}

Response

{
  "success": true,
  "data": {
    "type": "Whatsapp",
    "accountName": "Furkan2",
    "title": "Support",
    "properties": {
      "eCommerceButton": true,
      "isOnline": false,
      "apiKey": "xxx1122xxx"
    },
    "id": "62e2de39f86f2656de67841f",
    "createDate": "2022-07-28T19:06:33.211Z",
    "updateDate": "2022-07-28T19:07:01.5014562Z"
  }
}

---

Find By Id

/v2.0/apps/{appId}/conversations/{id}:
    get:
      summary: "GET v2.0/apps/{appId}/conversations/{id}"
      parameters:
      - name: "appId"
        in: "path"
      - name: "id"
        in: "path"
      responses:
        "200":
          description: "OK"

Response

{
  "success": true,
  "data": {
    "type": "Whatsapp",
    "accountName": "Furkan2",
    "title": "Support",
    "properties": {
      "eCommerceButton": true,
      "isOnline": false,
      "apiKey": "xxx1122xxx"
    },
    "id": "62e2de39f86f2656de67841f",
    "createDate": "2022-07-28T19:06:33.211Z",
    "updateDate": "2022-07-28T19:07:01.5014562Z"
  }
}