Sensaphone.net API/calllist - Revision history

Mwood: /* Sensaphone.net API */ Update Session data type.

2025-07-10T15:39:51Z

‎Sensaphone.net API: Update Session data type.

Tim: /* POST */

2015-09-09T18:27:15Z

‎POST

Tim: /* Specifications */

2015-09-09T18:24:45Z

‎Specifications

Tim: /* DELETE */

2015-07-01T20:07:15Z

‎DELETE

Tim: /* POST */

2015-07-01T19:57:25Z

‎POST

Tim: /* POST */

2015-07-01T19:55:53Z

‎POST

Tim: /* PUT */

2015-07-01T19:54:27Z

‎PUT

Tim: /* PUT */

2015-07-01T19:52:00Z

‎PUT

Tim: /* Sensaphone.net API */

2015-07-01T19:50:23Z

‎Sensaphone.net API

Tim: /* Specifications */

2015-07-01T19:45:56Z

‎Specifications

@@ Line 38: / Line 38: @@
 }}{{TableRowN| '''Parent Property'''|'''Child Property''' |'''Type'''        | '''Description'''
 }}{{TableRowN| &nbsp;          | acctid                   | Integer          | Account ID
-}}{{TableRowN| &nbsp;          | session                  | Integer          | Session ID
+}}{{TableRowN| &nbsp;          | session                  | String           | Session Token
 }}{{TableRowN| &nbsp;          | request_type             | String           | "read"
 }}{{TableRowN| &nbsp;          | calllist                 | Array of Objects | The call list object.
@@ Line 158: / Line 158: @@
 }}{{TableRowN| '''Parent Property'''|'''Child Property''' |'''Type'''        | '''Description'''
 }}{{TableRowN| &nbsp;          | acctid                   | Integer          | Account ID
-}}{{TableRowN| &nbsp;          | session                  | Integer          | Session ID
+}}{{TableRowN| &nbsp;          | session                  | String           | Session Token
 }}{{TableRowN| &nbsp;          | request_type             | String           | "update"
 }}{{TableRowN| &nbsp;          | calllist                 | Array of Objects | The call list object.
@@ Line 253: / Line 253: @@
 }}{{TableRowN| '''Parent Property'''|'''Child Property''' |'''Type'''        | '''Description'''
 }}{{TableRowN| &nbsp;          | acctid                   | Integer          | Account ID
-}}{{TableRowN| &nbsp;          | session                  | Integer          | Session ID
+}}{{TableRowN| &nbsp;          | session                  | String           | Session Token
 }}{{TableRowN| &nbsp;          | request_type             | String           | "create"
 }}{{TableRowN| &nbsp;          | calllist                 | Array of Objects | The call list object.
@@ Line 263: / Line 263: @@
 }}{{TableRowN| '''Parent Property'''|'''Child Property''' |'''Type'''        | '''Description'''
 }}{{TableRowN| &nbsp;          | acctid                   | Integer          | Account ID
-}}{{TableRowN| &nbsp;          | session                  | Integer          | Session ID
+}}{{TableRowN| &nbsp;          | session                  | String           | Session Token
 }}{{TableRowN| &nbsp;          | request_type             | String           | "create"
 }}{{TableRowN| &nbsp;          | calllist                 | Array of Objects | The call list object.
@@ Line 290: / Line 290: @@
 }}{{TableRowN| '''Parent Property'''|'''Child Property''' |'''Type'''        | '''Description'''
 }}{{TableRowN| &nbsp;          | acctid                   | Integer          | Account ID
-}}{{TableRowN| &nbsp;          | session                  | Integer          | Session ID
+}}{{TableRowN| &nbsp;          | session                  | String           | Session Token
 }}{{TableRowN| &nbsp;          | request_type             | String           | "create"
 }}{{TableRowN| &nbsp;          | calllist                 | Array of Objects | The call list object.
@@ Line 301: / Line 301: @@
 }}{{TableRowN| '''Parent Property'''|'''Child Property''' |'''Type'''        | '''Description'''
 }}{{TableRowN| &nbsp;          | acctid                   | Integer          | Account ID
-}}{{TableRowN| &nbsp;          | session                  | Integer          | Session ID
+}}{{TableRowN| &nbsp;          | session                  | String           | Session Token
 }}{{TableRowN| &nbsp;          | request_type             | String           | "create"
 }}{{TableRowN| &nbsp;          | calllist                 | Array of Objects | The call list object.
@@ Line 315: / Line 315: @@
 }}{{TableRowN| '''Parent Property'''|'''Child Property''' |'''Type'''        | '''Description'''
 }}{{TableRowN| &nbsp;          | acctid                   | Integer          | Account ID
-}}{{TableRowN| &nbsp;          | session                  | Integer          | Session ID
+}}{{TableRowN| &nbsp;          | session                  | String           | Session Token
 }}{{TableRowN| &nbsp;          | request_type             | String           | "create"
 }}{{TableRowN| &nbsp;          | calllist                 | Array of Objects | The call list object.

@@ Line 220: / Line 220: @@
+       }
+     ]
+   }

