Add Campaign Profile Resource

Overview

Add profile resources to a campaign in batch. This API allows you to add multiple eSIM profile metadata to an existing campaign for resource management and allocation.

API Information

• Environment: Production
• Base URL: https://rsp.simlessly.com/api/v1
• Endpoint: POST /open/campaign/resource/add
• Content-Type: application/json

Request

Request Parameters

Parameter	Type	Required	Description	Validation Rules	Example
metaDatas	Array	Yes	Profile metadata list	Array size: 1-1000 items	See below
campaignName	String	Yes	Campaign name in Simlessly platform	Non-empty string	XXX

Metadata Object Structure

Parameter	Type	Required	Description	Validation Rules	Example
iccid	String	Yes	Integrated Circuit Card Identifier	Length: 19-20 characters	89860468152080349618
imsi	String	Yes	International Mobile Subscriber Identity	Length: 15 characters	460048867619618
ki	String	Yes	Authentication Key	32 hexadecimal characters	6BE2053E8580B135CD43443380DB7111
opc	String	No	Operator Code	32 hexadecimal characters, can be null for test type	6BE2053E8580B135CD43443380DB7111
msisdn	String	No	Mobile Station International Directory Number	Max length: 15 characters	8613912345678
impi	String	No	IP Multimedia Private Identity	Valid IMS format	260036614799000@ims.mnc006.mcc260.3gppnetwork.org
impuList	Array	No	IP Multimedia Public Identity List	Array of IMS URIs	["sip:260036614799000@ims.mnc006.mcc260.3gppnetwork.org"]
c9	String	No	Applet Recycle Parameter (Simlessly pre-1.8.0)	Hexadecimal string	0C3C0302984D3E05212B9A81FC07992113329595FF0400080520
cc	String	No	Confirmation Code	4-digit string	1234
expireTime	String	No	Applet Recycle Parameter (Simlessly 1.8.0+)	Format: yyyy-MM-dd HH:mm:ss	2023-11-21 12:12:22

Example Request

{
   "campaignName": "templateRegualr01",
   "metaDatas": [
      {
         "iccid": "89860468152080349618",
         "imsi": "460048867619618",
         "ki": "6BE2053E8580B135CD43443380DB7111",
         "opc": "6BE2053E8580B135CD43443380DB7111",
         "msisdn": "8613912345678",
         "impi": "260036614799000@ims.mnc006.mcc260.3gppnetwork.org",
         "impuList": ["sip:260036614799000@ims.mnc006.mcc260.3gppnetwork.org"],
         "c9": "0C3C0302984D3E05212B9A81FC07992113329595FF0400080520",
         "cc": "1234",
         "expireTime": "2023-11-21 12:12:22"
      }
   ]
}

Response

Response Parameters

Parameter	Type	Required	Description	Example
success	Boolean	Yes	Operation result status	true
code	String	Yes	Response status code	"00000"
msg	String	Yes	Response message	""
obj	Object	No	Response data object	null

Success Response Example

{
  "obj": null,
  "success": true,
  "msg": "",
  "code": "00000"
}