//[[restapi:start|RESTful API]]//

====== List Campaign Labels ======

==== Previous Versions ====
<wrap button>[[restapi:list_campaign_labels_3_34|Tag 34]]</wrap>

==== Overview ====

List labels for the given campaign

==== URL ====
Http Access Method: <wrap notice>GET</wrap>

Parameters on the following URL are inside braces { }
  {base_url}/rest/api/labels/{instanceId}/{mimId}/{userName}/{publicKey}/{signature}

^ Parameter Name ^ Description ^
| instanceId | An **instance id** is the workspace identification number, //if you don't know yours please request it using our [[misc:otto|ticketing tool]], you will need to provide your Mobile Engagement Campaign Manager's URL and your user login// |
| mimId | The campaign id, you could retrieve this information from the campaign manager UI or using the [[restapi:campaigns#list_campaigns|List Campaigns]] |
| userName | The user name that owns the campaign. This parameter must be [[restapi:appx_ciphering|Base64 encoded]] |
| publicKey | The public key to access this API. //if you don't know yours please request it using our [[misc:otto|ticketing tool]], you will need to provide your Mobile Engagement Campaign Manager's URL and your user login// |
| signature | The unique [[restapi:appx_ciphering#SHA256 - Cipher|SHA256]] signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our [[restapi:appx_call_ex|Java Example]] |

==== Response ====

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our [[restapi:appx_resp_xml|Response XML Basics]] section if you want to learn more about the response parts.

<code xml>

<input>getLabels</input>
<status>OK</status>
<description>Completed</description>
<result>
	<labels>
		<label>
			<index>0</index>
			<name>etiqueta1</name>
			<keyword>palabra1</keyword>
			<response>respuesta1</response>
		</label>
    
		...
    
		<label>
			<index>1</index>
			<name>etiqueta2</name>
			<keyword>palabra2</keyword>
			<response>respuesta2</response>
		</label>
	</labels> 
</result>

</code>

== Result parameters ==

^ Parameter Name ^ Description ^ Possible Values ^
| label.index | Label identification number | Number |
| label.name | Label name | Text |
| label.keyword | Keyword associated to the label | Text |
| label.response | Campaign response associated to the label | Text |