@@ Line 21: / Line 21: @@
 }}{{TableRowN| actions              | contact        | Object           | The ID of the contact. 'null' for none. | '''&#x2713;''' | '''&#x2713;''' | '''&#x2713;''' | ''' '''
 }}{{TableRowN| actions              | group          | Object           | The ID of the group. 'null' for none. | '''&#x2713;''' | '''&#x2713;''' | '''&#x2713;''' | ''' '''
 }}{{TableEnd}}

@@ Line 266: / Line 266: @@
 }}{{TableRowN| &nbsp;          | request_type             | String           | "create"
 }}{{TableRowN| &nbsp;          | calllist                 | Array of Objects | The call list object.
-}}{{TableRowN| calllist              | list_id            | Optional   | Integer          | ID of call list
+}}{{TableRowN| calllist              | list_id             | Integer          | ID of call list
 }}{{TableRowN| calllist        | name                     | String           | The name of the call list, or ""
 }}{{TableEnd}}

@@ Line 184: / Line 184: @@
 ===POST===
 '''URI Mode Request URI's:'''
 *Create a new call list. The name must be provided.
@@ Line 192: / Line 193: @@
 '''JSON Mode Request URI:'''
     '''POST''' https://rest.sesnaphone.net/api/v1/calllist/
 '''JSON Mode Request Properties'''

@@ Line 187: / Line 187: @@
 *Create a new call list. The name must be provided.
     '''POST''' https://rest.sensaphone.net/api/v1/{ACCTID}/{UUID}/calllist/name/{NAME}
-*Create a new user action in the call list. (TBD)
+*Create a new tier in the call list.
-    '''POST''' https://rest.sensaphone.net/api/v1/{ACCTID}/{UUID}/calllist/{LIST_ID}/tier/{TIER_ID}/actions/user/{USER_ID}
+    '''POST''' https://rest.sensaphone.net/api/v1/{ACCTID}/{UUID}/calllist/{LIST_ID}/tiers/minutes/{TIER_ID}/
 '''JSON Mode Request URI:'''

@@ Line 117: / Line 117: @@
 ===PUT===
 '''URI Mode Request URI's:'''
 *Change the name of the call list. Setting this to anything but the blank string will make the call list a template.

@@ Line 23: / Line 23: @@
 }}{{TableEnd}}
 ===GET===
 '''URI Mode Request URI's:'''
@@ Line 32: / Line 29: @@
 *Retrieve the list of tiers in a specific call list.
     '''GET''' https://rest.sensaphone.net/api/v1/{ACCTID}/{UUID}/calllist/{LIST_ID}/tiers
 '''JSON Mode Request URI:'''
@@ Line 60: / Line 55: @@
 }}{{TableRowN| actions               | order              | Optional   | Integer          | The order of delivery if sequential delivery is enabled. Lower numbers go first.
 }}{{TableRowN| actions               | type               | Optional   | String           | One of "user", "contact", or "group".
-}}{{TableRowN| actions               | user               | Optional   | Object           | The user data for the action. 'null' for none.
+}}{{TableRowN| actions               | user               | Optional   | Object           | The ID of the user. 'null' for none.
-}}{{TableRowN| user                  | user_id            | Optional   | Integer          | The ID of the user.
+}}{{TableRowN| actions               | contact            | Optional   | Object           | The ID of the contact. 'null' for none.
-}}{{TableRowN| actions               | contact            | Optional   | Object           | The contact data for the action. 'null' for none.
+}}{{TableRowN| actions               | group              | Optional   | Object           | The ID of the group. 'null' for none.
-}}{{TableRowN| contact               | contact_id         | Optional   | Integer          | The ID of the contact.
-}}{{TableRowN| actions               | group              | Optional   | Object           | The group data for the action. 'null' for none.
-}}{{TableRowN| group                 | group_id           | Optional   | Integer          | The ID of the group.
 }}{{TableEnd}}
@@ Line 104: / Line 96: @@
                  "order": 1,
                  "type": "user",
-                 "user": { "user_id": 4541 },
+                 "user":  4541 ,
                  "contact": null,
                  "contactgroup": null,
@@ Line 113: / Line 105: @@
                  "type": "contact",
                  "user": null,
-                 "contact": { "contact_id": 6646 },
+                 "contact": 6646,
                  "contactgroup": null,
