- Clone the repo onto your machine
- Rename
.env.exampleto.env - Create a postgres database and add it url in the
.envfile - Run the database migrations with the
yarn migratecommand - Run
yarn startto start the application.
Below is the API document. You can also find it here in a postman collection.
To create a contact send a payload to the endpoint below.
/api/v1/contacts
Payload example:
{
"name": "John kagga",
"phoneNumber": "0789525579"
}
Response:
{
"status": "success",
"data": {
"id": 4,
"name": "John kagga",
"phoneNumber": "0789525579",
"updatedAt": "2018-10-03T18:47:12.255Z",
"createdAt": "2018-10-03T18:47:12.255Z"
},
"message": "Contact successfully created"
}
Use the endpoint below to get a list of all the contacts in the system.
/api/v1/contacts
Response:
{
"status": "success",
"data": [
{
"id": 1,
"name": "John",
"phoneNumber": "0789525579",
"createdAt": "2018-10-03T09:46:55.416Z",
"updatedAt": "2018-10-03T09:46:55.416Z"
},
{
7C3A
"id": 3,
"name": "Kagga",
"phoneNumber": "0789525592",
"createdAt": "2018-10-03T18:35:22.387Z",
"updatedAt": "2018-10-03T18:35:22.387Z"
},
{
"id": 4,
"name": "Mary",
"phoneNumber": "0789525591",
"createdAt": "2018-10-03T18:47:12.255Z",
"updatedAt": "2018-10-03T18:47:12.255Z"
}
]
}
This is the endpoint for sending a message where contactId is the contact Id
/api/v1/contacts/:contactId/sms
Below is the payload to send when creating a message where receiverId is the contact id of message recipient.
{
"text": "come home tomorrow",
"receiverId": 1
}
Response:
{
"status": "Success",
"data": {
"id": 3,
"text": "come home tomorrow",
"receiverId": 1,
"senderId": 2,
"status": true,
"updatedAt": "2018-10-04T06:32:54.349Z",
"createdAt": "2018-10-04T06:32:54.349Z"
},
"message": "Message sent successfully"
}
Deleting a contact deletes all the messages it references in the entire application.
Send a Delete request with the contactId to the endpoint below.
/api/v1/contacts/:contactId
Response:
{
"status": "success",
"message": "Contact has been deleted together with all the messages it references"
}
Send a GET request to the endpoint below
/api/v1/contacts/:contactId/sent/sms
Response:
{
"status": "success",
"data": [
{
"id": 7,
"text": "Yo man tomorrow",
"status": true,
"createdAt": "2018-10-04T12:46:45.593Z",
"updatedAt": "2018-10-04T12:46:45.593Z",
"senderId": 3,
"receiverId": 1
},
{
"id": 8,
"text": "Go away",
"status": true,
"createdAt": "2018-10-04T12:46:54.890Z",
"updatedAt": "2018-10-04T12:46:54.890Z",
"senderId": 3,
"receiverId": 1
}
],
"message": "Successfully returned messages sent by a contact with Id 3"
}
Send a GET request to the endpoint below
/api/v1/contacts/:contactId/received/sms
Response:
{
"status": "success",
"data": [
{
"id": 5,
"text": "come home tomorrow",
"status": true,
"createdAt": "2018-10-04T09:48:22.626Z",
"updatedAt": "2018-10-04T09:48:22.626Z",
"senderId": 4,
"receiverId": 1
},
{
"id": 6,
"text": "Yo man tomorrow",
"status": true,
"createdAt": "2018-10-04T09:48:38.827Z",
"updatedAt": "2018-10-04T09:48:38.827Z",
"senderId": 4,
"receiverId": 1
}
],
"message": "Successfully returned messages received by 1"
}
Send a DELETE request to the endpoint below
/api/v1/contacts/:contactId/sms/:messageId
Response:
{
"status": "success",
"message": "Message deleted successfully"
}