Get SMS campaign

GET

https://api.jokoor.com/v1/sms/campaigns/{id}

Last modified:2025-11-15 15:49:01

Maintainer:Not configured

OperationId:getSMSCampaign

Get details of a specific SMS campaign

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Path Params

Responses

🟢200OK

application/json

Campaign details

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.jokoor.com/v1/sms/campaigns/' \
--header 'Authorization: Bearer <token>'

Response Example

{
    "data": {
        "id": "string",
        "organization_id": "string",
        "name": "string",
        "message_template_id": "string",
        "sender_id_config_id": "string",
        "status": "draft",
        "scheduled_at": "2019-08-24T14:15:22Z",
        "started_at": "2019-08-24T14:15:22Z",
        "completed_at": "2019-08-24T14:15:22Z",
        "created_by": "string",
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "details": {
            "total_message_count": 0,
            "total_sent_messages": 0,
            "total_failed_messages": 0,
            "total_pending_messages": 0,
            "total_segments_used": 0,
            "delivery_rate": 0,
            "failure_rate": 0,
            "pending_rate": 0,
            "status_breakdown": {
                "property1": 0,
                "property2": 0
            }
        },
        "metadata": {}
    }
}

Modified at 2025-11-15 15:49:01

List SMS campaigns

Update SMS campaign