+               }
@@ Line 159: / Line 151: @@
 }}{{TableRowN| actions               | order              | Optional   | Integer          | The order of delivery if sequential delivery is enabled. Lower numbers go first.
 }}{{TableRowN| actions               | type               | Optional   | String           | One of "user", "contact", or "group".
-}}{{TableRowN| actions               | user               | Optional   | Object           | The user data for the action. 'null' for none.
+}}{{TableRowN| actions               | user               | Optional   | Object           | The ID of the user. 'null' for none.
-}}{{TableRowN| user                  | user_id            | Optional   | Integer          | The ID of the user.
+}}{{TableRowN| actions               | contact            | Optional   | Object           | The ID of the contact. 'null' for none.
-}}{{TableRowN| actions               | contact            | Optional   | Object           | The contact data for the action. 'null' for none.
+}}{{TableRowN| actions               | group              | Optional   | Object           | The ID of the group. 'null' for none.
-}}{{TableRowN| contact               | contact_id         | Optional   | Integer          | The ID of the contact.
-}}{{TableRowN| actions               | group              | Optional   | Object           | The group data for the action. 'null' for none.
-}}{{TableRowN| group                 | group_id           | Optional   | Integer          | The ID of the group.
 }}{{TableEnd}}
@@ Line 199: / Line 188: @@
 }}{{TableRowN| tiers           | tier_id                  | Integer          | The tier number (in minutes)
 }}{{TableRowN| tiers           | actions                  | Array of Objects | The actions in the call list
-}}{{TableRowN| actions         | user                     | Object           | If type is "user", otherwise 'null'. See [[Sensaphone.net API/user|users]].
+}}{{TableRowN| actions         | user                     | Object           | The ID of the contact. 'null' for none.
-}}{{TableRowN| user            | user_id                  | Integer          | The ID of the user.
 }}{{TableEnd}}
@@ Line 238: / Line 226: @@
 }}{{TableRowN| tiers           | tier_id                  | Integer          | The tier number (in minutes)
 }}{{TableRowN| tiers           | actions                  | Array of Objects | The actions in the call list
-}}{{TableRowN| actions         | user                     | Object           | If type is "user", otherwise 'null'. See [[Sensaphone.net API/user|users]].
+}}{{TableRowN| actions         | user                     | Object           | The ID of the contact. 'null' for none.
-}}{{TableRowN| user            | user_id                  | Integer          | The ID of the user.
 }}{{TableEnd}}
@@ Line 253: / Line 240: @@
 }}{{TableRowN| tiers           | tier_id                  | Integer          | The tier number (in minutes)
 }}{{TableRowN| tiers           | actions                  | Array of Objects | The actions in the call list
-}}{{TableRowN| actions         | user                     | Object           | If type is "user", otherwise 'null'. See [[Sensaphone.net API/user|users]].
+}}{{TableRowN| actions         | user                     | Object           | The ID of the contact. 'null' for none.
-}}{{TableRowN| user            | user_id                  | Integer          | The ID of the user.
 }}{{TableEnd}}

@@ Line 18: / Line 18: @@
 }}{{TableRowN| actions              | order          | Integer          | The order of delivery if sequential delivery is enabled. Lower numbers go first. | ''' ''' | ''' ''' | '''&#x2713;''' | '''&#x2713;'''
 }}{{TableRowN| actions              | type           | String           | One of "user", "contact", or "group". | ''' ''' | ''' ''' | '''&#x2713;''' | ''' '''
-}}{{TableRowN| actions              | user           | Object           | The user data for the action. 'null' for none. | '''&#x2713;''' | '''&#x2713;''' | '''&#x2713;''' | ''' '''
+}}{{TableRowN| actions              | user           | Object           | The ID of the user. 'null' for none. | '''&#x2713;''' | '''&#x2713;''' | '''&#x2713;''' | ''' '''
-}}{{TableRowN| user                 | user_id        | Integer          | The ID of the user.               | ''' ''' | ''' ''' | '''&#x2713;''' | ''' '''
+}}{{TableRowN| actions              | contact        | Object           | The ID of the contact. 'null' for none. | '''&#x2713;''' | '''&#x2713;''' | '''&#x2713;''' | ''' '''
-}}{{TableRowN| actions              | contact        | Object           | The contact data for the action. 'null' for none. | '''&#x2713;''' | '''&#x2713;''' | '''&#x2713;''' | ''' '''
+}}{{TableRowN| actions              | group          | Object           | The ID of the group. 'null' for none. | '''&#x2713;''' | '''&#x2713;''' | '''&#x2713;''' | ''' '''
-}}{{TableRowN| contact              | contact_id     | Integer          | The ID of the contact.            | ''' ''' | ''' ''' | '''&#x2713;''' | ''' '''
-}}{{TableRowN| actions              | group          | Object           | The group data for the action. 'null' for none. | '''&#x2713;''' | '''&#x2713;''' | '''&#x2713;''' | ''' '''
-}}{{TableRowN| group                | group_id       | Integer          | The ID of the group.              | ''' ''' | ''' ''' | '''&#x2713;''' | ''' '''
 }}{{TableEnd}}