Skip to content

Interface: SendSMSResponse

Defined in: types.ts:31

Response returned after sending an SMS campaign.

Properties

code

ts
code: string;

Defined in: types.ts:35

Response code from the API.


message

ts
message: string;

Defined in: types.ts:37

Human-readable response message.


status

ts
status: string;

Defined in: types.ts:33

Status of the send request.


summary

ts
summary: {
  _id: string;
  contacts: number;
  credit_left: number;
  credit_used: number;
  message_id: string;
  numbers_sent: string[];
  total_rejected: number;
  total_sent: number;
  type: string;
};

Defined in: types.ts:39

Summary of the SMS campaign results.

NameTypeDefined in
_idstringtypes.ts:40
contactsnumbertypes.ts:44
credit_leftnumbertypes.ts:48
credit_usednumbertypes.ts:47
message_idstringtypes.ts:41
numbers_sentstring[]types.ts:46
total_rejectednumbertypes.ts:45
total_sentnumbertypes.ts:43
typestringtypes.ts:42