Calls · Channelize.io

Channelize.io Calls APIs and SDK allows adding real-time high-quality one-to-one and one-to-many video and voice chat into an application.

Channelize.io Calls SDKs handles all required request and responses like Initiate call, Accept call, Decline call, and many more. Calls APIs provide you flexibilities and abilities to retrieve call logs and perform required actions. However, our Calls SDKs also allows retrieving call logs and take required actions in client applications.

Base URL

Application APIs base URL format.

https://callsapi.channelize.io/v2/

List Calls

Retrieves the list of calls of a user.

GET https://callsapi.channelize.io/v2/calls

Query Params

This table lists all parameters this API request supports to get filtered results.

Parameter	Type	Required	Default	Description
ids	string	no	null	Specifies a comma-separated string of the unique calls IDs to retrieve.
callerIds	string	no	null	Specifies a comma-separated string of one or more Caller IDs to filter the call logs. A caller is a user who initiates the call.
type	string	no	null	Specifies the type of call. Allowed values are `video` and `voice`.
result	string	no	null	Specifies the result of the call. Allowed values are `ongoing` and `completed`.
conversationId	string	no	null	Specifies the conversation ID this call belongs to. It is required when call functionality is used in association with Channelize.io Chat.
state	string	no	null	Specifies the state of a login user in a call. Allowed values are `invited`, `joined`, `missed`, `not_answered`, and `completed`.
customTypes	string	no	null	Specifies a comma-separated string of one or more custom types to filter the calls. Custom Types stores additional information for the call.
minDuration	integer	no	null	Specifies the minimum value of the call duration to restrict the search scope.
maxDuration	integer	no	null	Specifies the maximum value of the call duration to restrict the search scope.
sort	string	no	createdAt DESC	Specifies the sorting criteria for the returned results. Allowed values are createdAt ASC and createdAt DESC.
limit	int	no	25	Specifies the number of results to return.
skip	int	no	0	Specifies the number of results you want to skip from the beginning. (Useful in Pagination)

Request Example

https://callsapi.channelize.io/v2/calls

Response

Status Code: 200

[
    {
        "type": "voice",
        "result": "completed",
        "config": {
            "require_invite": true
        },
        "members": [
            {
                "userId": "20697",
                "state": "completed",
                "id": "36d83db4-fb2d-4291-aca9-2dac479c6439",
                "user": {
                    "isOnline": false,
                    "displayName": "alen joe",
                    "profileImageUrl": "http://mobiledemodevelopment.s3.amazonaws.com/public/user/33/19/02/b5ceb45b2d6c74e4fc89673a5675c09c.jpg",
                    "profileUrl": "http://devaddons1.socialengineaddons.com/mobiledemodevelopment/profile/test1",
                    "metaData": {
                        "secondaryField": "Engineer"
                    },
                    "id": "20697"
                }
            },
            {
                "userId": "35",
                "state": "missed",
                "id": "20483a46-8183-4e8f-bae6-9394a502ddd4",
                "user": {
                    "isOnline": true,
                    "displayName": "andrew holmes",
                    "profileImageUrl": "http://mobiledemodevelopment.s3.amazonaws.com/public/album_photo/88/3c/01/13a4d_e4d3.jpg",
                    "profileUrl": "http://devaddons1.socialengineaddons.com/mobiledemodevelopment/profile/admin",
                    "metaData": {
                        "location": "usa"
                    },
                    "id": "35"
                }
            },
            {
                "userId": "18859",
                "state": "completed",
                "id": "185e079e-2e54-4905-981b-fad05f6f913e",
                "user": {
                    "isOnline": true,
                    "displayName": "sydney millers",
                    "profileImageUrl": "http://mobiledemodevelopment.s3.amazonaws.com/public/user/17/0a/02/fbef1bb47eb85fb2979b135ed04e0eb3.png",
                    "profileUrl": "http://devaddons1.socialengineaddons.com/mobiledemodevelopment/profile/Alfredo",
                    "metaData": {
                        "secondaryField": "Software Engineer"
                    },
                    "id": "18859"
                }
            }
        ],
        "callerId": "20697",
        "createdAt": "2020-06-02T10:43:29.492Z",
        "endedAt": "2020-06-09T05:34:08.174Z",
        "caller": {
            "isOnline": false,
            "displayName": "Alen Joe",
            "profileImageUrl": "http://mobiledemodevelopment.s3.amazonaws.com/public/user/33/19/02/b5ceb45b2d6c74e4fc89673a5675c09c.jpg",
            "profileUrl": "http://devaddons1.socialengineaddons.com/mobiledemodevelopment/profile/test1",
            "metaData": {
                "secondaryField": "Engineer"
            },
            "id": "20697"
        },
        "id": "0558701b-3c7b-45a1-80c3-8af7f0e98659",
        "duration": 240,
        "state": "completed",
        "timestamps": {
            "joinedAt": "2020-06-02T10:43:29.492Z",
            "completedAt": "2020-06-02T10:47:29.492Z"
        }
    },
    ...
]

Get Calls Count

