Hi-Send Docs

Get SMS History

https://core.hisend.hunnovate.com/api/v1/projects/{project_identifier_}/sms?api_key={api_key}

Get SMS messages sent in a project


Path Parameters

project_identifier string required

The identifier or id of the project, for example project_name or 01jtk9f6xtp5bqycmj8x68040f, you can get it from the projects page on your dashboard

Query Params

page string optional default to 1

Page number

per_page string optional default to 30

Number of projects per page

search string optional

Search in all projects by name or description

phone string optional

Filter by phone number

sort_by string optional default to created_at

Sort by created_at, delivered_at or failed_at

sort_direction string optional default to desc

Sort direction, can be asc or desc

status string optional

Filter by status, can be pending, sent, delivered, rejected, expired or failed

api_key string required

The api key from your dashboard

422 Error Response Example


{
    "message": "Error getting SMS messages",
}

200 Success Response Example


{
    "data": [
        {
            "id": "01jtk9f6xtp5bqycmj8x68040f",
            "phone": 1234567890,
            "message": "Hello World",
        },
        {
            "id": "01jtk9f6xtp5bqycmj8x68040g",
            "phone": 0987654321,
            "message": "Goodbye World",
        },
    ],
    "message": "SMS messages retrieved successfully",
}