Merge pull request #154 from midhun-mobtexting/feature-response-updates

response updates
mobtexting · Jul 10, 2024 · 7af90c4 · 7af90c4
2 parents 87e2a9d + b2d1213
commit 7af90c4
Show file tree

Hide file tree

Showing 13 changed files with 174 additions and 116 deletions.
diff --git a/v2/rcs/optout.md b/v2/rcs/optout.md
@@ -34,14 +34,14 @@ On triggering the above API the specified numbers will be added to your optout l
 
 ```json
 {
-  'status' => OK,
-  'code' => 200,
-  'message' => 'Number added to optout list',
-  'data': {
-        'receiver': '918736******',
-        'iso': 'IN',
-        'created_at': '2022-10-26T06:33:40.000000Z',
-        'id': 71
+  "status" : OK,
+  "code" : 200,
+  "message" : "Number added to optout list",
+  "data": {
+        "receiver": "918736******",
+        "iso": "IN",
+        "created_at": "2022-10-26T06:33:40.000000Z",
+        "id": 71
     },
 }
 ```

diff --git a/v2/rcs/send-message.md b/v2/rcs/send-message.md
@@ -30,7 +30,7 @@
       "id": "a418d672-9781-4d97-b517-a56f7d95ad8a",
       "channel": "rcs",
       "from": "700969ca-0cb2-11ec-a2cxxxx",
-      "to": "9190199xxxxx",
+      "recipient": "9190199xxxxx",
       "credits": 1,
       "created_at": "2021-06-18T14:48:06.886358Z",
       "status": "queued",

diff --git a/v2/rcs/webhooks.md b/v2/rcs/webhooks.md
@@ -125,7 +125,9 @@ If you wish to have your callbacks signed and have made the proper configuration
         "caption": "some caption for image",
         "filename": ""
       }
-    }
+    },
+    "id": "94e6ce87-1429-4e98-9715-2ec461401fd2",
+    "timestamp": "2024-07-04T05:50:08.299202Z"
   }
 }
 ```

diff --git a/v2/reach/call.md b/v2/reach/call.md
@@ -59,18 +59,21 @@
 
 ```json
 {
-  "status": 200,
-  "message": "1 numbers accepted for delivery.",
-  "data": [
-    {
-      "id": "70fa87e0-9df9-4327-bc80-a561c48703d8:1",
-      "mobile": "918919525224",
-      "charges": "0.5000",
-      "customid": "",
-      "customid1": "",
-      "iso_code": null,
-      "submitted_at": "2019-08-16 15:09:51"
-    }
-  ]
+    "status": "OK",
+    "message": "Calls queued successfully",
+    "data": [
+        {
+            "id": "3b69aca9-3b55-4e2d-bfe0-02b910dbe156",
+            "channel": "outgoing",
+            "caller_id": "91891952xxxx",
+            "mobile": "91761936xxxx",
+            "flow_id": "351",
+            "credits": 1,
+            "created_at": "2024-07-10T06:09:43.054164Z",
+            "foreign_id": null,
+            "options": null,
+            "status": "queued"
+        }
+    ]
 }
 ```
diff --git a/v2/reach/status.md b/v2/reach/status.md
@@ -26,24 +26,23 @@ It will support `GET` request.
 #### Example Response
 
 ```json
+
 {
-  "status": 200,
-  "message": "OK",
-  "data": [
-    {
-      "id": "047d8cfc-77d1-4f6c-bfb5-e81f1a1343a7:1",
-      "mobile": "918919525224",
-      "caller_id": "918068287602",
-      "duration": "00:00:19",
-      "pulsing": "30",
-      "status": "ANSWER",
-      "charges": "0.1500",
-      "dtmf": null,
-      "location": "IN",
-      "provider": "RJ",
-      "start_at": "2019-07-16 18:13:44",
-      "end_at": "2019-07-16 18:14:03"
-    }
-  ]
+    "status": 200,
+    "message": "OK",
+    "data": [
+        {
+            "id": "8456bf26-1b6e-4ac1-adb9-2768258f71d0",
+            "channel": "outgoing",
+            "from": "3589100xxxx",
+            "to": "91761936xxxx",
+            "created_at": "2024-07-10 08:27:14",
+            "foreign_id": "",
+            "status": "ANSWER",
+            "start_at": "2024-07-10 08:27:26",
+            "end_at": "2024-07-10 08:27:29",
+            "dtmf": ""
+        }
+    ]
 }
 ```
diff --git a/v2/sms/suppressions/unsubscribers.md b/v2/sms/suppressions/unsubscribers.md
@@ -254,11 +254,11 @@ curl -X POST\
 
 #### PARAMETERS
 
-```
+
 | Name     | Description                                                  | Limits | Required |
 | -------- | ------------------------------------------------------------ | ------ | -------- |
 | file     | Receiver number file. (Supported filetype: txt,csv,xls,xlsx) | 100 MB | Yes      |
