Parrotica API

Introduction

This documentation will guide you through setting up, authenticating, and using the API effectively. Use the table of contents to navigate through the sections and find what you need quickly. For more information, contact support

BASE PATH

https://api.parrotica.com

How to retrieve your API key and user ID

To start using the Parrotica API, you'll need your API Key and User ID. Follow the steps below to retrieve them from your account:

1. Log In to your Parrotica account.
2. Navigate to Settings in the bottom area of the sidebar.
3. Go to the API Settings section.
4. Copy your API Key and User ID.

Keep your API Key and User ID secure, and do not share it publicly or push it to any repository.

Authentication

Authentication method

Parrotica uses the x-api-key header for API authentication. Include the API Key in the x-api-key header for every request.

Example Header

x-api-key: YOUR_API_KEY

Best Practices

1. Keep your API Key secure and never expose it in public repositories.
2. Regularly rotate your API Key for added security
3. Use HTTPS to encrypt requests and responses.
4. Avoid hardcoding your API Key in client-side applications.

Methods

ActivityLog

GET /api/v1/activity/{userId}

Gets a list of activity for the user (transactionGetAllActivityLogs)

Path parameters

userId (required)

Path Parameter — default: null

Query parameters

page (required)

Query Parameter — default: null

take (required)

Query Parameter — default: null

Return type

Transaction_getAllTransaction_200_response

Example data

Content-Type: application/json

