Get SMS Log
Get SMS log
Retrieve SMS message logs of a given project.
Note: The date range between
fromDateandtoDatecannot exceed 3 months. Results are ordered chronologically bysendtime_utc.
| Request | |
|---|---|
| Method | GET |
| Resource | https://[customer].asp.virtual-call-center.eu/v2/projects/[projectid]/sms |
| Options | fromDate, toDate, direction, templateId, start, limit |
| Body | N/A |
| Response | |
| Body | Array of SMS log records filtered by options, encoded in JSON. |
Request
Resource parameters
| Name | Type | Mandatory | Comment |
|---|---|---|---|
| customer | string | yes | Your account name. |
| projectid | integer | yes | Unique project identifier. |
Options
| Name | Type | Comment |
|---|---|---|
| fromDate | string | Start date of the queried time range. Mandatory. Format: YYYY-MM-DD. |
| toDate | string | End date of the queried time range (inclusive). Mandatory. Format: YYYY-MM-DD. Cannot be earlier than fromDate. The time interval between fromDate and toDate cannot exceed 3 months. |
| direction | string | Filter SMS logs by message direction. Optional. Possible values: in (inbound), out (outbound). |
| templateId | integer | Filter SMS logs by specific SMS template identifier. Optional. |
| start | integer | Specifies the offset of the first record for pagination. Optional, default: 0. |
| limit | integer | Specifies the maximum number of records to return. Optional, default: 50. |
Response
Response object
| Name | Type | Comment |
|---|---|---|
| rows | array of objects | List of SMS log records matching the filter criteria. |
| totalCount | integer | Total number of records matching the query. |
SMS log object (row)
| Name | Type | Comment |
|---|---|---|
| numberid | integer | Unique identifier of the SMS message log entry. |
| phone_a | string | Sender phone number or alphanumeric Sender ID (CLI). |
| phone_b | string | Recipient phone number. |
| message | string | Text content of the SMS message. |
| direction | string | Direction of the SMS (in for inbound, out for outbound). |
| success | integer | Delivery status indicator (1 for success, 0 for failure). |
| sendtime_utc | string | The time and date when the SMS was sent, in UTC. Format: YYYY-MM-DD hh:mm:ss |
| timestamp | string | Timestamp of the event log entry. Format: YYYY-MM-DD hh:mm:ss |
| templateid | integer | null | Identifier of the SMS template used, or null if no template was used. |
| template_name | string | null | Name of the SMS template used, or null if no template was used. |
| userid | integer | Identifier of the user/agent who sent the SMS, or 0 if triggered by system. |
| agent_name | string | null | Name of the agent who sent the SMS, or null if sent by system. |
| fee_cur | string | Fee charged for the SMS in the account’s currency. |
Example
{
"response": {
"rows": [
{
"numberid": 1204454,
"phone_a": "VCCLive",
"phone_b": "36208445761",
"message": "Kedves Ügyfelünk! Emlékeztetjük, hogy holnap 8:30 órakor időpontja van nálunk. Lemondás: 06 1 555 0100",
"direction": "out",
"success": 0,
"sendtime_utc": "2026-11-01 07:02:53",
"timestamp": "2026-11-01 07:02:54",
"templateid": 1,
"template_name": "Teszt sablon",
"userid": 0,
"agent_name": null,
"fee_cur": "0.000000"
},
{
"numberid": 1034433,
"phone_a": "VCCLive",
"phone_b": "36702033725",
"message": "A szerződés aláírásához szükséges dokumentumokat a VCC-754835 azonosítóval találja meg az ügyfélkapuban.",
"direction": "out",
"success": 1,
"sendtime_utc": "2026-11-01 09:14:34",
"timestamp": "2026-11-01 09:14:44",
"templateid": null,
"template_name": null,
"userid": 13,
"agent_name": "Kovács Béla",
"fee_cur": "49.000000"
}
],
"totalCount": 71
},
"errors": []
}
Comments
Can’t find what you need? Use the comment section below to connect with others, get answers from our experts, or share your ideas with us.
There are no comments yet.