SpeedPayamak API (1.0.1)

Download OpenAPI specification:Download

SpeedPayamak API doc
api-key format: Authorization: "AccessKey your-api-key"

Authentication

ApiKeyAuth

Security Scheme Type	API Key
Header parameter name:	Authorization

auth

GetAuthorizedUser

get authorized user

Responses

200

ok

401

unauthorized

get /v1/user

http://rest.ippanel.com/v1/user

Response samples

200
401

Content type

application/json

Copy

Expand all Collapse all


{"status": "OK",
"code": 200,
"message": "Ok",
"data": 
{"user": 
{"id": 1,
"username": "admin",
"name": "sdfsdf",
"email": "asd@asd.asda",
"document_block": "yes",
"send_block": "yes",
"mobile": "12323",
"tellephone": "123123",
"national_id": "aasda",
"certificate_id": "asdad",
"address": "sdf",
"postal_code": "123",
"company": "sdf",
"expire": "2017-01-01T00:00:00Z",
"status": "active"
}
}
}

credit

GetCredit

get user credit

Responses

200

ok

401

unauthorized

get /v1/credit

http://rest.ippanel.com/v1/credit

Response samples

200
401

Content type

application/json

Copy

Expand all Collapse all


{"status": "OK",
"code": 200,
"message": "Ok",
"data": 
{"credit": 9999937780
}
}

messages

SendSMS

send SMS

Request Body schema: application/json

parameters

originator required	string your line number to send message from that
recipients required	Array of strings recipients number
message required	string message to send

Responses

200

ok

401

unauthorized

post /v1/messages

http://rest.ippanel.com/v1/messages

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"originator": "+9850002",
"recipients": 
["989123456789",
"989125554433"
],
"message": "ippanel is awesome"
}

Response samples

200
401

Content type

application/json

Copy

Expand all Collapse all


{"value": 
{"status": "OK",
"code": 200,
"message": "Ok",
"data": 
{"bulk_id": 52738692
}
}
}

CreatePattern

create message pattern

Request Body schema: application/json

parameters

pattern required	string pattern template
description	string pattern description
is_shared	boolean determine that pattern shared or not

Responses

200

ok

401

unauthorized

post /v1/messages/patterns

http://rest.ippanel.com/v1/messages/patterns

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"pattern": "Hello %name%",
"description": "greeter pattern",
"is_shared": false
}

Response samples

200
401

Content type

application/json

Copy

Expand all Collapse all


{"value": 
{"status": "OK",
"code": 200,
"message": "Ok",
"data": 
{"pattern": 
{"code": "6gr7ngjmhi",
"status": "pending",
"message": "salam %name%!",
"is_shared": false
}
}
}
}

SendPattern

send pattern SMS

Request Body schema: application/json

parameters

pattern_code required	string pattern code
originator required	string your line number to send message from that
recipient required	string recipient number
values required	object pattern values

Responses

200

ok

401

unauthorized

post /v1/messages/patterns/send

http://rest.ippanel.com/v1/messages/patterns/send

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"pattern_code": "t2cfmnyo0c",
"originator": "+9850002",
"recipient": "+989123459900",
"values": 
{"name": "Mohamad"
}
}

Response samples

200
401

Content type

application/json

Copy

Expand all Collapse all


{"value": 
{"status": "OK",
"code": 200,
"message": "Ok",
"data": 
{"bulk_id": 52738692
}
}
}

GetSMS

get a sms properties

path Parameters

bulk_id

required

integer <int64>

Example: 52738671

Responses

200

ok

401

unauthorized

get /v1/messages/{bulk_id}

http://rest.ippanel.com/v1/messages/{bulk_id}

Response samples

200
401

Content type

application/json

Copy

Expand all Collapse all


{"status": "OK",
"code": 200,
"message": "Ok",
"data": 
{"message": 
{"bulk_id": 52738671,
"number": "+9850002",
"message": "Hello from me",
"status": "active",
"type": "webservice",
"confirm_state": "",
"created_at": "2019-12-07T13:34:06Z",
"sent_at": "2019-12-07T13:34:06Z",
"recipients_count": 1,
"valid_recipients_count": 0,
"page": 1,
"cost": 0,
"payback_cost": 0,
"description": "single send"
}
}
}

GetMessageRecipientsStatus

get a sms recipients status

path Parameters

bulk_id

required

integer <int64>

Example: 52738671

query Parameters

page	integer <uint64> Example: page=0
limit	integer <int64> Example: limit=10

Responses

200

ok

401

unauthorized

get /v1/messages/{bulk_id}/recipients

http://rest.ippanel.com/v1/messages/{bulk_id}/recipients

Response samples

200
401

Content type

application/json

Copy

Expand all Collapse all


{"status": "OK",
"code": 200,
"message": "Ok",
"data": 
{"recipients": 
[
{"recipient": "+98912345xxxx",
"status": "send"
}
]
},
"meta": 
{"total": 1,
"pages": 1,
"limit": 1,
"page": 0,
"prev": null,
"next": null
}
}

FetchInboxMessages

fetch inbox messages

query Parameters

page	integer <uint64> Example: page=0
limit	integer <int64> Example: limit=10

Responses

200

ok

401

unauthorized

get /v1/messages/inbox

http://rest.ippanel.com/v1/messages/inbox

Response samples

200
401

Content type

application/json

Copy

Expand all Collapse all


{"status": "OK",
"code": 200,
"message": "Ok",
"data": 
{"messages": 
[
{"number": "+98100020400",
"message": "سشیسشیسشیسش",
"sender": "5555",
"time": "1970-01-01T04:05:55Z",
"type": "normal"
}
]
},
"meta": 
{"total": 1,
"pages": 1,
"limit": 1,
"page": 0,
"prev": null,
"next": null
}
}