Senders can be obtained programmatically via API through the endpoint /v1/settings/groups/{id}/senders.
Get the senders of a group
Use the GET method with the endpoint /v1/settings/groups/{id}/senders to get all the consents for the group informed in the API call.
To obtain the identifier of the desired group, it is possible to obtain it via the endpoint /v1/settings/groups.
In the API call response, several pieces of information are present concerning the sender:
-
Id: Sender identifier -
Channel: Channel of use for the sender (email, sms) -
Sender: Email address or OADC for sms channel -
Group_id: Group -
Campaign_type: Campaign type for which the sender is available. For email there are two distinct sender categories (Tactical/Automatic/Trigger API or Application).
For each sender corresponds a population, the following information about the population is available:
-
Id: Identifier of the population -
Name: Name of the population
In response to the API call is sent the list of different consents. It is possible to filter on a specific channel by indicating the desired channel in the API call.
The sender ID (id field in the endpoint response /v1/settings/groups/{id}/senders) will be requested in the campaign creation endpoint /v1/campaigns.
Conclusion
Senders can be retrieved programmatically via API at any time.
Further reading:
- Understanding campaign creation via API
- How to set up tactical, automatic and trigger api email senders
- How to set up applicative Email senders
- How to set up SMS senders