{
  "code" : 0.8008281904610115,
  "data" : [ {
    "createdAt" : "2000-01-23T04:56:07.000+00:00",
    "amount" : 1.4658129805029452,
    "unit" : "unit",
    "description" : "description",
    "action" : "action",
    "id" : 6.027456183070403,
    "value" : 5.962133916683182,
    "status" : "status",
    "updatedAt" : "2000-01-23T04:56:07.000+00:00"
  }, {
    "createdAt" : "2000-01-23T04:56:07.000+00:00",
    "amount" : 1.4658129805029452,
    "unit" : "unit",
    "description" : "description",
    "action" : "action",
    "id" : 6.027456183070403,
    "value" : 5.962133916683182,
    "status" : "status",
    "updatedAt" : "2000-01-23T04:56:07.000+00:00"
  } ],
  "message" : "message",
  "status" : "status"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Data description of activity Transaction_getAllTransaction_200_response

404

Transaction_getAllTransaction_404_response

500

Transaction_getAllTransaction_404_response

Contact

POST /v1/contacts/{userId}

Adds an array of contact to phonebook (contactAddContacts)

Path parameters

userId (required)

Path Parameter — default: null

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

ContactCreation ContactCreation (required)

Body Parameter

Content-Type: application/json

{
"fullName": "John Doe",
"number": "+123456789"
}

Query parameters

groupId (required)

Query Parameter — default: null

Return type

Contact_addContacts_200_response

Example data

Content-Type: application/json

{
  "code" : 0.8008281904610115,
  "data" : [ {
    "number" : "number",
    "fullName" : "fullName",
    "id" : 6.027456183070403,
    "isDND" : true
  }, {
    "number" : "number",
    "fullName" : "fullName",
    "id" : 6.027456183070403,
    "isDND" : true
  } ],
  "message" : "message",
  "status" : "status"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

List of contacts added Contact_addContacts_200_response

404

Transaction_getAllTransaction_404_response

500

Transaction_getAllTransaction_404_response

DELETE /v1/contacts/{userId}/{contactId}

Deletes a contact (contactDeleteContact)

Path parameters

contactId (required)

Path Parameter — default: null

userId (required)

Path Parameter — default: null

Return type

Contact_getContact_200_response

Example data

Content-Type: application/json

{
    "code" : 0.8008281904610115,
    "message" : "message",
    "status" : "status"
  }

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

deleted contact object Contact_getContact_200_response

404

Transaction_getAllTransaction_404_response

500

Transaction_getAllTransaction_404_response

DELETE /v1/contacts/{userId}

Deletes many contacts (contactDeleteManyContacts)

Path parameters

userId (required)

Path Parameter — default: null

Query parameters

ids (required)

Query Parameter — default: null

deleteAll (required)

Query Parameter — default: null

Return type

Contact_deleteManyContacts_200_response

Example data

Content-Type: application/json

{
    "code" : 0.8008281904610115,
    "message" : "message",
    "status" : "status"
  }

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

deleted contact objects Contact_deleteManyContacts_200_response

404

Transaction_getAllTransaction_404_response

500

Transaction_getAllTransaction_404_response

PUT /v1/contacts/{userId}/{contactId}

Edits a contact (contactEditContact)

Path parameters

contactId (required)

Path Parameter — default: null

userId (required)

Path Parameter — default: null

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

ContactCreation ContactCreation (required)

Body Parameter

Content-Type: application/json

{
      "fullName": "John Doe",
      "number": "+123456789"
    }

Return type

Contact_getContact_200_response

Example data

Content-Type: application/json

{
    "code" : 0.8008281904610115,
    "message" : "message",
    "status" : "status"
  }

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

edited contact object Contact_getContact_200_response

404

Transaction_getAllTransaction_404_response

500

Transaction_getAllTransaction_404_response

GET /v1/contacts/{userId}/{contactId}

Gets a contact for a user (contactGetContact)

Path parameters

contactId (required)

Path Parameter — default: null

userId (required)

Path Parameter — default: null

Return type

Contact_getContact_200_response

Example data

Content-Type: application/json

{
    "code" : 0.8008281904610115,
    "message" : "message",
    "status" : "status"
  }

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

contact object Contact_getContact_200_response

404

Transaction_getAllTransaction_404_response

500

Transaction_getAllTransaction_404_response

GET /v1/contact-summary/{userId}

Gets the contact summary for a user (contactGetContactSummary)

Path parameters

userId (required)

Path Parameter — default: null

Return type

Contact_GetContactSummary_200_response

Example data

Content-Type: application/json

{
    "code" : 0.8008281904610115,
    "message" : "message",
    "status" : "status"
  }

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Contact summary data Contact_GetContactSummary_200_response

404

Transaction_getAllTransaction_404_response

500

Transaction_getAllTransaction_404_response

GET /v1/contacts/{userId}

Gets an array of contact for a user (contactGetContacts)

Path parameters

userId (required)

Path Parameter — default: null

Query parameters

page (required)

Query Parameter — default: null

take (required)

Query Parameter — default: null

Return type

Contact_getContacts_200_response

Example data

Content-Type: application/json

{
    "code" : 0.8008281904610115,
    "data" : [ {
      "number" : "number",
      "fullName" : "fullName",
      "id" : 6.027456183070403,
      "isDND" : true
    }, {
      "number" : "number",
      "fullName" : "fullName",
      "id" : 6.027456183070403,
      "isDND" : true
    } ],
    "message" : "message",
    "status" : "status"
  }

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

List of contacts returned Contact_getContacts_200_response

404

Transaction_getAllTransaction_404_response

500

Transaction_getAllTransaction_404_response

GET /v1/contacts-cost/{userId}

Gets a cost summary for sending message to all contacts (contactGetCostSummaryForGroup)

Path parameters

userId (required)

Path Parameter — default: null

Return type

Contact_GetCostSummaryForGroup_200_response

Example data

Content-Type: application/json

{
    "code" : 0.8008281904610115,
    "message" : "message",
    "status" : "status"
  }

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Cost summary data Contact_GetCostSummaryForGroup_200_response

404

Transaction_getAllTransaction_404_response

500

Transaction_getAllTransaction_404_response

Groups

patch /v1/{userId}/groups/{groupId}

Adds an array of contact to group (groupAddContactsToGroup)

Path parameters

userId (required)

Path Parameter — default: null

groupId (required)

Path Parameter — default: null

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

ContactCreation ContactCreation (required)

application/json

Body Parameter —

{
      "fullName": "John Doe",
      "number": "+123456789"
    }

Return type

Group_AddContactsToGroup_200_response

Example data

Content-Type: application/json

{
    "code" : 0.8008281904610115,
    "data" : [ {
      "description" : "description",
      "isStarred" : true,
      "id" : 6.027456183070403,
      "title" : "title",
      "contacts" : [ {
        "number" : "number",
        "fullName" : "fullName",
        "id" : 6.027456183070403,
        "isDND" : true
      }, {
        "number" : "number",
        "fullName" : "fullName",
        "id" : 6.027456183070403,
        "isDND" : true
      } ]
    }, {
      "description" : "description",
      "isStarred" : true,
      "id" : 6.027456183070403,
      "title" : "title",
      "contacts" : [ {
        "number" : "number",
        "fullName" : "fullName",
        "id" : 6.027456183070403,
        "isDND" : true
      }, {
        "number" : "number",
        "fullName" : "fullName",
        "id" : 6.027456183070403,
        "isDND" : true
      } ]
    } ],
    "message" : "message",
    "status" : "status"
  }

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

group data with added contacts Group_AddContactsToGroup_200_response

404

Transaction_getAllTransaction_404_response

500

Transaction_getAllTransaction_404_response

POST /v1/groups/{userId}

Creates a group for a user (groupCreateGroup)

Path parameters

userId (required)

Path Parameter — default: null

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

GroupCreation GroupCreation (required)

Body Parameter

Content-Type: application/json

{
    "title": "Sample Title",
    "description": "Optional description text"
  }

Return type

Group_CreateGroup_201_response

Example data

Content-Type: application/json

{
    "code" : 0.8008281904610115,
    "message" : "message",
    "status" : "status"
  }

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

201

Group object created Group_CreateGroup_201_response

404

Transaction_getAllTransaction_404_response

500

Transaction_getAllTransaction_404_response

DELETE /v1/groups/{groupId}

PUT /v1/groups/{groupId}

Edits a group (groupEditGroup)

Path parameters

groupId (required)

Path Parameter — default: null

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

GroupCreation GroupCreation (required)

Body Parameter

Content-Type: application/json

{
    "title": "Sample Title",
    "description": "Optional description text"
  }

Return type

Group_CreateGroup_201_response

Example data

Content-Type: application/json

{
    "code" : 0.8008281904610115,
    "message" : "message",
    "status" : "status"
  }

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

group data Group_CreateGroup_201_response

404

Transaction_getAllTransaction_404_response

500

Transaction_getAllTransaction_404_response

GET /v1/groups/{userId}

Gets all groups for a user (groupGetAllGroups)

Path parameters

userId (required)

Path Parameter — default: null

Query parameters

starred (required)

Query Parameter — default: null

page (required)

Query Parameter — default: null

take (required)

Query Parameter — default: null

Return type

Group_GetAllGroups_200_response

Example data

Content-Type: application/json

{
    "code" : 0.8008281904610115,
    "data" : [ {
      "description" : "description",
      "isStarred" : true,
      "id" : 6.027456183070403,
      "title" : "title",
      "contacts" : [ {
        "number" : "number",
        "fullName" : "fullName",
        "id" : 6.027456183070403,
        "isDND" : true
      }, {
        "number" : "number",
        "fullName" : "fullName",
        "id" : 6.027456183070403,
        "isDND" : true
      } ]
    }, {
      "description" : "description",
      "isStarred" : true,
      "id" : 6.027456183070403,
      "title" : "title",
      "contacts" : [ {
        "number" : "number",
        "fullName" : "fullName",
        "id" : 6.027456183070403,
        "isDND" : true
      }, {
        "number" : "number",
        "fullName" : "fullName",
        "id" : 6.027456183070403,
        "isDND" : true
      } ]
    } ],
    "message" : "message",
    "status" : "status"
  }

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

paginated response of groups Group_GetAllGroups_200_response

404

Transaction_getAllTransaction_404_response

500

Transaction_getAllTransaction_404_response

GET /v1/group-cost/{groupId}

Gets a cost summary for sending message to a group (groupGetCostSummaryForGroup)

Path parameters

groupId (required)

Path Parameter — default: null

Return type

Contact_GetCostSummaryForGroup_200_response

Example data

Content-Type: application/json

{
    "code" : 0.8008281904610115,
    "message" : "message",
    "status" : "status"
  }

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Cost summary data Contact_GetCostSummaryForGroup_200_response

404

Transaction_getAllTransaction_404_response

500

Transaction_getAllTransaction_404_response

GET /v1/groups/{userId}/{groupId}

Gets a group for a user (groupGetGroup)

Path parameters

userId (required)

Path Parameter — default: null

groupId (required)

Path Parameter — default: null

Return type

Group_CreateGroup_201_response

Example data

Content-Type: application/json

{
    "code" : 0.8008281904610115,
    "message" : "message",
    "status" : "status"
  }

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

group data Group_CreateGroup_201_response

404

Transaction_getAllTransaction_404_response

500

Transaction_getAllTransaction_404_response

POST /v1/group-star/{groupId}

Stars a group (add to favourite groups) (groupStarGroup)

Path parameters

groupId (required)

Path Parameter — default: null

Query parameters

star (required)

Query Parameter — default: null

Return type

Group_CreateGroup_201_response

Example data

Content-Type: application/json

{
    "code" : 0.8008281904610115,
    "message" : "message",
    "status" : "status"
  }

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

group data Group_CreateGroup_201_response

404

Transaction_getAllTransaction_404_response

500

Transaction_getAllTransaction_404_response

Message

patch /v1/message/{userId}/archive

Archives exiting messages (messageArchiveMessages)

Path parameters

userId (required)

Path Parameter — default: null

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

number number (required)

Body Parameter —

Return type

Message_ArchiveMessages_200_response

Example data

Content-Type: application/json

{
    "code" : 0.8008281904610115,
    "data" : [ {
      "createdAt" : "2000-01-23T04:56:07.000+00:00",
      "senderId" : "senderId",
      "groups" : [ "{}", "{}" ],
      "id" : 6.027456183070403,
      "state" : "state",
      "content" : "content",
      "scheduledAt" : "2000-01-23T04:56:07.000+00:00",
      "contacts" : [ "{}", "{}" ],
      "status" : "status",
      "updatedAt" : "2000-01-23T04:56:07.000+00:00"
    }, {
      "createdAt" : "2000-01-23T04:56:07.000+00:00",
      "senderId" : "senderId",
      "groups" : [ "{}", "{}" ],
      "id" : 6.027456183070403,
      "state" : "state",
      "content" : "content",
      "scheduledAt" : "2000-01-23T04:56:07.000+00:00",
      "contacts" : [ "{}", "{}" ],
      "status" : "status",
      "updatedAt" : "2000-01-23T04:56:07.000+00:00"
    } ],
    "message" : "message",
    "status" : "status"
  }

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

message responses Message_ArchiveMessages_200_response

404

Transaction_getAllTransaction_404_response

500

Transaction_getAllTransaction_404_response

DELETE /v1/message/{userId}/delete-multiple

Deletes multiple messages (pass the ids in query) (messageDeleteMessages)

Path parameters

userId (required)

Path Parameter — default: null

Query parameters

ids (required)

Query Parameter — default: null

Return type

Message_ArchiveMessages_200_response

Example data

Content-Type: application/json

{
    "code" : 0.8008281904610115,
    "data" : [ {
      "createdAt" : "2000-01-23T04:56:07.000+00:00",
      "senderId" : "senderId",
      "groups" : [ "{}", "{}" ],
      "id" : 6.027456183070403,
      "state" : "state",
      "content" : "content",
      "scheduledAt" : "2000-01-23T04:56:07.000+00:00",
      "contacts" : [ "{}", "{}" ],
      "status" : "status",
      "updatedAt" : "2000-01-23T04:56:07.000+00:00"
    }, {
      "createdAt" : "2000-01-23T04:56:07.000+00:00",
      "senderId" : "senderId",
      "groups" : [ "{}", "{}" ],
      "id" : 6.027456183070403,
      "state" : "state",
      "content" : "content",
      "scheduledAt" : "2000-01-23T04:56:07.000+00:00",
      "contacts" : [ "{}", "{}" ],
      "status" : "status",
      "updatedAt" : "2000-01-23T04:56:07.000+00:00"
    } ],
    "message" : "message",
    "status" : "status"
  }

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

message responses Message_ArchiveMessages_200_response

404

Transaction_getAllTransaction_404_response

500

Transaction_getAllTransaction_404_response

POST /v1/message/{userId}/draft

Drafts a message to send to receipients (group or/and contacts) (messageDraftMessage)

Path parameters

userId (required)

Path Parameter — default: null

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

MessageCreation MessageCreation (required)

Body Parameter

Content-Type: application/json

{
    "content": "Reminder: Your appointment is scheduled for tomorrow.",
    "senderId": "XYZ789",
    "scheduledAt": "2025-02-18T15:30:00Z",
    "contactids": [1234.56],
    "groupids": [7890.12],
    "numbers": ["+1987654321"]
  }

Return type

Message_GetMessage_200_response

Example data

Content-Type: application/json

{
    "code" : 0.8008281904610115,
    "message" : "message",
    "status" : "status"
  }

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

201

Message response object Message_GetMessage_200_response

404

Transaction_getAllTransaction_404_response

500

Transaction_getAllTransaction_404_response

PUT /v1/message/{userId}/edit/{messageId}

Edits an existing message (Please pass all keys) (messageEditMessage)

Path parameters

userId (required)

Path Parameter — default: null

messageId (required)

Path Parameter — default: null

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

MessageCreation MessageCreation (required)

Body Parameter

Content-Type: application/json

{
    "content": "Sample message",
    "senderId": "ABC123",
    "scheduledAt": "2025-02-18T12:00:00Z",
    "contactids": [1001.5],
    "groupids": [4004.2],
    "numbers": ["+123456789"]
  }

Return type

Message_GetMessage_200_response

Example data

Content-Type: application/json

{
    "code" : 0.8008281904610115,
    "message" : "message",
    "status" : "status"
  }

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Message response object Message_GetMessage_200_response

404

Transaction_getAllTransaction_404_response

500

Transaction_getAllTransaction_404_response

GET /v1/message/{userId}/{messageId}

Gets a single message (messageGetMessage)

Path parameters

userId (required)

Path Parameter — default: null

messageId (required)

Path Parameter — default: null

Return type

Message_GetMessage_200_response

Example data

Content-Type: application/json

{
    "code" : 0.8008281904610115,
    "message" : "message",
    "status" : "status"
  }

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Message response object Message_GetMessage_200_response

404

Transaction_getAllTransaction_404_response

500

Transaction_getAllTransaction_404_response

GET /v1/message/{userId}

Gets all messages (messageGetMessages)

Path parameters

userId (required)

Path Parameter — default: null

Query parameters

page (required)

Query Parameter — default: null

take (required)

Query Parameter — default: null

state (optional)

Query Parameter — default: null

Return type

Message_GetMessages_200_response

Example data

Content-Type: application/json

{
    "code" : 0.8008281904610115,
    "data" : [ {
      "createdAt" : "2000-01-23T04:56:07.000+00:00",
      "senderId" : "senderId",
      "groups" : [ "{}", "{}" ],
      "id" : 6.027456183070403,
      "state" : "state",
      "content" : "content",
      "scheduledAt" : "2000-01-23T04:56:07.000+00:00",
      "contacts" : [ "{}", "{}" ],
      "status" : "status",
      "updatedAt" : "2000-01-23T04:56:07.000+00:00"
    }, {
      "createdAt" : "2000-01-23T04:56:07.000+00:00",
      "senderId" : "senderId",
      "groups" : [ "{}", "{}" ],
      "id" : 6.027456183070403,
      "state" : "state",
      "content" : "content",
      "scheduledAt" : "2000-01-23T04:56:07.000+00:00",
      "contacts" : [ "{}", "{}" ],
      "status" : "status",
      "updatedAt" : "2000-01-23T04:56:07.000+00:00"
    } ],
    "message" : "message",
    "status" : "status"
  }

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Array of Message response objects Message_GetMessages_200_response

404

Transaction_getAllTransaction_404_response

500

Transaction_getAllTransaction_404_response

GET /v1/message-senders/{userId}

Gets all senderIds (messageGetSenderIds)

Path parameters

userId (required)

Path Parameter — default: null

Return type

Message_GetSenderIds_200_response

Example data

Content-Type: application/json

{
    "code" : 0.8008281904610115,
    "data" : [ {
      "createdAt" : "2000-01-23T04:56:07.000+00:00",
      "senderId" : "senderId",
      "id" : 6.027456183070403,
      "updatedAt" : "2000-01-23T04:56:07.000+00:00",
      "status" : "status"
    }, {
      "createdAt" : "2000-01-23T04:56:07.000+00:00",
      "senderId" : "senderId",
      "id" : 6.027456183070403,
      "updatedAt" : "2000-01-23T04:56:07.000+00:00",
      "status" : "status"
    } ],
    "message" : "message",
    "status" : "status"
  }

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Array of Message response objects Message_GetSenderIds_200_response

404

Transaction_getAllTransaction_404_response

500

Transaction_getAllTransaction_404_response

POST /v1/message-price/{userId}

Gets the price of sending a message (messageMessagePrice)

Path parameters

userId (required)

Path Parameter — default: null

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

MessageCreation MessageCreation (required)

Body Parameter

Content-Type: application/json

{
    "content": "Hello, this is a sample message",
    "senderId": "XYZ789",
    "scheduledAt": "2025-02-18T15:30:00Z",
    "contactids": [1234.56],
    "groupids": [7890.12],
    "numbers": ["+1987654321"]
  }

Return type

Message_MessagePrice_200_response

Example data

Content-Type: application/json

{
    "code" : 0.8008281904610115,
    "message" : "message",
    "status" : "status"
  }

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Message cost summary object Message_MessagePrice_200_response

404

Transaction_getAllTransaction_404_response

500

Transaction_getAllTransaction_404_response

POST /v1/message/{userId}/schedule

Schedules a new message to send to receipients (group or/and contacts) (messageSchduleMessage)

Path parameters

userId (required)

Path Parameter — default: null

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

MessageCreation MessageCreation (required)

Body Parameter

Content-Type: application/json

{
    "content": "Sample message content",
    "senderId": "ABC123",
    "scheduledAt": "2025-02-18T12:00:00Z",
    "contactids": [1001.5],
    "groupids": [4004.2],
    "numbers": ["+123456789"]
  }

Return type

Message_GetMessage_200_response

Example data

Content-Type: application/json

{
    "code" : 0.8008281904610115,
    "message" : "message",
    "status" : "status"
  }

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

201

Message response object Message_GetMessage_200_response

404

Transaction_getAllTransaction_404_response

500

Transaction_getAllTransaction_404_response

POST /v1/message/{userId}/schedule-existing

Schedules an existing message to send to receipients (group or/and contacts) (messageSchduleMessageExisting)

Path parameters

userId (required)

Path Parameter — default: null

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

ScheduleExisting ScheduleExisting (required)

Body Parameter

Content-Type: application/json

{
"messageId": 12345.67,
"scheduleDate": "2025-02-18T12:00:00Z"
}

Return type

Message_GetMessage_200_response

Example data

Content-Type: application/json

{
    "code" : 0.8008281904610115,
    "message" : "message",
    "status" : "status"
  }

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

201

Message response object Message_GetMessage_200_response

404

Transaction_getAllTransaction_404_response

500

Transaction_getAllTransaction_404_response

GET /v1/search-message/{userId}

Gets all messages by search (messageSearchMessages)

Path parameters

userId (required)

Path Parameter — default: null

Query parameters

searchTerm (required)

Query Parameter — default: null

Return type

Message_ArchiveMessages_200_response

Example data

Content-Type: application/json

{
    "code" : 0.8008281904610115,
    "data" : [ {
      "createdAt" : "2000-01-23T04:56:07.000+00:00",
      "senderId" : "senderId",
      "groups" : [ "{}", "{}" ],
      "id" : 6.027456183070403,
      "state" : "state",
      "content" : "content",
      "scheduledAt" : "2000-01-23T04:56:07.000+00:00",
      "contacts" : [ "{}", "{}" ],
      "status" : "status",
      "updatedAt" : "2000-01-23T04:56:07.000+00:00"
    }, {
      "createdAt" : "2000-01-23T04:56:07.000+00:00",
      "senderId" : "senderId",
      "groups" : [ "{}", "{}" ],
      "id" : 6.027456183070403,
      "state" : "state",
      "content" : "content",
      "scheduledAt" : "2000-01-23T04:56:07.000+00:00",
      "contacts" : [ "{}", "{}" ],
      "status" : "status",
      "updatedAt" : "2000-01-23T04:56:07.000+00:00"
    } ],
    "message" : "message",
    "status" : "status"
  }

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Array of Message response objects Message_ArchiveMessages_200_response

404

Transaction_getAllTransaction_404_response

500

Transaction_getAllTransaction_404_response

POST /v1/message/{userId}/send

Sends a message to the receipients (group or/and contacts) (messageSendMessage)

Path parameters

userId (required)

Path Parameter — default: null

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

MessageCreation MessageCreation (required)

Body Parameter

Content-Type: application/json

{
    "content": "Sample message content",
    "senderId": "ABC123",
    "scheduledAt": "2025-02-18T12:00:00Z",
    "contactids": [1001.5],
    "groupids": [4004.2],
    "numbers": ["+123456789"]
  }

Return type

Message_GetMessage_200_response

Example data

Content-Type: application/json

{
    "code" : 0.8008281904610115,
    "message" : "message",
    "status" : "status"
  }

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Message response object Message_GetMessage_200_response

404

Transaction_getAllTransaction_404_response

500

Transaction_getAllTransaction_404_response

Transaction

GET /api/v1/transaction/{userId}

Gets a list of transaction for this user (transactionGetAllTransaction)

Path parameters

userId (required)

Path Parameter — default: null

Query parameters

page (required)

Query Parameter — default: null

take (required)

Query Parameter — default: null

startDate (required)

Query Parameter — default: null format: date-time

EndDate (required)

Query Parameter — default: null format: date-time

Return type

Transaction_getAllTransaction_200_response

Example data

Content-Type: application/json

{
    "code" : 0.8008281904610115,
    "data" : [ {
      "createdAt" : "2000-01-23T04:56:07.000+00:00",
      "amount" : 1.4658129805029452,
      "unit" : "unit",
      "description" : "description",
      "action" : "action",
      "id" : 6.027456183070403,
      "value" : 5.962133916683182,
      "status" : "status",
      "updatedAt" : "2000-01-23T04:56:07.000+00:00"
    }, {
      "createdAt" : "2000-01-23T04:56:07.000+00:00",
      "amount" : 1.4658129805029452,
      "unit" : "unit",
      "description" : "description",
      "action" : "action",
      "id" : 6.027456183070403,
      "value" : 5.962133916683182,
      "status" : "status",
      "updatedAt" : "2000-01-23T04:56:07.000+00:00"
    } ],
    "message" : "message",
    "status" : "status"
  }

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Data description of a transation Transaction_getAllTransaction_200_response

404

Transaction_getAllTransaction_404_response

500

String

data (optional)

array[ContactQuery]

meta (optional)

Object

`ContactCreation` : Up

fullName (optional)

String

number

String

`ContactQuery` : Up

BigDecimal

fullName

String

number

String

isDND

Boolean

`ContactSummary` : Up

starredGroups

array[String] Holds 9 starred groups names/titles

contactCount

BigDecimal Number of contacts for a user

groupCount

BigDecimal Number of groups for a user

`CostSummaryQuery` : Up

dNDCount

BigDecimal

costForDND

BigDecimal

nonDNDCount

BigDecimal

costForNonDND

BigDecimal

totalCost

BigDecimal

`Group_AddContactsToGroup_200_response` : Up

status

String

code

BigDecimal

message

String

data (optional)

array[GroupQuery]

`Group_CreateGroup_201_response` : Up

status

String

code

BigDecimal

message

String

data (optional)

Object

`Group_GetAllGroups_200_response` : Up

status

String

code

BigDecimal

message

String

data (optional)

array[GroupQuery]

meta (optional)

Object

`GroupCreation` : Up

title

String

description (optional)

String

`GroupQuery` : Up

BigDecimal

title

String

description

String

isStarred

Boolean

contacts

array[ContactQuery]

`Message_ArchiveMessages_200_response` : Up

status

String

code

BigDecimal

message

String

data (optional)

array[MessageQuery]

`Message_GetMessage_200_response` : Up

status

String

code

BigDecimal

message

String

data (optional)

Object

`Message_GetMessages_200_response` : Up

status

String

code

BigDecimal

message

String

data (optional)

array[MessageQuery]

meta (optional)

Object

`Message_GetSenderIds_200_response` : Up

status

String

code

BigDecimal

message

BigDecimal

content

String

senderId

String

state

String

status

String

scheduledAt

Date format: date-time

updatedAt

Date format: date-time

createdAt

Date format: date-time

contacts

array[MessageContact]

groups

array[MessageGroup]

`MessageQueryParam` : Up

state (optional)

String

`PaginationMeta` : Up

page

BigDecimal

count

BigDecimal

isDND

Boolean

groups

array[String]

cost

BigDecimal

`StandardResponse` : Up

status

String

code

BigDecimal

message

String

`Transaction_getAllTransaction_200_response` : Up

status

String

code

BigDecimal

message

String

data (optional)

array[TransactionQuery]

meta (optional)

Object

`Transaction_getAllTransaction_404_response` : Up

status

String

code

BigDecimal

message

String

data (optional)

String

`TransactionQuery` : Up

BigDecimal

amount

BigDecimal Amount in Naira

value

BigDecimal number of units

description

String Transaction details

status

String Transaction status

action

String Action

unit

String Unit

updatedAt

Date Date of completion or cancellation format: date-time

createdAt

Date Date of creation format: date-time

`TransactionQueryParam` : Up

startDate

Date format: date-time

EndDate

Date format: date-time

`TransactionQueryParam` : Up

startDate

Date format: date-time

EndDate

Date format: date-time