-```
+
 
 #### EXAMPLE RESPONSE
 

diff --git a/v2/verify/search.md b/v2/verify/search.md
@@ -40,7 +40,7 @@ To check the status of past or current verification requests:
       "channel": "sms",
       "event_id": "00a18bf7-dc06-4279-9ce6-068e3482eb51:1",
       "created_at": "2019-01-31 14:41:49",
-      "status": null
+      "status": "failed"
     }
   ]
 }

diff --git a/v2/viber/webhooks.md b/v2/viber/webhooks.md
@@ -79,7 +79,9 @@ If you wish to have your callbacks signed and have made the proper configuration
       "payload": {
         "text": "This is a simple text message from viber channel"
       }
-    }
+    },
+    "id": "94e6ce87-1429-4e98-9715-2ec461401fd2",
+    "timestamp": "2024-07-04T05:50:08.299202Z"
   }
 }
 ```

diff --git a/v2/voice/c2c.md b/v2/voice/c2c.md
@@ -75,8 +75,9 @@ curl -X POST '{endpoint}voice/c2c' \
 
 ```json
 {
-  "status": 200,
-  "message": "Call initiated successfully"
+    "callId": "26074c32-b316-4ffa-99d7-9f6a99da56d6",
+    "message": "call initiated successfully",
+    "status": 200
 }
 ```
 

diff --git a/v2/voice/logs.md b/v2/voice/logs.md
@@ -28,46 +28,69 @@ This Voice API supports the following:
 #### Example Response
 
 ```json
+
 {
-  "status": "OK",
-  "data": {
-    "current_page": 1,
+    "status": "OK",
+    "code": 200,
+    "message": "OK",
     "data": [
-      {
-        "id": "c839b4c4-8c0d-11e9-bb88-6c2b59c79f5a",
-        "call_from": "917989532456",
-        "call_to": "918068287601",
-        "service": "IN",
-        "bridge": "918068287601",
-        "status": "RECEIVED",
-        "duration": "00:00:12",
-        "billing": "00:00:12",
-        "pulsing": "30",
-        "charges": "0.0150",
-        "start_at": "2019-06-11 05:57:24",
-        "end_at": "2019-06-11 05:57:36",
-        "hangup_by": "caller",
-        "dtmf": null,
-        "location": "IN",
-        "region": "AP",
-        "provider": "RJ",
-        "notes": "Hi laxman final fix",
-        "audio": null,
-        "name": "Laxman ka"
-      }
+        {
+          "id": "c839b4c4-8c0d-11e9-bb88-6c2b59c79f5a",
+          "call_from": "91798953xxxx",
+          "call_to": "91806828xxxx",
+          "service": "IN",
+          "bridge": "91806828xxxx",
+          "status": "RECEIVED",
+          "duration": "00:00:12",
+          "billing": "00:00:12",
+          "pulsing": "30",
+          "charges": "0.0150",
+          "start_at": "2019-06-11 05:57:24",
+          "end_at": "2019-06-11 05:57:36",
+          "hangup_by": "caller",
+          "dtmf": null,
+          "location": "IN",
+          "region": "AP",
+          "provider": "RJ",
+          "notes": "Hi laxman final fix",
+          "audio": null,
+          "name": "Laxman ka"
+        }
     ],
-    "first_page_url": "{endpoint}voice/calls?page=1",
-    "from": 1,
-    "last_page": 1,
-    "last_page_url": "{endpoint}voice/calls?page=1",
-    "next_page_url": null,
-    "path": "{endpoint}voice/calls",
-    "per_page": 15,
-    "prev_page_url": null,
-    "to": 1,
-    "total": 1
-  }
+    "links": {
+        "first": "{{endpoint}}/api/v2/voice/calls?page=1",
+        "last": "{{endpoint}}/api/v2/voice/calls?page=1",
+        "prev": null,
+        "next": null
+    },
+    "meta": {
+        "current_page": 1,
+        "from": 1,
+        "last_page": 1,
+        "links": [
+            {
+                "url": null,
+                "label": "&laquo; Previous",
+                "active": false
+            },
+            {
+                "url": "{{endpoint}}/api/v2/voice/calls?page=1",
+                "label": "1",
+                "active": true
+            },
+            {
+                "url": null,
+                "label": "Next &raquo;",
+                "active": false
+            }
+        ],
+        "path": "{{endpoint}}/api/v2/voice/calls?page=1",
+        "per_page": 15,
+        "to": 2,
+        "total": 2
+    }
 }
+
 ```
 
 # Recordings Report
