Get SMS Campaign Report

The method allows you to get detailed information about the campaign with the statistics of messages sent.

Request URL

GET http://one-api.bsg.world/api/campaigns/{id}/detail

Request parameters:

Parameter

Required

Type

Default

Description

Yes

integer

Campaign ID created using:

POST /api/campaigns/sms/send

POST /api/campaigns/sms/send-groups

POST /api/campaigns/sms/send-individual

Response parameters

Parameter		Type	Description
id		integer	ID of the task created for a bulk campaign
name		string	Campaign name
sender		string	SMS Sender name
status		string	Campaign current status. Possible values: creation – created spam – campaign did not pass moderation scheduled – campaign is scheduled sending – campaign began to be sent paused – campaign is paused stopped – campaign is stopped done – campaign is completed
type		string	campaign type – sms
start_date		string	Date and time of the campaign start (scheduled). Format ISO 8601: yyyy-mm-dd hh:mm:ss
actual_start_at		string	Actual date and time the campaign started. Format ISO 8601: yyyy-mm-dd hh:mm:ss
finished_at		string	Date and time the campaign is completed. Format ISO 8601: yyyy-mm-dd hh:mm:ss
created_at		string	Date and time the campaign is created. Format ISO 8601: yyyy-mm-dd hh:mm:ss
statistics		object	Campaign statistics containing:
	delivered	integer	Number of messages received by the recipient
	scheduled	integer	Number of messages scheduled for the campaign
	moderation	integer	Number of messages in moderation
	accepted	integer	Number of messages accepted by the operator
	sending	integer	Number of messages in the queue for sending
	sent	integer	Number of messages that have been sent and are expecting to be delivered
	expired	integer	Number of undelivered messages (phone switched off)
	failed	integer	Number of messages with a send error (probably a missing prefix)
	undelivered	integer	Number of undelivered messages
	unknown	integer	Number of messages for which there is no delivery report
total_messages		integer	Total number of messages created within the campaign
total_phones		integer	Number of contacts in the campaign
total_price		string	Total campaign price
currency		string	The currency in which the campaign cost is specified. ISO 4217 format

Response sample

If the request is successful, you will receive a response:

{
 "data": {
   “id”: “12345”,
   “name”: “string”
   “sender”: “testsms”,
   “status”: “done”,
   “type”: “instant”,
   “start_at”: “2022-01-01 00:01:02”,
   “actual_start_at”: “2022-01-01 00:01:03”,
   “creation_at”: “2022-01-01 00:00:01”,
   “finished_at”: “2022-01-01 00:10:03”,
   “statistics”: [
{ 
  “delivered”: 0,
  “scheduled”: 0,
  “moderation”: 0,
  “accepted”: 0,
  “sending”: 20,
  “sent”: 100,
  “expired”: 0,
  “failed”: 0,
  “undelivered”: 0,
  “unknown”: 0
}
]
   “total_messages”: 120,
   “total_phones”: 120,
   “total_price”: “35,0987645”,
   “currency”: “USD”
}
}