Documentation
Getting Started
API Reference
SMS API Contacts API OTP API Voice API MMS API WhatsApp API Viber API
HTTP API
HTTP Endpoints HTTP SMS API

HTTP Contact Groups API

Contact groups API
OPENSMS Contact Groups API allows you to manage contact groups that are identified by a unique random ID. Use this ID to create, view, update or delete groups.

API Endpoint

                                
                                    https://www.opensms.co.ke/api/http/contacts
Parameters
Parameter Required Description
api_token
Yes
 API Token From Developers option. Get API Token
Accept
Yes
 Set to application/json
Content-Type
Yes
 Set to application/json
Create a group

Creates a new group object. OPENSMS returns the created group object with each request.

API Endpoint

                                
                                    https://www.opensms.co.ke/api/http/contacts
Parameters
Parameter Required Type Description
name
Yes
 string The name of the group
Example request
                                
curl -X POST https://www.opensms.co.ke/api/http/contacts \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{"name":"Codeglen","api_token":"YOUR_API_KEY"}'
Returns

Returns a contact object if the request was successful. 

                                
{
    "status": "success",
    "data": "group data with all details",
}

If the request failed, an error object will be returned.

                                
{
    "status": "error",
    "message" : "A human-readable description of the error."
}
View a group

Retrieves the information of an existing group. You only need to supply the unique group ID that was returned upon creation or receiving.

API Endpoint

                                
                                    https://www.opensms.co.ke/api/http/contacts/{group_id}/show/
Parameters
Parameter Required Type Description
group_id
Yes
 string Contact Groups uid
Example request
                                
curl -X POST https://www.opensms.co.ke/api/http/contacts/6065ecdc9184a/show \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{"api_token":"YOUR_API_KEY"}'
Returns

Returns a contact object if the request was successful. 

                                
{
    "status": "success",
    "data": "group data with all details",
}

If the request failed, an error object will be returned.

                                
{
    "status": "error",
    "message" : "A human-readable description of the error."
}
Update a group

Updates an existing group. You only need to supply the unique ID that was returned upon creation.

API Endpoint

                                
                                    https://www.opensms.co.ke/api/http/contacts/{group_id}
Parameters
Parameter Required Type Description
group_id
Yes
 string Contact Groups uid
name
Yes
 string New group name
Example request
                                
curl -X PATCH https://www.opensms.co.ke/api/http/contacts/6065ecdc9184a \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{"name":"Codeglen Update","api_token":"YOUR_API_KEY"}'
Returns

Returns a contact object if the request was successful. 

                                
{
    "status": "success",
    "data": "groups data with all details",
}

If the request failed, an error object will be returned.

                                
{
    "status": "error",
    "message" : "A human-readable description of the error."
}
Delete a group

Deletes an existing group. You only need to supply the unique id that was returned upon creation.

API Endpoint

                                
                                    https://www.opensms.co.ke/api/http/contacts/{group_id}
Parameters
Parameter Required Type Description
group_id
Yes
 string Contact Groups uid
Example request
                                
curl -X DELETE https://www.opensms.co.ke/api/http/contacts/6065ecdc9184a \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{"api_token":"YOUR_API_KEY"}'
Returns

Returns a contact object if the request was successful. 

                                
{
    "status": "success",
    "data": "null",
}

If the request failed, an error object will be returned.

                                
{
    "status": "error",
    "message" : "A human-readable description of the error."
}
View all groups

API Endpoint

                                
                                    https://www.opensms.co.ke/api/http/contacts/
Example request
                                
curl -X GET https://www.opensms.co.ke/api/http/contacts \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{"api_token":"YOUR_API_KEY"}'
Returns

Returns a contact object if the request was successful. 

                                
{
    "status": "success",
    "data": "group data with pagination",
}

If the request failed, an error object will be returned.

                                
{
    "status": "error",
    "message" : "A human-readable description of the error."
}