@@ -99,12 +122,13 @@ This Voice API supports the following:
 #### Example Response
 
 ```json
-{
-  "status": "OK",
-  "data": {
-    "current_page": 1,
+
+  {
+    "status": "OK",
+    "code": 200,
+    "message": "OK",
     "data": [
-      {
+        {
         "id": "c136768e-8c0e-11e9-b795-6c2b59c79f5a",
         "call_from": "918553001122",
         "call_to": "918068287601",
@@ -123,16 +147,38 @@ This Voice API supports the following:
         "created_at": "2019-06-11 05:59:07"
       }
     ],
-    "first_page_url": "{endpoint}voice/recordings?page=1",
-    "from": 1,
-    "last_page": 1,
-    "last_page_url": "{endpoint}voice/recordings?page=1",
-    "next_page_url": null,
-    "path": "{endpoint}voice/recordings",
-    "per_page": 15,
-    "prev_page_url": null,
-    "to": 2,
-    "total": 2
-  }
+    "links": {
+        "first": "{{endpoint}}/api/v2/voice/calls?page=1",
+        "last": "{{endpoint}}/api/v2/voice/calls?page=1",
+        "prev": null,
+        "next": null
+    },
+    "meta": {
+        "current_page": 1,
+        "from": 1,
+        "last_page": 1,
+        "links": [
+            {
+                "url": null,
+                "label": "&laquo; Previous",
+                "active": false
+            },
+            {
+                "url": "{{endpoint}}/api/v2/voice/calls?page=1",
+                "label": "1",
+                "active": true
+            },
+            {
+                "url": null,
+                "label": "Next &raquo;",
+                "active": false
+            }
+        ],
+        "path": "{{endpoint}}/api/v2/voice/calls?page=1",
+        "per_page": 15,
+        "to": 2,
+        "total": 2
+    }
 }
+
 ```
diff --git a/v2/voice/sounds.md b/v2/voice/sounds.md
@@ -29,11 +29,12 @@ This Voice API supports the following:
 
 ```json
 {
-  "status": "OK",
-  "message": "Sound uploaded successfully",
-  "data": {
-    "id": "5d2c9c40-8f00-48f3-902e-d4c1f2a7b0a4"
-  }
+    "status": "OK",
+    "code": 200,
+    "message": "Sound uploaded successfully",
+    "data": {
+        "id": "29ab2b24-3f93-441c-ae9c-6404361e5d14"
+    }
 }
 ```
 

diff --git a/v2/whatsapp/optout.md b/v2/whatsapp/optout.md
@@ -35,14 +35,14 @@ On triggering the above API the specified numbers will be added to your optout l
 
 ```json
 {
-  'status' => OK,
-  'code' => 200,
-  'message' => 'Number added to optout list',
-  'data': {
-        'receiver': '918736******',
-        'iso': 'IN',
-        'created_at': '2022-10-26T06:33:40.000000Z',
-        'id': 71
+  "status" : "OK",
+  "code" : 200,
+  "message" : "Number added to optout list",
+  "data": {
+        "receiver": "918736******",
+        "iso": "IN",
+        "created_at": "2022-10-26T06:33:40.000000Z",
+        "id": 71
     },
 }
 ```