Description of API requirements

General description

Call Information:

We can provide the following details for each call:

 • Caller: The phone number or name of the calling party.

 • Receiver: The phone number or name of the receiving party.

 • DateTime: The timestamp of the call.

 • Call Type: Indicates whether the call was incoming or outgoing.

 • Name (optional): If required, the associated name can be included.

 • User: The user in your system assigned to the phone.

 • Waiting Time: The time the caller waited before the call was answered.

 • Duration: The total duration of the call.

Call Recordings:

We can share call recordings in one of the following ways:

 1. Provide a download link for you to access the recordings.

 2. Upload the recordings to a location of your choice, based on a link you provide.

User Mapping:

If your system requires user-specific configurations and has multiple users associated with an account, we would need a comprehensive list of your users within account. This will enable us to map SipSim SIM cards to the appropriate users in your application.

Authentication:

To access your API, please provide details on how each user can securely obtain a token for authentication.

Additional Requirements:

Please let us know if there are any specific details or additional requirements to ensure a seamless integration.

API example

You can customize the provided example by adding additional details or supplying an alternative API if needed. 

1. Create Call

Creates a call record with specified details and provides a file upload link for associated call recordings or files.

Endpoint:

POST /call

Parameters:

Request Example:

POST /call HTTP/1.1

Content-Type: application/json

{
    "user": "user123",
    "datetime": "2024-12-12T10:00:00Z",
    "direction": "inbound"
}

Response Example (Success (201 Created)): 

{
    "id": "call789",
    "user": "user123",
    "datetime": "2024-12-12T10:00:00Z",
    "direction": "inbound",
    "status": "created",
    "upload_link": "https://api.example.com/upload?call_id=call789"
}

2. Upload File

Uploads a file to the server for an associated call.

Endpoint:

POST /upload

Query Parameters:

Request Example:

Form-Data:

POST /upload?call_id=call789 HTTP/1.1

Content-Type: multipart/form-data

file: (binary file data)

Response Example:

Success (201 Created)