Sign in
directory

Returns contact groups

get/v1/directory/{directorySelector}/contact_groups

Path parameters

directorySelectorstring required

Query parameters

querystring

FIQL/RSQL query string

searchstring

Search string

sortstring

Sorts response by given fields

pageinteger

Request a specific page

sizeinteger

Sets size of a page

Response

OK

namestring required

group name

remarksstring

custom remarks

birthdayTemplateIdinteger

message template used for birthday messages

remoteSmsEnabledboolean

remote SMS enabled?

remoteSmsShortcutstring

remote SMS shortcut

remoteSmsTemplateIdinteger

message template used for remote SMS

welcomeSmsContentstring

welcome sms content

welcomeSmsActiveboolean

welcome sms active?

goodbyeSmsContentstring

goodbye sms content

goodbyeSmsActiveboolean

goodbye sms active?

welcomeWhatsappContentstring

welcome whatsapp content

welcomeWhatsappActiveboolean

welcome whatsapp active?

goodbyeWhatsappContentstring

goodbye whatsapp content

goodbyeWhatsappActiveboolean

goodbye whatsapp active?

mobileboolean

is sms/voice/push group?

whatsappboolean

is whatsapp group?

rcsboolean

is rcs group?

idinteger required

contact group id

sizeinteger

size of group

whatsappSizeinteger

amount of whatsapp recipients in group

mobileSizeinteger

amount of mobile (having msisdn set) recipients in group

mobileChannelEnabledSizeinteger

amount of recipients in group with enabled mobile channels

whatsappChannelEnabledSizeinteger

amount of recipients in group with enabled whatsapp channels

rcsChannelEnabledSizeinteger

amount of recipients in group with enabled rcs channels

allChannelsEnabledSizeinteger

amount of recipients in group with enabled mobile AND whatsapp channel

whatsappChannelAndWhatsappDeviceEnabledSizeinteger

amount of recipients in group with whatsapp AND enabled whatsapp channel AND whatsapp device

mobileAndMobileChannelEnabledSizeinteger

amount of recipients in group with enabled mobile channels and mobile

mobileAndRcsChannelEnabledSizeinteger

amount of recipients in group with enabled rcs channels and mobile (msisdn field)

mobileAndWhatsappChannelEnabledSizeinteger

amount of recipients in group with enabled rcs channels and mobile (msisdn field)

whatsappAndWhatsappChannelEnabledSizeinteger

amount of recipients in group with enabled whatsapp channels and whatsapp

allChannelsEnabledAndReachableSizeinteger

amount of recipients in group with enabled mobile AND whatsapp channel AND mobile AND whatsapp AND whatsapp device

allChannelsEnabledAndRecipientsSizeinteger

amount of recipients in group with all channels enabled and non empty recipients

emailAddressSizeinteger

amount of recipients in group containing emailAddress

lastTransferstring date-time

last transfer

lastModifiedstring date-time

last modified

lastModifiedBystring

last modified by

Changes

No recorded changes to this endpoint across all 1 revision of this API.