Retrieves the total number of calls of a user.

GET https://callsapi.channelize.io/v2/calls/count

Query Params

This table lists all parameters this API request supports to get filtered results.

Parameter	Type	Required	Default	Description
ids	string	no	null	Specifies a comma-separated string of the unique calls IDs to retrieve.
callerIds	string	no	null	Specifies a comma-separated string of one or more Caller IDs to filter the call logs. A caller is a user who initiates the call.
type	string	no	null	Specifies the type of call. Allowed values are `video` and `voice`.
result	string	no	null	Specifies the result of the call. Allowed values are `ongoing` and `completed`.
conversationId	string	no	null	Specifies the conversation ID this call belongs to. It is required when call functionality is used in association with Channelize.io Chat.
state	string	no	null	Specifies the state of a login user in a call. Allowed values are `invited`, `joined`, `missed`, `not_answered`, and `completed`.
customTypes	string	no	null	Specifies a comma-separated string of one or more custom types to filter the calls. Custom Types stores additional information for the call.
minDuration	integer	no	null	Specifies the minimum value of the call duration to restrict the search scope.
maxDuration	integer	no	null	Specifies the maximum value of the call duration to restrict the search scope.

Request Example

https://callsapi.channelize.io/v2/calls/count

Response

Status Code: 200

{
    "count": 120
}

Get Call

Retrieves information about a call.

GET https://callsapi.channelize.io/v2/calls/{call_id}

Path Params

This table lists all parameters this API request supports.

Parameter	Type	Required	Default	Description
call_id	string	yes	-	The unique ID of the call to retrieve.

Request Example

https://callsapi.channelize.io/v2/calls/0558701b-3c7b-45a1-80c3-8af7f0e98659

Response

Status Code: 200

{
    "type": "voice",
    "result": "completed",
    "config": {
        "require_invite": true
    },
    "members": [
        {
            "userId": "20697",
            "state": "completed",
            "id": "36d83db4-fb2d-4291-aca9-2dac479c6439",
            "user": {
                "isOnline": false,
                "displayName": "Alen Joe",
                "profileImageUrl": "http://mobiledemodevelopment.s3.amazonaws.com/public/user/33/19/02/b5ceb45b2d6c74e4fc89673a5675c09c.jpg",
                "profileUrl": "http://devaddons1.socialengineaddons.com/mobiledemodevelopment/profile/test1",
                "metaData": {
                    "secondaryField": "Engineer"
                },
                "id": "20697"
            }
        },
        {
            "userId": "35",
            "state": "missed",
            "id": "20483a46-8183-4e8f-bae6-9394a502ddd4",
            "user": {
                "isOnline": true,
                "displayName": "Andrew Holmes",
                "profileImageUrl": "http://mobiledemodevelopment.s3.amazonaws.com/public/album_photo/88/3c/01/13a4d_e4d3.jpg",
                "profileUrl": "http://devaddons1.socialengineaddons.com/mobiledemodevelopment/profile/admin",
                "metaData": {
                    "location": "usa"
                },
                "id": "35"
            }
        },
        {
            "userId": "18859",
            "state": "completed",
            "id": "185e079e-2e54-4905-981b-fad05f6f913e",
            "user": {
                "isOnline": true,
                "displayName": "Sydney Millers",
                "profileImageUrl": "http://mobiledemodevelopment.s3.amazonaws.com/public/user/17/0a/02/fbef1bb47eb85fb2979b135ed04e0eb3.png",
                "profileUrl": "http://devaddons1.socialengineaddons.com/mobiledemodevelopment/profile/Alfredo",
                "metaData": {
                    "secondaryField": "Software Engineer"
                },
                "id": "18859"
            }
        }
    ],
    "callerId": "20697",
    "createdAt": "2020-06-02T10:43:29.492Z",
    "endedAt": "2020-06-09T05:34:08.174Z",
    "caller": {
        "isOnline": false,
        "displayName": "Alen Joe",
        "profileImageUrl": "http://mobiledemodevelopment.s3.amazonaws.com/public/user/33/19/02/b5ceb45b2d6c74e4fc89673a5675c09c.jpg",
        "profileUrl": "http://devaddons1.socialengineaddons.com/mobiledemodevelopment/profile/test1",
        "metaData": {
            "secondaryField": "Engineer"
        },
        "id": "20697"
    },
    "id": "0558701b-3c7b-45a1-80c3-8af7f0e98659",
    "duration": 240,
    "state": "completed",
    "timestamps": {
        "joinedAt": "2020-06-02T10:43:29.492Z",
        "completedAt": "2020-06-02T10:47:29.492Z"
    }
}

Delete Call

Deletes a targeted call.

DELETE https://callsapi.channelize.io/v2/calls/{call_id}

Path Params

This table lists all parameters this API request supports.

Parameter	Type	Required	Default	Description
call_id	string	yes	-	The unique ID of the call to deletes.

Request Example

https://callsapi.channelize.io/v2/calls/0558701b-3c7b-45a1-80c3-8af7f0e98659

Response

Status Code: 204

No Content